[ { "comment": "/**\r\n * Adds a Bloom effect to a Camera or GameObject or list thereof.\r\n *\r\n * Bloom is a phenomenon where bright light spreads across an image.\r\n * It can be used to add to the realism of a scene,\r\n * although too much is obvious and a subtle effect is best.\r\n *\r\n * This Action creates a Bloom effect by applying several Filters to the target.\r\n *\r\n * - `ParallelFilters` splits the filter stream, allowing us to combine\r\n * the results of other filters with the original image.\r\n * The other filters are added to the `top` stream.\r\n * - `Threshold` removes darker colors.\r\n * - `Blur` spreads the remaining bright colors out.\r\n *\r\n * This Action returns an object containing references to these filters.\r\n * You can control their properties directly,\r\n * e.g. if you want to animate the Bloom,\r\n * or if you want to set properties this Action doesn't surface.\r\n *\r\n * The Bloom effect will be destroyed like any other filter on target shutdown.\r\n * To disable or remove the Bloom effect manually, access the `parallelFilters`\r\n * controller in the return object. It holds the other filters.\r\n *\r\n * - `parallelFilters.active = false`: deactivate Bloom\r\n * - `parallelFilters.destroy()`: destroy Bloom\r\n *\r\n * Bloom is best as a full-screen effect. If you apply it to a GameObject with\r\n * alpha regions, it cannot blend the light glow properly with the background.\r\n * This is because the glow should use ADD blend, but the object itself should\r\n * use NORMAL blend, and it can't do both.\r\n * You can still apply bloom to a GameObject,\r\n * but it works best on a solid texture.\r\n *\r\n * @example\r\n * // Apply bloom to the scene camera.\r\n * Phaser.Actions.AddEffectBloom(this.cameras.main);\r\n *\r\n * @example\r\n * // Access the filters that make up a Bloom effect.\r\n * const { parallelFilters, threshold, blur } = Phaser.Actions.AddEffectBloom(this.cameras.main)[0]; // The return is an array.\r\n *\r\n * // Destroy the bloom effect.\r\n * parallelFilters.destroy();\r\n *\r\n * @example\r\n * // Emulate the Phaser 3 Bloom effect,\r\n * // including the way bloom strength darkens instead of mixes.\r\n * const { parallelFilters, threshold, blur } = Phaser.Actions.AddEffectBloom(\r\n * image,\r\n * {\r\n * blendAmount: 0.5,\r\n * blurQuality: 1,\r\n * }\r\n * );\r\n *\r\n * threshold.active = false;\r\n * parallelFilters.bottom.addBlend(undefined, Phaser.BlendModes.MULTIPLY, 1, [ 0. * 5, 0.5, 0.5, 0.5 ]);\r\n *\r\n * @function Phaser.Actions.AddEffectBloom\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera|Phaser.GameObjects.GameObject|Array.<(Phaser.Cameras.Scene2D.Camera|Phaser.GameObjects.GameObject)>} items - Recipients of the Bloom effect\r\n * @param {Phaser.Types.Actions.AddEffectBloomConfig} [config] - Initial configuration of the Bloom effect.\r\n *\r\n * @return {Phaser.Types.Actions.AddEffectBloomReturn[]} A list of objects containing the filters which were created.\r\n */", "meta": { "filename": "AddEffectBloom.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Adds a Bloom effect to a Camera or GameObject or list thereof.\r\rBloom is a phenomenon where bright light spreads across an image.\rIt can be used to add to the realism of a scene,\ralthough too much is obvious and a subtle effect is best.\r\rThis Action creates a Bloom effect by applying several Filters to the target.\r\r- `ParallelFilters` splits the filter stream, allowing us to combine\r the results of other filters with the original image.\r The other filters are added to the `top` stream.\r- `Threshold` removes darker colors.\r- `Blur` spreads the remaining bright colors out.\r\rThis Action returns an object containing references to these filters.\rYou can control their properties directly,\re.g. if you want to animate the Bloom,\ror if you want to set properties this Action doesn't surface.\r\rThe Bloom effect will be destroyed like any other filter on target shutdown.\rTo disable or remove the Bloom effect manually, access the `parallelFilters`\rcontroller in the return object. It holds the other filters.\r\r- `parallelFilters.active = false`: deactivate Bloom\r- `parallelFilters.destroy()`: destroy Bloom\r\rBloom is best as a full-screen effect. If you apply it to a GameObject with\ralpha regions, it cannot blend the light glow properly with the background.\rThis is because the glow should use ADD blend, but the object itself should\ruse NORMAL blend, and it can't do both.\rYou can still apply bloom to a GameObject,\rbut it works best on a solid texture.", "examples": [ "// Apply bloom to the scene camera.\rPhaser.Actions.AddEffectBloom(this.cameras.main);", "// Access the filters that make up a Bloom effect.\rconst { parallelFilters, threshold, blur } = Phaser.Actions.AddEffectBloom(this.cameras.main)[0]; // The return is an array.\r\r// Destroy the bloom effect.\rparallelFilters.destroy();", "// Emulate the Phaser 3 Bloom effect,\r// including the way bloom strength darkens instead of mixes.\rconst { parallelFilters, threshold, blur } = Phaser.Actions.AddEffectBloom(\r image,\r {\r blendAmount: 0.5,\r blurQuality: 1,\r }\r);\r\rthreshold.active = false;\rparallelFilters.bottom.addBlend(undefined, Phaser.BlendModes.MULTIPLY, 1, [ 0. * 5, 0.5, 0.5, 0.5 ]);" ], "kind": "function", "name": "AddEffectBloom", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera", "Phaser.GameObjects.GameObject", "Array.<(Phaser.Cameras.Scene2D.Camera|Phaser.GameObjects.GameObject)>" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } ] } ] } }, "description": "Recipients of the Bloom effect", "name": "items" }, { "type": { "names": [ "Phaser.Types.Actions.AddEffectBloomConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Actions.AddEffectBloomConfig" } }, "optional": true, "description": "Initial configuration of the Bloom effect.", "name": "config" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Actions.AddEffectBloomReturn", "type": "NameExpression" } ] } }, "description": "A list of objects containing the filters which were created." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.AddEffectBloom", "scope": "static", "___id": "T000002R000003", "___s": true }, { "comment": "/**\r\n * Adds a Shine effect to a Camera or GameObject or list thereof.\r\n *\r\n * Shine simulates a highlight glancing from a surface.\r\n * It's a brief specular reflection of a bright light,\r\n * typically from a fairly flat surface which only reflects the highlight\r\n * from certain angles.\r\n * In a game, you might use this to highlight an important object,\r\n * convey a sense of glossiness,\r\n * or move an interference band across a transmission.\r\n *\r\n * This Action works by creating several resources.\r\n *\r\n * - A Gradient object generates the region of the shine.\r\n * - A DynamicTexture holds the shine region.\r\n * - A Tween animates the shine region.\r\n * - A Blend filter combines the shine and the image.\r\n * - (Optional) A ParallelFilters filter adds the rest of the image back in.\r\n *\r\n * You may configure the effect in several ways using the `config` parameter.\r\n *\r\n * Use `radius`, `direction` and `scale` to set the gradient orientation.\r\n * Scale defaults to 2, twice the size of the target,\r\n * to guarantee that the highlight leaves the image completely before repeating.\r\n * The radius also adds an extra offset on either side of the image\r\n * so the gradient has space to enter and exit the image.\r\n *\r\n * Use `colorFactor` to control the RGBA color of the highlight.\r\n * You can overdrive this to values greater than 1 to create very bright shine.\r\n * By default, it has a slight red tint to create warm highlights.\r\n *\r\n * Use `displacementMap` and `displacement` to add a Displacement filter\r\n * to the Gradient. This creates the impression of a slightly scuffed surface.\r\n * You may add other filters to the Gradient; they will be rendered into the\r\n * DynamicTexture for use in the final blend.\r\n *\r\n * Use `reveal` to put the effect into reveal mode.\r\n * In this mode, the image is only visible under the shine.\r\n *\r\n * Use `duration`, `yoyo` and `ease` to control the Tween animation.\r\n *\r\n * The resources created in this way will be automatically destroyed\r\n * when the target is destroyed. You may remove them earlier yourself.\r\n * Unless you use them in other systems, they are isolated and safe to destroy.\r\n * (The Tween requires the other resources to exist while it exists.)\r\n *\r\n * When you target multiple objects with this method,\r\n * each creates its own set of resources. Each set is independent,\r\n * and may be destroyed or manipulated without affecting the others.\r\n *\r\n * You can create your own Shine effects using this as a base or as inspiration.\r\n *\r\n * @example\r\n * // Slowly move a cyan highlight up and down an image.\r\n * // Use a displacement map to dirty up the highlight.\r\n * const { dynamicTexture, gradient, tween } = Phaser.Actions.AddEffectShine(this.image, {\r\n * duration: 5000,\r\n * direction: Math.PI / 2,\r\n * scale: 1,\r\n * displacementMap: 'displace',\r\n * colorFactor: [ 0.5,2,2,1 ],\r\n * yoyo: true,\r\n * ease: 'Quad.inout'\r\n * })[0]; // The return is an array.\r\n *\r\n * @function Phaser.Actions.AddEffectShine\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera|Phaser.GameObjects.GameObject|Array.<(Phaser.Cameras.Scene2D.Camera|Phaser.GameObjects.GameObject)>} items - Recipients of the Shine effect\r\n * @param {Phaser.Types.Actions.AddEffectShineConfig} [config] - Initial configuration of the Shine effect.\r\n *\r\n * @return {Phaser.Types.Actions.AddEffectShineReturn[]} A list of objects containing the resources which were created.\r\n */", "meta": { "filename": "AddEffectShine.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Adds a Shine effect to a Camera or GameObject or list thereof.\r\rShine simulates a highlight glancing from a surface.\rIt's a brief specular reflection of a bright light,\rtypically from a fairly flat surface which only reflects the highlight\rfrom certain angles.\rIn a game, you might use this to highlight an important object,\rconvey a sense of glossiness,\ror move an interference band across a transmission.\r\rThis Action works by creating several resources.\r\r- A Gradient object generates the region of the shine.\r- A DynamicTexture holds the shine region.\r- A Tween animates the shine region.\r- A Blend filter combines the shine and the image.\r- (Optional) A ParallelFilters filter adds the rest of the image back in.\r\rYou may configure the effect in several ways using the `config` parameter.\r\rUse `radius`, `direction` and `scale` to set the gradient orientation.\rScale defaults to 2, twice the size of the target,\rto guarantee that the highlight leaves the image completely before repeating.\rThe radius also adds an extra offset on either side of the image\rso the gradient has space to enter and exit the image.\r\rUse `colorFactor` to control the RGBA color of the highlight.\rYou can overdrive this to values greater than 1 to create very bright shine.\rBy default, it has a slight red tint to create warm highlights.\r\rUse `displacementMap` and `displacement` to add a Displacement filter\rto the Gradient. This creates the impression of a slightly scuffed surface.\rYou may add other filters to the Gradient; they will be rendered into the\rDynamicTexture for use in the final blend.\r\rUse `reveal` to put the effect into reveal mode.\rIn this mode, the image is only visible under the shine.\r\rUse `duration`, `yoyo` and `ease` to control the Tween animation.\r\rThe resources created in this way will be automatically destroyed\rwhen the target is destroyed. You may remove them earlier yourself.\rUnless you use them in other systems, they are isolated and safe to destroy.\r(The Tween requires the other resources to exist while it exists.)\r\rWhen you target multiple objects with this method,\reach creates its own set of resources. Each set is independent,\rand may be destroyed or manipulated without affecting the others.\r\rYou can create your own Shine effects using this as a base or as inspiration.", "examples": [ "// Slowly move a cyan highlight up and down an image.\r// Use a displacement map to dirty up the highlight.\rconst { dynamicTexture, gradient, tween } = Phaser.Actions.AddEffectShine(this.image, {\r duration: 5000,\r direction: Math.PI / 2,\r scale: 1,\r displacementMap: 'displace',\r colorFactor: [ 0.5,2,2,1 ],\r yoyo: true,\r ease: 'Quad.inout'\r})[0]; // The return is an array." ], "kind": "function", "name": "AddEffectShine", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera", "Phaser.GameObjects.GameObject", "Array.<(Phaser.Cameras.Scene2D.Camera|Phaser.GameObjects.GameObject)>" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } ] } ] } }, "description": "Recipients of the Shine effect", "name": "items" }, { "type": { "names": [ "Phaser.Types.Actions.AddEffectShineConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Actions.AddEffectShineConfig" } }, "optional": true, "description": "Initial configuration of the Shine effect.", "name": "config" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Actions.AddEffectShineReturn", "type": "NameExpression" } ] } }, "description": "A list of objects containing the resources which were created." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.AddEffectShine", "scope": "static", "___id": "T000002R000032", "___s": true }, { "comment": "/**\r\n * Apply a Mask to a GameObject or Camera or list thereof using a Shape.\r\n *\r\n * This is a quick way to add a mask to an object/camera.\r\n * It creates a Shape and uses FitToRegion to size it correctly.\r\n *\r\n * By default, the Mask is a circle, scaled to fit both X and Y axes\r\n * of the game canvas (so it's not really a circle any more).\r\n *\r\n * You can change the shape to 'square', 'rectangle', or 'ellipse'.\r\n * Control the shape of rectangles or ellipses via `config.aspectRatio`.\r\n *\r\n * You can change the coverage much like FitToRegion.\r\n * You can scale to fit inside, outside, or both axes.\r\n * You can set the target region; if you do not, the action will choose\r\n * an appropriate region for you.\r\n *\r\n * The action supports an optional Blur effect, applied to the shape.\r\n * This is good for soft edges on masks.\r\n * You can use `config.padding` to shrink the shape region inward, leaving room for the blur to spread outward to the intended boundary.\r\n *\r\n * The Shape is removed from the scene upon creation.\r\n * You don't need to manage its life cycle; it should be garbage collected\r\n * once the Mask filter is destroyed, usually when the scene or target\r\n * is shut down.\r\n * If you want to access the Shape, it is available on the mask filter.\r\n *\r\n * If you apply this to multiple objects at once,\r\n * they all have their own shape and mask filter.\r\n * Note that, if you use external filters, the masks will seem to line up.\r\n * In this case, it might be more efficient to put all the targets into\r\n * a Layer or Container and mask that instead.\r\n *\r\n * @example\r\n * const mask = Phaser.Actions.AddMaskShape(target, {\r\n * blurRadius: 2,\r\n * padding: 2\r\n * })[0]; // The return is an array.\r\n * const shape = mask.maskGameObject; // This reference prevents garbage collection until `shape` is dropped.\r\n * const blur = shape.filters.external.list[0]; // Nothing else should be in this list.\r\n *\r\n * @function Phaser.Actions.AddMaskShape\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject | Phaser.Cameras.Scene2D.Camera | Array.<(Phaser.GameObjects.GameObject | Phaser.Cameras.Scene2D.Camera)>} items - The GameObject or Camera or list thereof to which to apply a mask.\r\n * @param {Phaser.Types.Actions.AddMaskShapeConfig} config - The configuration of the mask shape.\r\n *\r\n * @return {Phaser.Filters.Mask[]} The new Mask filters, in order of target.\r\n */", "meta": { "filename": "AddMaskShape.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Apply a Mask to a GameObject or Camera or list thereof using a Shape.\r\rThis is a quick way to add a mask to an object/camera.\rIt creates a Shape and uses FitToRegion to size it correctly.\r\rBy default, the Mask is a circle, scaled to fit both X and Y axes\rof the game canvas (so it's not really a circle any more).\r\rYou can change the shape to 'square', 'rectangle', or 'ellipse'.\rControl the shape of rectangles or ellipses via `config.aspectRatio`.\r\rYou can change the coverage much like FitToRegion.\rYou can scale to fit inside, outside, or both axes.\rYou can set the target region; if you do not, the action will choose\ran appropriate region for you.\r\rThe action supports an optional Blur effect, applied to the shape.\rThis is good for soft edges on masks.\rYou can use `config.padding` to shrink the shape region inward, leaving room for the blur to spread outward to the intended boundary.\r\rThe Shape is removed from the scene upon creation.\rYou don't need to manage its life cycle; it should be garbage collected\ronce the Mask filter is destroyed, usually when the scene or target\ris shut down.\rIf you want to access the Shape, it is available on the mask filter.\r\rIf you apply this to multiple objects at once,\rthey all have their own shape and mask filter.\rNote that, if you use external filters, the masks will seem to line up.\rIn this case, it might be more efficient to put all the targets into\ra Layer or Container and mask that instead.", "examples": [ "const mask = Phaser.Actions.AddMaskShape(target, {\r blurRadius: 2,\r padding: 2\r})[0]; // The return is an array.\rconst shape = mask.maskGameObject; // This reference prevents garbage collection until `shape` is dropped.\rconst blur = shape.filters.external.list[0]; // Nothing else should be in this list." ], "kind": "function", "name": "AddMaskShape", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Cameras.Scene2D.Camera", "Array.<(Phaser.GameObjects.GameObject|Phaser.Cameras.Scene2D.Camera)>" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } ] } ] } ] } }, "description": "The GameObject or Camera or list thereof to which to apply a mask.", "name": "items" }, { "type": { "names": [ "Phaser.Types.Actions.AddMaskShapeConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Actions.AddMaskShapeConfig" } }, "description": "The configuration of the mask shape.", "name": "config" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Filters.Mask", "type": "NameExpression" } ] } }, "description": "The new Mask filters, in order of target." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.AddMaskShape", "scope": "static", "___id": "T000002R000106", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and aligns them next to each other.\r\n *\r\n * The alignment position is controlled by the `position` parameter, which should be one\r\n * of the Phaser.Display.Align constants, such as `Phaser.Display.Align.TOP_LEFT`,\r\n * `Phaser.Display.Align.TOP_CENTER`, etc.\r\n *\r\n * The first item isn't moved. The second item is aligned next to the first,\r\n * then the third next to the second, and so on.\r\n *\r\n * @function Phaser.Actions.AlignTo\r\n * @since 3.22.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} position - The position to align the items with. This is an align constant, such as `Phaser.Display.Align.LEFT_CENTER`.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position, in pixels.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position, in pixels.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "AlignTo.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects and aligns them next to each other.\r\rThe alignment position is controlled by the `position` parameter, which should be one\rof the Phaser.Display.Align constants, such as `Phaser.Display.Align.TOP_LEFT`,\r`Phaser.Display.Align.TOP_CENTER`, etc.\r\rThe first item isn't moved. The second item is aligned next to the first,\rthen the third next to the second, and so on.", "kind": "function", "name": "AlignTo", "since": "3.22.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position, in pixels.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position, in pixels.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.AlignTo", "scope": "static", "___id": "T000002R000129", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have a public `angle` property,\r\n * and then adds the given value to each of their `angle` properties.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `Angle(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.Angle\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The amount, in degrees, to be added to the `angle` property.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter. For example, a `step` of 10 will add 0 to the first item, 10 to the second, 20 to the third, and so on.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "Angle.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have a public `angle` property,\rand then adds the given value to each of their `angle` properties.\r\rThe optional `step` property is applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `Angle(group.getChildren(), value, step)`", "kind": "function", "name": "Angle", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount, in degrees, to be added to the `angle` property.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter. For example, a `step` of 10 will add 0 to the first item, 10 to the second, 20 to the third, and so on.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.Angle", "scope": "static", "___id": "T000002R000137", "___s": true }, { "comment": "/**\r\n * Takes an array of objects and passes each of them to the given callback.\r\n *\r\n * @function Phaser.Actions.Call\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {Phaser.Types.Actions.CallCallback} callback - The callback to be invoked. It will be passed just one argument: the item from the array.\r\n * @param {*} context - The scope in which the callback will be invoked.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that was passed to this Action.\r\n */", "meta": { "filename": "Call.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of objects and passes each of them to the given callback.", "kind": "function", "name": "Call", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "Phaser.Types.Actions.CallCallback" ], "parsedType": { "type": "NameExpression", "name": "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": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The scope in which the callback will be invoked.", "name": "context" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.Call", "scope": "static", "___id": "T000002R000140", "___s": true }, { "comment": "/**\r\n * Fit GameObjects to a region.\r\n *\r\n * This is a quick way to fit a background to a scene,\r\n * move an object without worrying about origins,\r\n * or cover a hole of known size.\r\n *\r\n * This will transform each object to fit into a rectangular region.\r\n * Rotation is ignored, but translation and scale are changed.\r\n * Note that negative scale will become positive; use flip to resolve this.\r\n * The object must support transformation.\r\n *\r\n * The fit can scale proportionally, to touch the inside or outside of the region;\r\n * but by default it scales both axes independently to touch all sides.\r\n *\r\n * The region is an axis-aligned bounding box (AABB).\r\n * By default, it is derived from the object, via the scene scale properties,\r\n * i.e. `{ x: 0, y: 0, width: scene.scale.width, height: scene.scale.height }`.\r\n *\r\n * If the game object has no size or origin, e.g. a Container,\r\n * then it is tricky to figure out how to resize it to fit.\r\n * The `itemCoverage` parameter allows you to set `width`, `height`, `originX`\r\n * and/or `originY` properties to supplement available data.\r\n * These settings take precedence over original item properties, even if they exist.\r\n *\r\n * @function Phaser.Actions.FitToRegion\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} items - The GameObject or GameObjects to fit to the region. Each must have the Phaser.GameObjects.Components.Transform component.\r\n * @param {number} [scaleMode=0] - The scale mode. 0 sets each axis to fill the region independently. -1 scales both axes uniformly so the item touches the _inside_ of the region. 1 scales both axes uniformly so the item touches the _outside_ of the region.\r\n * @param {Phaser.Types.Math.RectangleLike} [region] - The region to fit. If not defined, it will be inferred from the first item's scene scale.\r\n * @param {Phaser.Types.Actions.FitToRegionItemCoverage} [itemCoverage] - Override or define the region covered by the item. This is intended to provide dimensions for objects which don't have them, such as Containers, allowing them to resize.\r\n *\r\n * @return {Phaser.GameObjects.GameObject[]} - The items that were fitted.\r\n */", "meta": { "filename": "FitToRegion.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Fit GameObjects to a region.\r\rThis is a quick way to fit a background to a scene,\rmove an object without worrying about origins,\ror cover a hole of known size.\r\rThis will transform each object to fit into a rectangular region.\rRotation is ignored, but translation and scale are changed.\rNote that negative scale will become positive; use flip to resolve this.\rThe object must support transformation.\r\rThe fit can scale proportionally, to touch the inside or outside of the region;\rbut by default it scales both axes independently to touch all sides.\r\rThe region is an axis-aligned bounding box (AABB).\rBy default, it is derived from the object, via the scene scale properties,\ri.e. `{ x: 0, y: 0, width: scene.scale.width, height: scene.scale.height }`.\r\rIf the game object has no size or origin, e.g. a Container,\rthen it is tricky to figure out how to resize it to fit.\rThe `itemCoverage` parameter allows you to set `width`, `height`, `originX`\rand/or `originY` properties to supplement available data.\rThese settings take precedence over original item properties, even if they exist.", "kind": "function", "name": "FitToRegion", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The GameObject or GameObjects to fit to the region. Each must have the Phaser.GameObjects.Components.Transform component.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The scale mode. 0 sets each axis to fill the region independently. -1 scales both axes uniformly so the item touches the _inside_ of the region. 1 scales both axes uniformly so the item touches the _outside_ of the region.", "name": "scaleMode" }, { "type": { "names": [ "Phaser.Types.Math.RectangleLike" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.RectangleLike" } }, "optional": true, "description": "The region to fit. If not defined, it will be inferred from the first item's scene scale.", "name": "region" }, { "type": { "names": [ "Phaser.Types.Actions.FitToRegionItemCoverage" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Actions.FitToRegionItemCoverage" } }, "optional": true, "description": "Override or define the region covered by the item. This is intended to provide dimensions for objects which don't have them, such as Containers, allowing them to resize.", "name": "itemCoverage" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "- The items that were fitted." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.FitToRegion", "scope": "static", "___id": "T000002R000147", "___s": true }, { "comment": "/**\r\n * Takes an array of objects and returns the first element in the array that has properties which match\r\n * all of those specified in the `compare` object. For example, if the compare object was: `{ scaleX: 0.5, alpha: 1 }`\r\n * then it would return the first item which had the property `scaleX` set to 0.5 and `alpha` set to 1.\r\n *\r\n * To use this with a Group: `GetFirst(group.getChildren(), compare, index)`\r\n *\r\n * @function Phaser.Actions.GetFirst\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be searched by this action.\r\n * @param {object} compare - The comparison object. Each property in this object will be checked against the items of the array.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n *\r\n * @return {?(object|Phaser.GameObjects.GameObject)} The first object in the array that matches the comparison object, or `null` if no match was found.\r\n */", "meta": { "filename": "GetFirst.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of objects and returns the first element in the array that has properties which match\rall of those specified in the `compare` object. For example, if the compare object was: `{ scaleX: 0.5, alpha: 1 }`\rthen it would return the first item which had the property `scaleX` set to 0.5 and `alpha` set to 1.\r\rTo use this with a Group: `GetFirst(group.getChildren(), compare, index)`", "kind": "function", "name": "GetFirst", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items]", "value": "{Phaser.GameObjects.GameObject[]} G - [items]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be searched by this action.", "name": "items" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The comparison object. Each property in this object will be checked against the items of the array.", "name": "compare" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ], "nullable": true } }, "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", "___id": "T000002R000165", "___s": true }, { "comment": "/**\r\n * Takes an array of objects and returns the last element in the array that has properties which match\r\n * all of those specified in the `compare` object. For example, if the compare object was: `{ scaleX: 0.5, alpha: 1 }`\r\n * then it would return the last item which had the property `scaleX` set to 0.5 and `alpha` set to 1.\r\n *\r\n * To use this with a Group: `GetLast(group.getChildren(), compare, index)`\r\n *\r\n * @function Phaser.Actions.GetLast\r\n * @since 3.3.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be searched by this action.\r\n * @param {object} compare - The comparison object. Each property in this object will be checked against the items of the array.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n *\r\n * @return {?(object|Phaser.GameObjects.GameObject)} The last object in the array that matches the comparison object, or `null` if no match was found.\r\n */", "meta": { "filename": "GetLast.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of objects and returns the last element in the array that has properties which match\rall of those specified in the `compare` object. For example, if the compare object was: `{ scaleX: 0.5, alpha: 1 }`\rthen it would return the last item which had the property `scaleX` set to 0.5 and `alpha` set to 1.\r\rTo use this with a Group: `GetLast(group.getChildren(), compare, index)`", "kind": "function", "name": "GetLast", "since": "3.3.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items]", "value": "{Phaser.GameObjects.GameObject[]} G - [items]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be searched by this action.", "name": "items" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The comparison object. Each property in this object will be checked against the items of the array.", "name": "compare" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ], "nullable": true } }, "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", "___id": "T000002R000174", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have public `x` and `y` properties,\r\n * and positions them in a grid layout based on the configuration provided.\r\n *\r\n * The grid is defined by a `width` (number of columns) and/or `height` (number of rows).\r\n * Each cell in the grid has a size defined by `cellWidth` and `cellHeight`, in pixels.\r\n * Items are placed into cells starting from the top-left origin (`x`, `y`) and filling\r\n * left-to-right, top-to-bottom by default. If only `width` is set to -1, items are laid\r\n * out in a single horizontal row. If only `height` is set to -1, items are laid out in a\r\n * single vertical column. When both `width` and `height` are set, the grid fills\r\n * row-by-row, stopping early if the grid is full before all items have been placed.\r\n *\r\n * The `position` option controls how each item is aligned within its cell, using one of\r\n * the `Phaser.Display.Align` constants such as `CENTER` or `TOP_LEFT`.\r\n *\r\n * @function Phaser.Actions.GridAlign\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {Phaser.Types.Actions.GridAlignConfig} options - The GridAlign Configuration object.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "GridAlign.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have public `x` and `y` properties,\rand positions them in a grid layout based on the configuration provided.\r\rThe grid is defined by a `width` (number of columns) and/or `height` (number of rows).\rEach cell in the grid has a size defined by `cellWidth` and `cellHeight`, in pixels.\rItems are placed into cells starting from the top-left origin (`x`, `y`) and filling\rleft-to-right, top-to-bottom by default. If only `width` is set to -1, items are laid\rout in a single horizontal row. If only `height` is set to -1, items are laid out in a\rsingle vertical column. When both `width` and `height` are set, the grid fills\rrow-by-row, stopping early if the grid is full before all items have been placed.\r\rThe `position` option controls how each item is aligned within its cell, using one of\rthe `Phaser.Display.Align` constants such as `CENTER` or `TOP_LEFT`.", "kind": "function", "name": "GridAlign", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "Phaser.Types.Actions.GridAlignConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Actions.GridAlignConfig" } }, "description": "The GridAlign Configuration object.", "name": "options" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.GridAlign", "scope": "static", "___id": "T000002R000193", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have a public `alpha` property,\r\n * and then adds the given value to each of their `alpha` properties.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `IncAlpha(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.IncAlpha\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The amount to be added to the `alpha` property.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "IncAlpha.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have a public `alpha` property,\rand then adds the given value to each of their `alpha` properties.\r\rThe optional `step` property is applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `IncAlpha(group.getChildren(), value, step)`", "kind": "function", "name": "IncAlpha", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to be added to the `alpha` property.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.IncAlpha", "scope": "static", "___id": "T000002R000226", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have a public `x` property,\r\n * and then adds the given value to each of their `x` properties.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `IncX(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.IncX\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The amount to be added to the `x` property.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "IncX.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have a public `x` property,\rand then adds the given value to each of their `x` properties.\r\rThe optional `step` property is applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `IncX(group.getChildren(), value, step)`", "kind": "function", "name": "IncX", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to be added to the `x` property.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.IncX", "scope": "static", "___id": "T000002R000230", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have public `x` and `y` properties,\r\n * and then adds the given value to each of them.\r\n *\r\n * The optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `IncXY(group.getChildren(), x, y, stepX, stepY)`\r\n *\r\n * @function Phaser.Actions.IncXY\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} x - The amount to be added to the `x` property.\r\n * @param {number} [y=x] - The amount to be added to the `y` property. If `undefined` or `null` it uses the `x` value.\r\n * @param {number} [stepX=0] - This is added to the `x` amount, multiplied by the iteration counter.\r\n * @param {number} [stepY=0] - This is added to the `y` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "IncXY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have public `x` and `y` properties,\rand then adds the given value to each of them.\r\rThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `IncXY(group.getChildren(), x, y, stepX, stepY)`", "kind": "function", "name": "IncXY", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to be added to the `x` property.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `x` amount, multiplied by the iteration counter.", "name": "stepX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `y` amount, multiplied by the iteration counter.", "name": "stepY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.IncXY", "scope": "static", "___id": "T000002R000234", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have a public `y` property,\r\n * and then adds the given value to each of their `y` properties.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `IncY(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.IncY\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The amount to be added to the `y` property.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "IncY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have a public `y` property,\rand then adds the given value to each of their `y` properties.\r\rThe optional `step` property is applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `IncY(group.getChildren(), value, step)`", "kind": "function", "name": "IncY", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to be added to the `y` property.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.IncY", "scope": "static", "___id": "T000002R000239", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Actions\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "kind": "namespace", "name": "Actions", "memberof": "Phaser", "longname": "Phaser.Actions", "scope": "static", "___id": "T000002R000242", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and positions them on evenly spaced points around the perimeter of a Circle.\r\n *\r\n * If you wish to pass a `Phaser.GameObjects.Circle` Shape to this function, you should pass its `geom` property.\r\n *\r\n * @function Phaser.Actions.PlaceOnCircle\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {Phaser.Geom.Circle} circle - The Circle to position the Game Objects on.\r\n * @param {number} [startAngle=0] - Optional angle to start position from, in radians.\r\n * @param {number} [endAngle=6.28] - Optional angle to stop position at, in radians.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "PlaceOnCircle.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects and positions them on evenly spaced points around the perimeter of a Circle.\r\rIf 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to position the Game Objects on.", "name": "circle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional angle to start position from, in radians.", "name": "startAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 6.28, "description": "Optional angle to stop position at, in radians.", "name": "endAngle" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.PlaceOnCircle", "scope": "static", "___id": "T000002R000301", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and positions them on evenly spaced points around the perimeter of an Ellipse.\r\n *\r\n * Each Game Object's `x` and `y` properties are updated in place. The spacing between objects is determined\r\n * by dividing the angular range (from `startAngle` to `endAngle`) evenly across the number of items.\r\n *\r\n * If you wish to pass a `Phaser.GameObjects.Ellipse` Shape to this function, you should pass its `geom` property.\r\n *\r\n * @function Phaser.Actions.PlaceOnEllipse\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to position the Game Objects on.\r\n * @param {number} [startAngle=0] - Optional angle to start position from, in radians.\r\n * @param {number} [endAngle=6.28] - Optional angle to stop position at, in radians.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "PlaceOnEllipse.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects and positions them on evenly spaced points around the perimeter of an Ellipse.\r\rEach Game Object's `x` and `y` properties are updated in place. The spacing between objects is determined\rby dividing the angular range (from `startAngle` to `endAngle`) evenly across the number of items.\r\rIf 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to position the Game Objects on.", "name": "ellipse" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional angle to start position from, in radians.", "name": "startAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 6.28, "description": "Optional angle to stop position at, in radians.", "name": "endAngle" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.PlaceOnEllipse", "scope": "static", "___id": "T000002R000315", "___s": true }, { "comment": "/**\r\n * Positions an array of Game Objects along a Line, setting each object's `x` and `y` coordinates.\r\n * By default the Game Objects are placed at evenly spaced intervals along the line. If the `ease`\r\n * parameter is supplied, the spacing between points is controlled by that easing function instead,\r\n * allowing for clustered or accelerating distributions along the line.\r\n *\r\n * @function Phaser.Actions.PlaceOnLine\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {Phaser.Geom.Line} line - The Line to position the Game Objects on.\r\n * @param {(string|function)} [ease] - An optional ease to apply to the point distribution. This can be either a string key from the EaseMap (e.g. `'Sine.easeInOut'`) or a custom easing function. If omitted, points are evenly spaced.\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "PlaceOnLine.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Positions an array of Game Objects along a Line, setting each object's `x` and `y` coordinates.\rBy default the Game Objects are placed at evenly spaced intervals along the line. If the `ease`\rparameter is supplied, the spacing between points is controlled by that easing function instead,\rallowing for clustered or accelerating distributions along the line.", "kind": "function", "name": "PlaceOnLine", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The Line to position the Game Objects on.", "name": "line" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "description": "An optional ease to apply to the point distribution. This can be either a string key from the EaseMap (e.g. `'Sine.easeInOut'`) or a custom easing function. If omitted, points are evenly spaced.", "name": "ease" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.PlaceOnLine", "scope": "static", "___id": "T000002R000330", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and positions them on evenly spaced points around the perimeter of a Rectangle.\r\n * \r\n * Placement starts from the top-left of the rectangle, and proceeds in a clockwise direction.\r\n * If the `shift` parameter is given you can offset where placement begins.\r\n *\r\n * @function Phaser.Actions.PlaceOnRectangle\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to position the Game Objects on.\r\n * @param {number} [shift=0] - An optional starting offset, in number of steps. A positive value shifts the starting position clockwise around the perimeter, a negative value shifts it counter-clockwise.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "PlaceOnRectangle.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects and positions them on evenly spaced points around the perimeter of a Rectangle.\r\rPlacement starts from the top-left of the rectangle, and proceeds in a clockwise direction.\rIf the `shift` parameter is given you can offset where placement begins.", "kind": "function", "name": "PlaceOnRectangle", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to position the Game Objects on.", "name": "rect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional starting offset, in number of steps. A positive value shifts the starting position clockwise around the perimeter, a negative value shifts it counter-clockwise.", "name": "shift" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.PlaceOnRectangle", "scope": "static", "___id": "T000002R000344", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and positions them on evenly spaced points around the edges of a Triangle.\r\n * \r\n * If you wish to pass a `Phaser.GameObjects.Triangle` Shape to this function, you should pass its `geom` property.\r\n *\r\n * @function Phaser.Actions.PlaceOnTriangle\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to position the Game Objects on.\r\n * @param {number} [stepRate=1] - An optional step rate that controls the density of points sampled along each edge of the Triangle using Bresenham's line algorithm. A higher value produces fewer, more widely spaced points; a lower value produces more points and denser placement.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "PlaceOnTriangle.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects and positions them on evenly spaced points around the edges of a Triangle.\r\rIf 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to position the Game Objects on.", "name": "triangle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "An optional step rate that controls the density of points sampled along each edge of the Triangle using Bresenham's line algorithm. A higher value produces fewer, more widely spaced points; a lower value produces more points and denser placement.", "name": "stepRate" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.PlaceOnTriangle", "scope": "static", "___id": "T000002R000353", "___s": true }, { "comment": "/**\r\n * Play an animation on all Game Objects in the array that have an Animation component.\r\n *\r\n * You can pass either an animation key, or an animation configuration object for more control over the playback.\r\n *\r\n * @function Phaser.Actions.PlayAnimation\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig)} key - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.\r\n * @param {boolean} [ignoreIfPlaying=false] - If this animation is already playing then ignore this call.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "PlayAnimation.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Play an animation on all Game Objects in the array that have an Animation component.\r\rYou can pass either an animation key, or an animation configuration object for more control over the playback.", "kind": "function", "name": "PlayAnimation", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "string", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ] } }, "description": "The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If this animation is already playing then ignore this call.", "name": "ignoreIfPlaying" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.PlayAnimation", "scope": "static", "___id": "T000002R000380", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have a public property as defined in `key`,\r\n * and then adds the given value to it.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `PropertyValueInc(group.getChildren(), key, value, step)`\r\n *\r\n * @function Phaser.Actions.PropertyValueInc\r\n * @since 3.3.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {string} key - The property to be updated.\r\n * @param {number} value - The amount to be added to the property.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "PropertyValueInc.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have a public property as defined in `key`,\rand then adds the given value to it.\r\rThe optional `step` property is applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `PropertyValueInc(group.getChildren(), key, value, step)`", "kind": "function", "name": "PropertyValueInc", "since": "3.3.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to be updated.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to be added to the property.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.PropertyValueInc", "scope": "static", "___id": "T000002R000385", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have a public property as defined in `key`,\r\n * and then sets it to the given value.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `PropertyValueSet(group.getChildren(), key, value, step)`\r\n *\r\n * @function Phaser.Actions.PropertyValueSet\r\n * @since 3.3.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {string} key - The property to be updated.\r\n * @param {number} value - The amount to set the property to.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "PropertyValueSet.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have a public property as defined in `key`,\rand then sets it to the given value.\r\rThe optional `step` property is applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `PropertyValueSet(group.getChildren(), key, value, step)`", "kind": "function", "name": "PropertyValueSet", "since": "3.3.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to be updated.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.PropertyValueSet", "scope": "static", "___id": "T000002R000398", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and positions them at random locations within the Circle.\r\n * \r\n * If you wish to pass a `Phaser.GameObjects.Circle` Shape to this function, you should pass its `geom` property.\r\n *\r\n * @function Phaser.Actions.RandomCircle\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {Phaser.Geom.Circle} circle - The Circle to position the Game Objects within.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "RandomCircle.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects and positions them at random locations within the Circle.\r\rIf 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to position the Game Objects within.", "name": "circle" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.RandomCircle", "scope": "static", "___id": "T000002R000412", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and positions them at random locations within the Ellipse.\r\n * \r\n * If you wish to pass a `Phaser.GameObjects.Ellipse` Shape to this function, you should pass its `geom` property.\r\n *\r\n * @function Phaser.Actions.RandomEllipse\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to position the Game Objects within.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "RandomEllipse.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects and positions them at random locations within the Ellipse.\r\rIf 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to position the Game Objects within.", "name": "ellipse" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.RandomEllipse", "scope": "static", "___id": "T000002R000417", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and positions them at random locations on the Line.\r\n * \r\n * If you wish to pass a `Phaser.GameObjects.Line` Shape to this function, you should pass its `geom` property.\r\n *\r\n * @function Phaser.Actions.RandomLine\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {Phaser.Geom.Line} line - The Line to position the Game Objects randomly on.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "RandomLine.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects and positions them at random locations on the Line.\r\rIf 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The Line to position the Game Objects randomly on.", "name": "line" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.RandomLine", "scope": "static", "___id": "T000002R000422", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and positions them at random locations within the Rectangle.\r\n *\r\n * @function Phaser.Actions.RandomRectangle\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to position the Game Objects within.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "RandomRectangle.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects and positions them at random locations within the Rectangle.", "kind": "function", "name": "RandomRectangle", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to position the Game Objects within.", "name": "rect" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.RandomRectangle", "scope": "static", "___id": "T000002R000427", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and positions them at random locations within the Triangle.\r\n * \r\n * If you wish to pass a `Phaser.GameObjects.Triangle` Shape to this function, you should pass its `geom` property.\r\n *\r\n * @function Phaser.Actions.RandomTriangle\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to position the Game Objects within.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "RandomTriangle.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects and positions them at random locations within the Triangle.\r\rIf 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to position the Game Objects within.", "name": "triangle" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.RandomTriangle", "scope": "static", "___id": "T000002R000432", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have a public `rotation` property,\r\n * and then adds the given value to each of their `rotation` properties.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `Rotate(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.Rotate\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The amount to be added to the `rotation` property (in radians).\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "Rotate.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have a public `rotation` property,\rand then adds the given value to each of their `rotation` properties.\r\rThe optional `step` property is applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `Rotate(group.getChildren(), value, step)`", "kind": "function", "name": "Rotate", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to be added to the `rotation` property (in radians).", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.Rotate", "scope": "static", "___id": "T000002R000437", "___s": true }, { "comment": "/**\r\n * Rotates each item around the given point by the given angle.\r\n *\r\n * @function Phaser.Actions.RotateAround\r\n * @since 3.0.0\r\n * @see Phaser.Math.RotateAroundDistance\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {object} point - Any object with public `x` and `y` properties.\r\n * @param {number} angle - The angle to rotate by, in radians.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "RotateAround.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Rotates each item around the given point by the given angle.", "kind": "function", "name": "RotateAround", "since": "3.0.0", "see": [ "Phaser.Math.RotateAroundDistance" ], "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "Any object with public `x` and `y` properties.", "name": "point" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle to rotate by, in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.RotateAround", "scope": "static", "___id": "T000002R000442", "___s": true }, { "comment": "/**\r\n * Rotates each Game Object in the given array around a point by the specified angle, positioning each item at the given distance from that point. If the distance is zero, the items are not moved.\r\n *\r\n * @function Phaser.Actions.RotateAroundDistance\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {object} point - Any object with public `x` and `y` properties.\r\n * @param {number} angle - The angle to rotate by, in radians.\r\n * @param {number} distance - The distance from the point of rotation in pixels.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "RotateAroundDistance.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Rotates each Game Object in the given array around a point by the specified angle, positioning each item at the given distance from that point. If the distance is zero, the items are not moved.", "kind": "function", "name": "RotateAroundDistance", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "Any object with public `x` and `y` properties.", "name": "point" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle to rotate by, in radians.", "name": "angle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance from the point of rotation in pixels.", "name": "distance" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.RotateAroundDistance", "scope": "static", "___id": "T000002R000450", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have a public `scaleX` property,\r\n * and then adds the given value to each of their `scaleX` properties.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `ScaleX(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.ScaleX\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The amount to be added to the `scaleX` property.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "ScaleX.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have a public `scaleX` property,\rand then adds the given value to each of their `scaleX` properties.\r\rThe optional `step` property is applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `ScaleX(group.getChildren(), value, step)`", "kind": "function", "name": "ScaleX", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to be added to the `scaleX` property.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.ScaleX", "scope": "static", "___id": "T000002R000457", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have public `scaleX` and `scaleY` properties,\r\n * and then adds the given value to each of them.\r\n *\r\n * The optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `ScaleXY(group.getChildren(), scaleX, scaleY, stepX, stepY)`\r\n *\r\n * @function Phaser.Actions.ScaleXY\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} scaleX - The amount to be added to the `scaleX` property.\r\n * @param {number} [scaleY] - The amount to be added to the `scaleY` property. If `undefined` or `null` it uses the `scaleX` value.\r\n * @param {number} [stepX=0] - This is added to the `scaleX` amount, multiplied by the iteration counter.\r\n * @param {number} [stepY=0] - This is added to the `scaleY` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "ScaleXY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have public `scaleX` and `scaleY` properties,\rand then adds the given value to each of them.\r\rThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `ScaleXY(group.getChildren(), scaleX, scaleY, stepX, stepY)`", "kind": "function", "name": "ScaleXY", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to be added to the `scaleX` property.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `scaleX` amount, multiplied by the iteration counter.", "name": "stepX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `scaleY` amount, multiplied by the iteration counter.", "name": "stepY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.ScaleXY", "scope": "static", "___id": "T000002R000461", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have a public `scaleY` property,\r\n * and then adds the given value to each of their `scaleY` properties.\r\n *\r\n * The optional `step` parameter is applied incrementally, multiplied by the iteration index of each item in the array.\r\n *\r\n * To use this with a Group: `ScaleY(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.ScaleY\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The amount to be added to the `scaleY` property.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "ScaleY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have a public `scaleY` property,\rand then adds the given value to each of their `scaleY` properties.\r\rThe optional `step` parameter is applied incrementally, multiplied by the iteration index of each item in the array.\r\rTo use this with a Group: `ScaleY(group.getChildren(), value, step)`", "kind": "function", "name": "ScaleY", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to be added to the `scaleY` property.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.ScaleY", "scope": "static", "___id": "T000002R000466", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public property `alpha`\r\n * and then sets it to the given value.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by the iteration index and added to `value`.\r\n *\r\n * To use this with a Group: `SetAlpha(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.SetAlpha\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The alpha value to set on each item. Should be in the range 0 (fully transparent) to 1 (fully opaque).\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetAlpha.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public property `alpha`\rand then sets it to the given value.\r\rThe optional `step` property is applied incrementally, multiplied by the iteration index and added to `value`.\r\rTo use this with a Group: `SetAlpha(group.getChildren(), value, step)`", "kind": "function", "name": "SetAlpha", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha value to set on each item. Should be in the range 0 (fully transparent) to 1 (fully opaque).", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetAlpha", "scope": "static", "___id": "T000002R000470", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public property `blendMode`\r\n * and then sets it to the given value.\r\n *\r\n * To use this with a Group: `SetBlendMode(group.getChildren(), value)`\r\n *\r\n * @function Phaser.Actions.SetBlendMode\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {(Phaser.BlendModes|string|number)} value - The Blend Mode to be set.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetBlendMode.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public property `blendMode`\rand then sets it to the given value.\r\rTo use this with a Group: `SetBlendMode(group.getChildren(), value)`", "kind": "function", "name": "SetBlendMode", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "Phaser.BlendModes", "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.BlendModes" }, { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The Blend Mode to be set.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetBlendMode", "scope": "static", "___id": "T000002R000474", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public property `depth`,\r\n * and then sets it to the given value. The `depth` property controls the rendering order\r\n * of Game Objects within a Scene: objects with higher depth values are rendered on top\r\n * of those with lower values.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `SetDepth(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.SetDepth\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The depth value to assign to each item.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetDepth.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public property `depth`,\rand then sets it to the given value. The `depth` property controls the rendering order\rof Game Objects within a Scene: objects with higher depth values are rendered on top\rof those with lower values.\r\rThe optional `step` property is applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `SetDepth(group.getChildren(), value, step)`", "kind": "function", "name": "SetDepth", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The depth value to assign to each item.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetDepth", "scope": "static", "___id": "T000002R000478", "___s": true }, { "comment": "/**\r\n * Iterates over all items in the given array and calls `setInteractive` on each one, applying the same hit area shape and callback to every Game Object in the array.\r\n *\r\n * @see {@link Phaser.GameObjects.GameObject#setInteractive}\r\n *\r\n * @function Phaser.Actions.SetHitArea\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {(Phaser.Types.Input.InputConfiguration|any)} [hitArea] - Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not given it will try to create a Rectangle based on the texture frame.\r\n * @param {Phaser.Types.Input.HitAreaCallback} [hitAreaCallback] - The callback that determines if the pointer is within the Hit Area shape or not. If you provide a shape you must also provide a callback.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "SetHitArea.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Iterates over all items in the given array and calls `setInteractive` on each one, applying the same hit area shape and callback to every Game Object in the array.", "see": [ "{@link Phaser.GameObjects.GameObject#setInteractive}" ], "kind": "function", "name": "SetHitArea", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "Phaser.Types.Input.InputConfiguration", "any" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Input.InputConfiguration" }, { "type": "NameExpression", "name": "any" } ] } }, "optional": true, "description": "Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not given it will try to create a Rectangle based on the texture frame.", "name": "hitArea" }, { "type": { "names": [ "Phaser.Types.Input.HitAreaCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.HitAreaCallback" } }, "optional": true, "description": "The callback that determines if the pointer is within the Hit Area shape or not. If you provide a shape you must also provide a callback.", "name": "hitAreaCallback" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetHitArea", "scope": "static", "___id": "T000002R000481", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public properties `originX` and `originY`\r\n * and then sets them to the given values.\r\n *\r\n * The optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `SetOrigin(group.getChildren(), originX, originY, stepX, stepY)`\r\n *\r\n * @function Phaser.Actions.SetOrigin\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} originX - The amount to set the `originX` property to.\r\n * @param {number} [originY] - The amount to set the `originY` property to. If `undefined` or `null` it uses the `originX` value.\r\n * @param {number} [stepX=0] - This is added to the `originX` amount, multiplied by the iteration counter.\r\n * @param {number} [stepY=0] - This is added to the `originY` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetOrigin.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public properties `originX` and `originY`\rand then sets them to the given values.\r\rThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `SetOrigin(group.getChildren(), originX, originY, stepX, stepY)`", "kind": "function", "name": "SetOrigin", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the `originX` property to.", "name": "originX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `originX` amount, multiplied by the iteration counter.", "name": "stepX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `originY` amount, multiplied by the iteration counter.", "name": "stepY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetOrigin", "scope": "static", "___id": "T000002R000486", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public property `rotation`\r\n * and then sets it to the given value.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `SetRotation(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.SetRotation\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The amount to set the property to (in radians).\r\n * @param {number} [step=0] - This value, multiplied by the iteration index, is added to `value` for each successive item, resulting in each object receiving a progressively stepped rotation (in radians).\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetRotation.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public property `rotation`\rand then sets it to the given value.\r\rThe optional `step` property is applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `SetRotation(group.getChildren(), value, step)`", "kind": "function", "name": "SetRotation", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the property to (in radians).", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This value, multiplied by the iteration index, is added to `value` for each successive item, resulting in each object receiving a progressively stepped rotation (in radians).", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetRotation", "scope": "static", "___id": "T000002R000491", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public properties `scaleX` and `scaleY`\r\n * and then sets them to the given values.\r\n *\r\n * The optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `SetScale(group.getChildren(), scaleX, scaleY, stepX, stepY)`\r\n *\r\n * @function Phaser.Actions.SetScale\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} scaleX - The amount to set the `scaleX` property to.\r\n * @param {number} [scaleY] - The amount to set the `scaleY` property to. If `undefined` or `null` it uses the `scaleX` value.\r\n * @param {number} [stepX=0] - This is added to the `scaleX` amount, multiplied by the iteration counter.\r\n * @param {number} [stepY=0] - This is added to the `scaleY` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetScale.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public properties `scaleX` and `scaleY`\rand then sets them to the given values.\r\rThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `SetScale(group.getChildren(), scaleX, scaleY, stepX, stepY)`", "kind": "function", "name": "SetScale", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the `scaleX` property to.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `scaleX` amount, multiplied by the iteration counter.", "name": "stepX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `scaleY` amount, multiplied by the iteration counter.", "name": "stepY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetScale", "scope": "static", "___id": "T000002R000495", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public property `scaleX`\r\n * and then sets it to the given value.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by the iteration counter.\r\n *\r\n * To use this with a Group: `SetScaleX(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.SetScaleX\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The value to set the `scaleX` property to.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetScaleX.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public property `scaleX`\rand then sets it to the given value.\r\rThe optional `step` property is applied incrementally, multiplied by the iteration counter.\r\rTo use this with a Group: `SetScaleX(group.getChildren(), value, step)`", "kind": "function", "name": "SetScaleX", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to set the `scaleX` property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetScaleX", "scope": "static", "___id": "T000002R000500", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public property `scaleY`\r\n * and then sets it to the given value.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by the iteration counter.\r\n *\r\n * To use this with a Group: `SetScaleY(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.SetScaleY\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The amount to set the property to.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetScaleY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public property `scaleY`\rand then sets it to the given value.\r\rThe optional `step` property is applied incrementally, multiplied by the iteration counter.\r\rTo use this with a Group: `SetScaleY(group.getChildren(), value, step)`", "kind": "function", "name": "SetScaleY", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetScaleY", "scope": "static", "___id": "T000002R000504", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public properties `scrollFactorX` and `scrollFactorY`\r\n * and then sets them to the given values.\r\n *\r\n * The optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `SetScrollFactor(group.getChildren(), scrollFactorX, scrollFactorY, stepX, stepY)`\r\n *\r\n * @function Phaser.Actions.SetScrollFactor\r\n * @since 3.21.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} scrollFactorX - The amount to set the `scrollFactorX` property to.\r\n * @param {number} [scrollFactorY] - The amount to set the `scrollFactorY` property to. If `undefined` or `null` it uses the `scrollFactorX` value.\r\n * @param {number} [stepX=0] - This is added to the `scrollFactorX` amount, multiplied by the iteration counter.\r\n * @param {number} [stepY=0] - This is added to the `scrollFactorY` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetScrollFactor.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public properties `scrollFactorX` and `scrollFactorY`\rand then sets them to the given values.\r\rThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `SetScrollFactor(group.getChildren(), scrollFactorX, scrollFactorY, stepX, stepY)`", "kind": "function", "name": "SetScrollFactor", "since": "3.21.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the `scrollFactorX` property to.", "name": "scrollFactorX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `scrollFactorX` amount, multiplied by the iteration counter.", "name": "stepX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `scrollFactorY` amount, multiplied by the iteration counter.", "name": "stepY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetScrollFactor", "scope": "static", "___id": "T000002R000508", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public property `scrollFactorX`\r\n * and then sets it to the given value.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `SetScrollFactorX(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.SetScrollFactorX\r\n * @since 3.21.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The amount to set the property to.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetScrollFactorX.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public property `scrollFactorX`\rand then sets it to the given value.\r\rThe optional `step` property is applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `SetScrollFactorX(group.getChildren(), value, step)`", "kind": "function", "name": "SetScrollFactorX", "since": "3.21.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetScrollFactorX", "scope": "static", "___id": "T000002R000513", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public property `scrollFactorY`\r\n * and then sets it to the given value.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `SetScrollFactorY(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.SetScrollFactorY\r\n * @since 3.21.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The amount to set the property to.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetScrollFactorY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public property `scrollFactorY`\rand then sets it to the given value.\r\rThe optional `step` property is applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `SetScrollFactorY(group.getChildren(), value, step)`", "kind": "function", "name": "SetScrollFactorY", "since": "3.21.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetScrollFactorY", "scope": "static", "___id": "T000002R000517", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public method setTint(), and then updates the tint of each to the given value(s). You can specify a tint color per corner or provide only one color value for the `topLeft` parameter, in which case the whole item will be tinted with that color.\r\n *\r\n * @function Phaser.Actions.SetTint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {number} topLeft - The tint to be applied to the top-left corner of each item. If the other parameters are omitted, this tint will be applied to the whole item.\r\n * @param {number} [topRight] - The tint to be applied to top-right corner of item.\r\n * @param {number} [bottomLeft] - The tint to be applied to the bottom-left corner of item.\r\n * @param {number} [bottomRight] - The tint to be applied to the bottom-right corner of item.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "SetTint.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public method setTint(), and then updates the tint of each to the given value(s). You can specify a tint color per corner or provide only one color value for the `topLeft` parameter, in which case the whole item will be tinted with that color.", "kind": "function", "name": "SetTint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint to be applied to the top-left corner of each item. If the other parameters are omitted, this tint will be applied to the whole item.", "name": "topLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint to be applied to top-right corner of item.", "name": "topRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint to be applied to the bottom-left corner of item.", "name": "bottomLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint to be applied to the bottom-right corner of item.", "name": "bottomRight" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetTint", "scope": "static", "___id": "T000002R000520", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public property `visible`\r\n * and then sets it to the given value.\r\n *\r\n * To use this with a Group: `SetVisible(group.getChildren(), value)`\r\n *\r\n * @function Phaser.Actions.SetVisible\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {boolean} value - The visible state to set on each item. Set to `true` to make items visible, or `false` to hide them.\r\n * @param {number} [index=0] - An optional offset to start iterating from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetVisible.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public property `visible`\rand then sets it to the given value.\r\rTo use this with a Group: `SetVisible(group.getChildren(), value)`", "kind": "function", "name": "SetVisible", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state to set on each item. Set to `true` to make items visible, or `false` to hide them.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start iterating from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetVisible", "scope": "static", "___id": "T000002R000525", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public property `x`\r\n * and then sets it to the given value.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `SetX(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.SetX\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The x coordinate, in pixels, to set on each item.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration index, so that each item receives a progressively increasing x offset.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetX.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public property `x`\rand then sets it to the given value.\r\rThe optional `step` property is applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `SetX(group.getChildren(), value, step)`", "kind": "function", "name": "SetX", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate, in pixels, to set on each item.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration index, so that each item receives a progressively increasing x offset.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetX", "scope": "static", "___id": "T000002R000529", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public properties `x` and `y`\r\n * and then sets them to the given values.\r\n *\r\n * The optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `SetXY(group.getChildren(), x, y, stepX, stepY)`\r\n *\r\n * @function Phaser.Actions.SetXY\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} x - The amount to set the `x` property to.\r\n * @param {number} [y=x] - The amount to set the `y` property to. If `undefined` or `null` it uses the `x` value.\r\n * @param {number} [stepX=0] - This is added to the `x` amount, multiplied by the iteration counter.\r\n * @param {number} [stepY=0] - This is added to the `y` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetXY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public properties `x` and `y`\rand then sets them to the given values.\r\rThe optional `stepX` and `stepY` properties are applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `SetXY(group.getChildren(), x, y, stepX, stepY)`", "kind": "function", "name": "SetXY", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the `x` property to.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `x` amount, multiplied by the iteration counter.", "name": "stepX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `y` amount, multiplied by the iteration counter.", "name": "stepY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetXY", "scope": "static", "___id": "T000002R000533", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects, or any objects that have the public property `y`\r\n * and then sets it to the given value.\r\n *\r\n * The optional `step` property is applied incrementally, multiplied by each item in the array.\r\n *\r\n * To use this with a Group: `SetY(group.getChildren(), value, step)`\r\n *\r\n * @function Phaser.Actions.SetY\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.\r\n * @param {number} value - The amount to set the property to.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of objects that were passed to this Action.\r\n */", "meta": { "filename": "SetY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects, or any objects that have the public property `y`\rand then sets it to the given value.\r\rThe optional `step` property is applied incrementally, multiplied by each item in the array.\r\rTo use this with a Group: `SetY(group.getChildren(), value, step)`", "kind": "function", "name": "SetY", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of items to be updated by this action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SetY", "scope": "static", "___id": "T000002R000538", "___s": true }, { "comment": "/**\r\n * Takes an array of items, such as Game Objects, or any objects with public `x` and\r\n * `y` properties and then iterates through them. As this function iterates, it moves\r\n * the position of the current element to be that of the previous entry in the array.\r\n * This repeats until all items have been moved.\r\n *\r\n * The direction controls the order of iteration. A value of 0 (the default) assumes\r\n * that the final item in the array is the 'head' item.\r\n *\r\n * A direction value of 1 assumes that the first item in the array is the 'head' item.\r\n *\r\n * The position of the 'head' item is set to the x/y values given to this function.\r\n * Every other item in the array is then updated, in sequence, to be that of the\r\n * previous (or next) entry in the array.\r\n *\r\n * The final x/y coords are returned, or set in the 'output' Vector2.\r\n *\r\n * Think of it as being like the game Snake, where the 'head' is moved and then\r\n * each body piece is moved into the space of the previous piece.\r\n *\r\n * @function Phaser.Actions.ShiftPosition\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items]\r\n * @generic {Phaser.Math.Vector2} O - [output,$return]\r\n *\r\n * @param {(Phaser.Types.Math.Vector2Like[]|Phaser.GameObjects.GameObject[])} items - An array of Game Objects, or objects with public x and y positions. The contents of this array are updated by this Action.\r\n * @param {number} x - The x coordinate to place the head item at.\r\n * @param {number} y - The y coordinate to place the head item at.\r\n * @param {number} [direction=0] - The iteration direction. 0 = last to first and 1 = first to last.\r\n * @param {Phaser.Types.Math.Vector2Like} [output] - An optional Vec2Like object to store the final position in.\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The output vector.\r\n */", "meta": { "filename": "ShiftPosition.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of items, such as Game Objects, or any objects with public `x` and\r`y` properties and then iterates through them. As this function iterates, it moves\rthe position of the current element to be that of the previous entry in the array.\rThis repeats until all items have been moved.\r\rThe direction controls the order of iteration. A value of 0 (the default) assumes\rthat the final item in the array is the 'head' item.\r\rA direction value of 1 assumes that the first item in the array is the 'head' item.\r\rThe position of the 'head' item is set to the x/y values given to this function.\rEvery other item in the array is then updated, in sequence, to be that of the\rprevious (or next) entry in the array.\r\rThe final x/y coords are returned, or set in the 'output' Vector2.\r\rThink of it as being like the game Snake, where the 'head' is moved and then\reach body piece is moved into the space of the previous piece.", "kind": "function", "name": "ShiftPosition", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items]", "value": "{Phaser.GameObjects.GameObject[]} G - [items]" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [output,$return]", "value": "{Phaser.Math.Vector2} O - [output,$return]" } ], "params": [ { "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects, or objects with public x and y positions. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to place the head item at.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to place the head item at.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The iteration direction. 0 = last to first and 1 = first to last.", "name": "direction" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "An optional Vec2Like object to store the final position in.", "name": "output" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The output vector." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.ShiftPosition", "scope": "static", "___id": "T000002R000542", "___s": true }, { "comment": "/**\r\n * Shuffles the array in place. The shuffled array is both modified and returned.\r\n *\r\n * @function Phaser.Actions.Shuffle\r\n * @since 3.0.0\r\n * @see Phaser.Utils.Array.Shuffle\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "Shuffle.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "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" ], "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.Shuffle", "scope": "static", "___id": "T000002R000573", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and distributes values across the specified property using\r\n * smootherstep interpolation. Each item in the array is assigned a smootherstep-interpolated\r\n * value based on its position, creating an even smoother transition than SmoothStep.\r\n *\r\n * Smootherstep is a sigmoid-like interpolation and clamping function.\r\n *\r\n * The 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 smootherstep function is zero at both edges. This is convenient for creating a sequence of transitions using smootherstep to interpolate each segment as an alternative to using more sophisticated or expensive interpolation techniques.\r\n *\r\n * @function Phaser.Actions.SmootherStep\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {string} property - The property of the Game Object to interpolate.\r\n * @param {number} min - The minimum interpolation value.\r\n * @param {number} max - The maximum interpolation value.\r\n * @param {boolean} [inc=false] - If `true`, the values are incremented. If `false` (default), the values are set.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "SmootherStep.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects and distributes values across the specified property using\rsmootherstep interpolation. Each item in the array is assigned a smootherstep-interpolated\rvalue based on its position, creating an even smoother transition than SmoothStep.\r\rSmootherstep is a sigmoid-like interpolation and clamping function.\r\rThe 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 smootherstep function is zero at both edges. This is convenient for creating a sequence of transitions using smootherstep to interpolate each segment as an alternative to using more sophisticated or expensive interpolation techniques.", "kind": "function", "name": "SmootherStep", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property of the Game Object to interpolate.", "name": "property" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum interpolation value.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum interpolation value.", "name": "max" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true`, the values are incremented. If `false` (default), the values are set.", "name": "inc" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SmootherStep", "scope": "static", "___id": "T000002R000577", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and distributes values across the specified property using\r\n * smoothstep interpolation. Each item in the array is assigned a smoothstep-interpolated value\r\n * based on its position, creating a smooth ease-in/ease-out transition across the items.\r\n *\r\n * Smoothstep is a sigmoid-like interpolation and clamping function.\r\n *\r\n * The function depends on three parameters, the input x, the \"left edge\"\r\n * and the \"right edge\", with the left edge being assumed smaller than the right edge.\r\n *\r\n * The function receives a real number x as an argument and returns 0 if x is less than\r\n * or equal to the left edge, 1 if x is greater than or equal to the right edge, and smoothly\r\n * interpolates, using a Hermite polynomial, between 0 and 1 otherwise. The slope of the\r\n * smoothstep function is zero at both edges.\r\n *\r\n * This is convenient for creating a sequence of transitions using smoothstep to interpolate\r\n * each segment as an alternative to using more sophisticated or expensive interpolation techniques.\r\n *\r\n * @function Phaser.Actions.SmoothStep\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {string} property - The property of the Game Object to interpolate.\r\n * @param {number} min - The left edge of the smoothstep. This value should be smaller than `max`.\r\n * @param {number} max - The right edge of the smoothstep. This value should be larger than `min`.\r\n * @param {boolean} [inc=false] - Should the property value be incremented (`true`) or set (`false`)?\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "SmoothStep.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects and distributes values across the specified property using\rsmoothstep interpolation. Each item in the array is assigned a smoothstep-interpolated value\rbased on its position, creating a smooth ease-in/ease-out transition across the items.\r\rSmoothstep is a sigmoid-like interpolation and clamping function.\r\rThe function depends on three parameters, the input x, the \"left edge\"\rand the \"right edge\", with the left edge being assumed smaller than the right edge.\r\rThe function receives a real number x as an argument and returns 0 if x is less than\ror equal to the left edge, 1 if x is greater than or equal to the right edge, and smoothly\rinterpolates, using a Hermite polynomial, between 0 and 1 otherwise. The slope of the\rsmoothstep function is zero at both edges.\r\rThis is convenient for creating a sequence of transitions using smoothstep to interpolate\reach segment as an alternative to using more sophisticated or expensive interpolation techniques.", "kind": "function", "name": "SmoothStep", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property of the Game Object to interpolate.", "name": "property" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left edge of the smoothstep. This value should be smaller than `max`.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The right edge of the smoothstep. This value should be larger than `min`.", "name": "max" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the property value be incremented (`true`) or set (`false`)?", "name": "inc" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.SmoothStep", "scope": "static", "___id": "T000002R000588", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and then modifies their `property` so the value equals, or is incremented, by the\r\n * calculated spread value.\r\n * \r\n * The spread value is derived from the given `min` and `max` values and the total number of items in the array.\r\n * \r\n * For example, to cause an array of Sprites to change in alpha from 0 to 1 you could call:\r\n * \r\n * ```javascript\r\n * Phaser.Actions.Spread(itemsArray, 'alpha', 0, 1);\r\n * ```\r\n *\r\n * @function Phaser.Actions.Spread\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {string} property - The property of the Game Object to spread.\r\n * @param {number} min - The minimum value.\r\n * @param {number} max - The maximum value.\r\n * @param {boolean} [inc=false] - Should the values be incremented (`true`) or set directly (`false`)?\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that were passed to this Action.\r\n */", "meta": { "filename": "Spread.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects and then modifies their `property` so the value equals, or is incremented, by the\rcalculated spread value.\r\rThe spread value is derived from the given `min` and `max` values and the total number of items in the array.\r\rFor example, to cause an array of Sprites to change in alpha from 0 to 1 you could call:\r\r```javascript\rPhaser.Actions.Spread(itemsArray, 'alpha', 0, 1);\r```", "kind": "function", "name": "Spread", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property of the Game Object to spread.", "name": "property" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum value.", "name": "max" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the values be incremented (`true`) or set directly (`false`)?", "name": "inc" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that were passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.Spread", "scope": "static", "___id": "T000002R000598", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and toggles the visibility of each one.\r\n * Those previously `visible = false` will become `visible = true`, and vice versa.\r\n *\r\n * @function Phaser.Actions.ToggleVisible\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "ToggleVisible.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Takes an array of Game Objects and toggles the visibility of each one.\rThose previously `visible = false` will become `visible = true`, and vice versa.", "kind": "function", "name": "ToggleVisible", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.ToggleVisible", "scope": "static", "___id": "T000002R000610", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Actions.AddEffectBloomConfig\r\n * @since 4.0.0\r\n *\r\n * @property {number} [threshold=0.5] - The lower brightness threshold for channels to contribute to the bloom, in the range 0-1.\r\n * @property {number} [blurRadius=2] - The radius of light blur in the bloom.\r\n * @property {number} [blurSteps=4] - The number of steps to run the blur in the bloom. This value should always be an integer.\r\n * @property {number} [blurQuality=0] - The quality of the light blur: 0 (low), 1 (medium) or 2 (high).\r\n * @property {number} [blendAmount=1] - The amount by which to blend the bloom over the original image. 0 is none, 1 is 100%. Higher values are allowed.\r\n * @property {Phaser.BlendModes} [blendMode=Phaser.BlendModes.ADD] - The blend mode to use when applying the bloom.\r\n * @property {boolean} [useInternal] - Whether to add filters to the internal filter list of the effect target. By default, filters are added to the external filter list, so they run relative to the screen.\r\n */", "meta": { "filename": "AddEffectBloomConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions\\typedefs", "code": {} }, "kind": "typedef", "name": "AddEffectBloomConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The lower brightness threshold for channels to contribute to the bloom, in the range 0-1.", "name": "threshold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "The radius of light blur in the bloom.", "name": "blurRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "The number of steps to run the blur in the bloom. This value should always be an integer.", "name": "blurSteps" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The quality of the light blur: 0 (low), 1 (medium) or 2 (high).", "name": "blurQuality" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount by which to blend the bloom over the original image. 0 is none, 1 is 100%. Higher values are allowed.", "name": "blendAmount" }, { "type": { "names": [ "Phaser.BlendModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.BlendModes" } }, "optional": true, "defaultvalue": "Phaser.BlendModes.ADD", "description": "The blend mode to use when applying the bloom.", "name": "blendMode" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to add filters to the internal filter list of the effect target. By default, filters are added to the external filter list, so they run relative to the screen.", "name": "useInternal" } ], "memberof": "Phaser.Types.Actions", "longname": "Phaser.Types.Actions.AddEffectBloomConfig", "scope": "static", "___id": "T000002R000615", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Actions.AddEffectBloomReturn\r\n * @since 4.0.0\r\n *\r\n * @property {Phaser.Cameras.Scene2D.Camera|Phaser.GameObjects.GameObject} item - The object or camera to which the bloom is applied.\r\n * @property {Phaser.Filters.ParallelFilters} parallelFilters - The ParallelFilters filter which blends the blurred light with the original image.\r\n * @property {Phaser.Filters.Threshold} threshold - The Threshold filter which cuts off darker light from the image.\r\n * @property {Phaser.Filters.Blur} blur - The Blur filter which spreads out bright light from the image.\r\n */", "meta": { "filename": "AddEffectBloomReturn.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions\\typedefs", "code": {} }, "kind": "typedef", "name": "AddEffectBloomReturn", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera", "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "description": "The object or camera to which the bloom is applied.", "name": "item" }, { "type": { "names": [ "Phaser.Filters.ParallelFilters" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.ParallelFilters" } }, "description": "The ParallelFilters filter which blends the blurred light with the original image.", "name": "parallelFilters" }, { "type": { "names": [ "Phaser.Filters.Threshold" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Threshold" } }, "description": "The Threshold filter which cuts off darker light from the image.", "name": "threshold" }, { "type": { "names": [ "Phaser.Filters.Blur" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Blur" } }, "description": "The Blur filter which spreads out bright light from the image.", "name": "blur" } ], "memberof": "Phaser.Types.Actions", "longname": "Phaser.Types.Actions.AddEffectBloomReturn", "scope": "static", "___id": "T000002R000616", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Actions.AddEffectShineConfig\r\n * @since 4.0.0\r\n*\r\n * @property {number} [radius=0.5] - The width of the shine, as a proportion of the size of the target.\r\n * @property {number} [direction=0.5] - The direction the shine travels in. 0 is to the right, increasing clockwise. Direction changes which corner of the target the shine travels from. This is the direction of the gradient shape vector.\r\n * @property {number} [scale=2] - The length the shine travels, as a proportion of the size of the target. This is the length of the gradient shape vector.\r\n * @property {number} [width=128] - The width of the gradient texture. By default, this is derived from the target.\r\n * @property {number} [height=128] - The height of the gradient texture. By default, this is derived from the target.\r\n * @property {Phaser.Display.ColorBand | Phaser.Types.Display.ColorBandConfig | Array.<(Phaser.Display.ColorBand | Phaser.Types.Display.ColorBandConfig)>} [bands] - Custom color bands to use in the gradient. If this is defined, `shineColor` does nothing.\r\n * @property {number[]} [colorFactor=[ 1.15, 0.85, 0.85, 1 ]] - The factor which multiplies the shiny part of the image. Must be 4 numbers (RGBA). Typical range is 0-1, but it's often useful to make them larger.\r\n * @property {string} [displacementMap] - A displacement map to apply to the gradient. If not defined, no displacement is applied.\r\n * @property {number} [displacement] - If a displacement map is applied, this is its strength.\r\n * @property {number} [duration = 2000] - Duration of the shine animation (via the tween), in milliseconds.\r\n * @property {number} [repeatDelay] - Delay between repetitions of the shine animation.\r\n * @property {string|function} [ease] - Ease mode for the tween.\r\n * @property {boolean} [yoyo] - Whether to move the shine back and forth. If not set, the shine constantly crosses the image in the same direction every time.\r\n * @property {boolean} [useExternal] - Whether to add the shine effect in external space, where it relates to the screen. By default, it is in internal space, where it relates to the target.\r\n * @property {boolean} [reveal] - Whether to use reveal mode. In reveal mode, the effect only shows the shiny part of the image; the rest is hidden. As this is simpler, there is no `parallelFilters` in the return object when reveal mode is on.\r\n */", "meta": { "filename": "AddEffectShineConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions\\typedefs", "code": {} }, "kind": "typedef", "name": "AddEffectShineConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The width of the shine, as a proportion of the size of the target.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The direction the shine travels in. 0 is to the right, increasing clockwise. Direction changes which corner of the target the shine travels from. This is the direction of the gradient shape vector.", "name": "direction" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "The length the shine travels, as a proportion of the size of the target. This is the length of the gradient shape vector.", "name": "scale" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the gradient texture. By default, this is derived from the target.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the gradient texture. By default, this is derived from the target.", "name": "height" }, { "type": { "names": [ "Phaser.Display.ColorBand", "Phaser.Types.Display.ColorBandConfig", "Array.<(Phaser.Display.ColorBand|Phaser.Types.Display.ColorBandConfig)>" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.ColorBand" }, { "type": "NameExpression", "name": "Phaser.Types.Display.ColorBandConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.ColorBand" }, { "type": "NameExpression", "name": "Phaser.Types.Display.ColorBandConfig" } ] } ] } ] } }, "optional": true, "description": "Custom color bands to use in the gradient. If this is defined, `shineColor` does nothing.", "name": "bands" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 1.15, 0.85, 0.85, 1 ]", "description": "The factor which multiplies the shiny part of the image. Must be 4 numbers (RGBA). Typical range is 0-1, but it's often useful to make them larger.", "name": "colorFactor" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "A displacement map to apply to the gradient. If not defined, no displacement is applied.", "name": "displacementMap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If a displacement map is applied, this is its strength.", "name": "displacement" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2000, "description": "Duration of the shine animation (via the tween), in milliseconds.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Delay between repetitions of the shine animation.", "name": "repeatDelay" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "description": "Ease mode for the tween.", "name": "ease" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to move the shine back and forth. If not set, the shine constantly crosses the image in the same direction every time.", "name": "yoyo" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to add the shine effect in external space, where it relates to the screen. By default, it is in internal space, where it relates to the target.", "name": "useExternal" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to use reveal mode. In reveal mode, the effect only shows the shiny part of the image; the rest is hidden. As this is simpler, there is no `parallelFilters` in the return object when reveal mode is on.", "name": "reveal" } ], "memberof": "Phaser.Types.Actions", "longname": "Phaser.Types.Actions.AddEffectShineConfig", "scope": "static", "___id": "T000002R000617", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Actions.AddEffectShineReturn\r\n * @since 4.0.0\r\n *\r\n * @property {Phaser.Cameras.Scene2D.Camera|Phaser.GameObjects.GameObject} item - The object or camera to which the shine is applied.\r\n * @property {Phaser.GameObjects.Gradient} gradient - The gradient which controls the shine area. This is not added to the scene, so it will be garbage collected once all references and the tween are destroyed.\r\n * @property {Phaser.Textures.DynamicTexture} dynamicTexture - The texture where the gradient is rendered, after any filters are applied. This will be destroyed when the target is destroyed. You can destroy it earlier, but it is accessed by the tween, so ensure the tween has stopped.\r\n * @property {Phaser.Tweens.Tween} tween - The tween which controls the gradient motion. When this updates, the dynamicTexture is redrawn. This will be destroyed when the target is destroyed. You can destroy it earlier to stop the gradient from updating.\r\n * @property {?Phaser.Filters.ParallelFilters} parallelFilters - The ParallelFilters filter which adds the shine to the image. This will not be defined if the Shine is in `reveal` mode. This belongs to the target and will be removed when the target is destroyed. You can remove it yourself to remove the shine effect, if not in `reveal` mode.\r\n * @property {Phaser.Filters.Blend} blendFilter - The Blend filter which makes the image shine by multiplying it by the gradient. This controls the brightness of the shine. In `reveal` mode, this belongs to the target and will be removed when the target is destroyed. You can remove if yourself to remove the shine effect. When not in `reveal` mode, this belongs to `parallelFilters.top`.\r\n */", "meta": { "filename": "AddEffectShineReturn.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions\\typedefs", "code": {} }, "kind": "typedef", "name": "AddEffectShineReturn", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera", "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "description": "The object or camera to which the shine is applied.", "name": "item" }, { "type": { "names": [ "Phaser.GameObjects.Gradient" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Gradient" } }, "description": "The gradient which controls the shine area. This is not added to the scene, so it will be garbage collected once all references and the tween are destroyed.", "name": "gradient" }, { "type": { "names": [ "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } }, "description": "The texture where the gradient is rendered, after any filters are applied. This will be destroyed when the target is destroyed. You can destroy it earlier, but it is accessed by the tween, so ensure the tween has stopped.", "name": "dynamicTexture" }, { "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "description": "The tween which controls the gradient motion. When this updates, the dynamicTexture is redrawn. This will be destroyed when the target is destroyed. You can destroy it earlier to stop the gradient from updating.", "name": "tween" }, { "type": { "names": [ "Phaser.Filters.ParallelFilters" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.ParallelFilters", "nullable": true } }, "nullable": true, "description": "The ParallelFilters filter which adds the shine to the image. This will not be defined if the Shine is in `reveal` mode. This belongs to the target and will be removed when the target is destroyed. You can remove it yourself to remove the shine effect, if not in `reveal` mode.", "name": "parallelFilters" }, { "type": { "names": [ "Phaser.Filters.Blend" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Blend" } }, "description": "The Blend filter which makes the image shine by multiplying it by the gradient. This controls the brightness of the shine. In `reveal` mode, this belongs to the target and will be removed when the target is destroyed. You can remove if yourself to remove the shine effect. When not in `reveal` mode, this belongs to `parallelFilters.top`.", "name": "blendFilter" } ], "memberof": "Phaser.Types.Actions", "longname": "Phaser.Types.Actions.AddEffectShineReturn", "scope": "static", "___id": "T000002R000618", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Actions.AddMaskShapeConfig\r\n * @since 4.0.0\r\n *\r\n * @property {string} [shape='circle'] - The type of shape to create. This can be 'circle', 'ellipse', 'square' or 'rectangle'.\r\n * @property {number} [aspectRatio=1] - The aspect ratio of width to height for ellipse and rectangle shapes.\r\n * @property {boolean} [invert] - Whether to invert the mask, typically for creating borders.\r\n * @property {boolean} [useInternal] - Whether to use the internal or external filter list. Internal masks follow game objects, and are executed before external filters.\r\n * @property {number} [blurRadius=0] - The radius of blur to apply to the mask. If 0, no blur is applied. A good value is 2.\r\n * @property {number} [blurSteps=4] - The number of steps to run blur on the mask. This value should always be an integer.\r\n * @property {number} [blurQuality=0] - The quality of any blur: 0 (low), 1 (medium) or 2 (high).\r\n * @property {number} [scaleMode=0] - The scale mode to use when fitting the shape. 0 sets each axis to fill the region independently. -1 scales both axes uniformly so the shape touches the _inside_ of the region. 1 scales both axes uniformly so the shape touches the _outside_ of the region.\r\n * @property {number} [padding=0] - Padding applies an inset around the edge of the masked region. This provides space for blur to soften the edges of a mask.\r\n * @property {Phaser.Geom.Rectangle} [region] - The region to fit. If not defined, it will be inferred from the target's scene scale.\r\n */", "meta": { "filename": "AddMaskShapeConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions\\typedefs", "code": {} }, "kind": "typedef", "name": "AddMaskShapeConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'circle'", "description": "The type of shape to create. This can be 'circle', 'ellipse', 'square' or 'rectangle'.", "name": "shape" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The aspect ratio of width to height for ellipse and rectangle shapes.", "name": "aspectRatio" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to invert the mask, typically for creating borders.", "name": "invert" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to use the internal or external filter list. Internal masks follow game objects, and are executed before external filters.", "name": "useInternal" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The radius of blur to apply to the mask. If 0, no blur is applied. A good value is 2.", "name": "blurRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "The number of steps to run blur on the mask. This value should always be an integer.", "name": "blurSteps" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The quality of any blur: 0 (low), 1 (medium) or 2 (high).", "name": "blurQuality" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The scale mode to use when fitting the shape. 0 sets each axis to fill the region independently. -1 scales both axes uniformly so the shape touches the _inside_ of the region. 1 scales both axes uniformly so the shape touches the _outside_ of the region.", "name": "scaleMode" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Padding applies an inset around the edge of the masked region. This provides space for blur to soften the edges of a mask.", "name": "padding" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "optional": true, "description": "The region to fit. If not defined, it will be inferred from the target's scene scale.", "name": "region" } ], "memberof": "Phaser.Types.Actions", "longname": "Phaser.Types.Actions.AddMaskShapeConfig", "scope": "static", "___id": "T000002R000619", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Actions.CallCallback\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} item - The Game Object to run the callback on.\r\n */", "meta": { "filename": "CallCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions\\typedefs", "code": {} }, "kind": "typedef", "name": "CallCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R000620", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Actions.FitToRegionItemCoverage\r\n * @since 4.0.0\r\n *\r\n * @property {number} [width=1] - Override the effective width of the item.\r\n * @property {number} [height=1] - Override the effective height of the item.\r\n * @property {number} [originX=0.5] - Override the effective horizontal origin of the item.\r\n * @property {number} [originY=0.5] - Override the effective vertical origin of the item.\r\n */", "meta": { "filename": "FitToRegionItemCoverage.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions\\typedefs", "code": {} }, "kind": "typedef", "name": "FitToRegionItemCoverage", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Override the effective width of the item.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Override the effective height of the item.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "Override the effective horizontal origin of the item.", "name": "originX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "Override the effective vertical origin of the item.", "name": "originY" } ], "memberof": "Phaser.Types.Actions", "longname": "Phaser.Types.Actions.FitToRegionItemCoverage", "scope": "static", "___id": "T000002R000621", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Actions.GridAlignConfig\r\n * @since 3.0.0\r\n *\r\n * @property {number} [width=-1] - The width of the grid in items (not pixels). -1 means lay all items out horizontally, regardless of quantity.\r\n * If both this value and height are set to -1 then this value overrides it and the `height` value is ignored.\r\n * @property {number} [height=-1] - The height of the grid in items (not pixels). -1 means lay all items out vertically, regardless of quantity.\r\n * If both this value and `width` are set to -1 then `width` overrides it and this value is ignored.\r\n * @property {number} [cellWidth=1] - The width of the cell, in pixels, in which the item is positioned.\r\n * @property {number} [cellHeight=1] - The height of the cell, in pixels, in which the item is positioned.\r\n * @property {number} [position=0] - The alignment position. One of the Phaser.Display.Align consts such as `TOP_LEFT` or `RIGHT_CENTER`.\r\n * @property {number} [x=0] - Optionally place the top-left of the final grid at this coordinate.\r\n * @property {number} [y=0] - Optionally place the top-left of the final grid at this coordinate.\r\n */", "meta": { "filename": "GridAlignConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions\\typedefs", "code": {} }, "kind": "typedef", "name": "GridAlignConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": -1, "description": "The width of the grid in items (not pixels). -1 means lay all items out horizontally, regardless of quantity.\r 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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": -1, "description": "The height of the grid in items (not pixels). -1 means lay all items out vertically, regardless of quantity.\r If both this value and `width` are set to -1 then `width` overrides it and this value is ignored.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The width of the cell, in pixels, in which the item is positioned.", "name": "cellWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The height of the cell, in pixels, in which the item is positioned.", "name": "cellHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optionally place the top-left of the final grid at this coordinate.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R000622", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Actions\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions\\typedefs", "code": {} }, "kind": "namespace", "name": "Actions", "memberof": "Phaser.Types", "longname": "Phaser.Types.Actions", "scope": "static", "___id": "T000002R000623", "___s": true }, { "comment": "/**\r\n * Iterates through the given array and makes sure that each object's x and y\r\n * properties are wrapped to keep them contained within the given Rectangle's\r\n * area.\r\n *\r\n * @function Phaser.Actions.WrapInRectangle\r\n * @since 3.0.0\r\n * @see Phaser.Math.Wrap\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.\r\n * @param {Phaser.Geom.Rectangle} rect - The rectangle which the objects will be wrapped to remain within.\r\n * @param {number} [padding=0] - An amount added to each side of the rectangle during the operation.\r\n *\r\n * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.\r\n */", "meta": { "filename": "WrapInRectangle.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\actions", "code": {} }, "description": "Iterates through the given array and makes sure that each object's x and y\rproperties are wrapped to keep them contained within the given Rectangle's\rarea.", "kind": "function", "name": "WrapInRectangle", "since": "3.0.0", "see": [ "Phaser.Math.Wrap" ], "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects. The contents of this array are updated by this Action.", "name": "items" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The rectangle which the objects will be wrapped to remain within.", "name": "rect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The array of Game Objects that was passed to this Action." } ], "memberof": "Phaser.Actions", "longname": "Phaser.Actions.WrapInRectangle", "scope": "static", "___id": "T000002R000625", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Frame based Animation.\r\n *\r\n * Animations in Phaser consist of a sequence of `AnimationFrame` objects, which are managed by\r\n * this class, along with properties that impact playback, such as the animation's frame rate\r\n * or delay.\r\n *\r\n * This class contains all of the properties and methods needed to handle playback of the animation\r\n * directly to an `AnimationState` instance, which is owned by a Sprite, or similar Game Object.\r\n *\r\n * You don't typically create an instance of this class directly, but instead go via\r\n * either the `AnimationManager` or the `AnimationState` and use their `create` methods,\r\n * depending on if you need a global animation, or local to a specific Sprite.\r\n *\r\n * @class Animation\r\n * @memberof Phaser.Animations\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Animations.AnimationManager} manager - A reference to the global Animation Manager\r\n * @param {string} key - The unique identifying string for this animation.\r\n * @param {Phaser.Types.Animations.Animation} config - The Animation configuration.\r\n */", "meta": { "filename": "Animation.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "classdesc": "A Frame based Animation.\r\rAnimations in Phaser consist of a sequence of `AnimationFrame` objects, which are managed by\rthis class, along with properties that impact playback, such as the animation's frame rate\ror delay.\r\rThis class contains all of the properties and methods needed to handle playback of the animation\rdirectly to an `AnimationState` instance, which is owned by a Sprite, or similar Game Object.\r\rYou don't typically create an instance of this class directly, but instead go via\reither the `AnimationManager` or the `AnimationState` and use their `create` methods,\rdepending on if you need a global animation, or local to a specific Sprite.", "kind": "class", "name": "Animation", "memberof": "Phaser.Animations", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Animations.AnimationManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationManager" } }, "description": "A reference to the global Animation Manager", "name": "manager" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique identifying string for this animation.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Animations.Animation" } }, "description": "The Animation configuration.", "name": "config" } ], "scope": "static", "longname": "Phaser.Animations.Animation", "___id": "T000002R000640", "___s": true }, { "comment": "/**\r\n * A reference to the global Animation Manager.\r\n *\r\n * @name Phaser.Animations.Animation#manager\r\n * @type {Phaser.Animations.AnimationManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "A reference to the global Animation Manager.", "name": "manager", "type": { "names": [ "Phaser.Animations.AnimationManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationManager" } }, "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#manager", "scope": "instance", "kind": "member", "___id": "T000002R000643", "___s": true }, { "comment": "/**\r\n * The unique identifying string for this animation.\r\n *\r\n * @name Phaser.Animations.Animation#key\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The unique identifying string for this animation.", "name": "key", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#key", "scope": "instance", "kind": "member", "___id": "T000002R000645", "___s": true }, { "comment": "/**\r\n * A frame-based animation (as opposed to a bone-based animation).\r\n *\r\n * @name Phaser.Animations.Animation#type\r\n * @type {string}\r\n * @default frame\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "A frame-based animation (as opposed to a bone-based animation).", "name": "type", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "frame", "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#type", "scope": "instance", "kind": "member", "___id": "T000002R000647", "___s": true }, { "comment": "/**\r\n * An array of AnimationFrame objects that make up this animation.\r\n *\r\n * @name Phaser.Animations.Animation#frames\r\n * @type {Phaser.Animations.AnimationFrame[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "An array of AnimationFrame objects that make up this animation.", "name": "frames", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Animations.AnimationFrame", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#frames", "scope": "instance", "kind": "member", "___id": "T000002R000649", "___s": true }, { "comment": "/**\r\n * The frame rate of playback in frames per second (default 24 if duration is null)\r\n *\r\n * @name Phaser.Animations.Animation#frameRate\r\n * @type {number}\r\n * @default 24\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 87, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The frame rate of playback in frames per second (default 24 if duration is null)", "name": "frameRate", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "24", "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#frameRate", "scope": "instance", "kind": "member", "___id": "T000002R000651", "___s": true }, { "comment": "/**\r\n * How long the animation should play for, in milliseconds.\r\n * If the `frameRate` property has been set then it overrides this value,\r\n * otherwise the `frameRate` is derived from `duration`.\r\n *\r\n * @name Phaser.Animations.Animation#duration\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "How long the animation should play for, in milliseconds.\rIf the `frameRate` property has been set then it overrides this value,\rotherwise the `frameRate` is derived from `duration`.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#duration", "scope": "instance", "kind": "member", "___id": "T000002R000653", "___s": true }, { "comment": "/**\r\n * How many ms per frame, not including frame-specific modifiers.\r\n *\r\n * @name Phaser.Animations.Animation#msPerFrame\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "How many ms per frame, not including frame-specific modifiers.", "name": "msPerFrame", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#msPerFrame", "scope": "instance", "kind": "member", "___id": "T000002R000655", "___s": true }, { "comment": "/**\r\n * Skip frames if the time lags, or always advance anyway?\r\n *\r\n * @name Phaser.Animations.Animation#skipMissedFrames\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Skip frames if the time lags, or always advance anyway?", "name": "skipMissedFrames", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#skipMissedFrames", "scope": "instance", "kind": "member", "___id": "T000002R000657", "___s": true }, { "comment": "/**\r\n * The delay in ms before the playback will begin.\r\n *\r\n * @name Phaser.Animations.Animation#delay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 127, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The delay in ms before the playback will begin.", "name": "delay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#delay", "scope": "instance", "kind": "member", "___id": "T000002R000659", "___s": true }, { "comment": "/**\r\n * Number of times to repeat the animation. Set to -1 to repeat forever.\r\n *\r\n * @name Phaser.Animations.Animation#repeat\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 137, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Number of times to repeat the animation. Set to -1 to repeat forever.", "name": "repeat", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#repeat", "scope": "instance", "kind": "member", "___id": "T000002R000661", "___s": true }, { "comment": "/**\r\n * The delay in ms before a repeat play starts.\r\n *\r\n * @name Phaser.Animations.Animation#repeatDelay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 147, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The delay in ms before a repeat play starts.", "name": "repeatDelay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#repeatDelay", "scope": "instance", "kind": "member", "___id": "T000002R000663", "___s": true }, { "comment": "/**\r\n * Should the animation yoyo (reverse back down to the start) before repeating?\r\n *\r\n * @name Phaser.Animations.Animation#yoyo\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 157, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Should the animation yoyo (reverse back down to the start) before repeating?", "name": "yoyo", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#yoyo", "scope": "instance", "kind": "member", "___id": "T000002R000665", "___s": true }, { "comment": "/**\r\n * If the animation has a delay set, before playback will begin, this\r\n * controls when the first frame is set on the Sprite. If this property\r\n * is 'false' then the frame is set only after the delay has expired.\r\n * This is the default behavior.\r\n *\r\n * @name Phaser.Animations.Animation#showBeforeDelay\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 167, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "If the animation has a delay set, before playback will begin, this\rcontrols when the first frame is set on the Sprite. If this property\ris 'false' then the frame is set only after the delay has expired.\rThis is the default behavior.", "name": "showBeforeDelay", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#showBeforeDelay", "scope": "instance", "kind": "member", "___id": "T000002R000667", "___s": true }, { "comment": "/**\r\n * Should the GameObject's `visible` property be set to `true` when the animation starts to play?\r\n *\r\n * @name Phaser.Animations.Animation#showOnStart\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 180, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Should the GameObject's `visible` property be set to `true` when the animation starts to play?", "name": "showOnStart", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#showOnStart", "scope": "instance", "kind": "member", "___id": "T000002R000669", "___s": true }, { "comment": "/**\r\n * Should the GameObject's `visible` property be set to `false` when the animation finishes?\r\n *\r\n * @name Phaser.Animations.Animation#hideOnComplete\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 190, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Should the GameObject's `visible` property be set to `false` when the animation finishes?", "name": "hideOnComplete", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#hideOnComplete", "scope": "instance", "kind": "member", "___id": "T000002R000671", "___s": true }, { "comment": "/**\r\n * Start playback of this animation from a random frame?\r\n *\r\n * @name Phaser.Animations.Animation#randomFrame\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 200, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Start playback of this animation from a random frame?", "name": "randomFrame", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#randomFrame", "scope": "instance", "kind": "member", "___id": "T000002R000673", "___s": true }, { "comment": "/**\r\n * Global pause. All Game Objects using this Animation instance are impacted by this property.\r\n *\r\n * @name Phaser.Animations.Animation#paused\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 210, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Global pause. All Game Objects using this Animation instance are impacted by this property.", "name": "paused", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#paused", "scope": "instance", "kind": "member", "___id": "T000002R000675", "___s": true }, { "comment": "/**\r\n * Gets the total number of frames in this animation.\r\n *\r\n * @method Phaser.Animations.Animation#getTotalFrames\r\n * @since 3.50.0\r\n *\r\n * @return {number} The total number of frames in this animation.\r\n */", "meta": { "filename": "Animation.js", "lineno": 229, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Gets the total number of frames in this animation.", "kind": "function", "name": "getTotalFrames", "since": "3.50.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of frames in this animation." } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#getTotalFrames", "scope": "instance", "___id": "T000002R000677", "___s": true }, { "comment": "/**\r\n * Calculates the duration, frame rate and msPerFrame values.\r\n *\r\n * @method Phaser.Animations.Animation#calculateDuration\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Animations.Animation} target - The target to set the values on.\r\n * @param {number} totalFrames - The total number of frames in the animation.\r\n * @param {?number} [duration] - The duration to calculate the frame rate from. Pass `null` if you wish to set the `frameRate` instead.\r\n * @param {?number} [frameRate] - The frame rate to calculate the duration from.\r\n */", "meta": { "filename": "Animation.js", "lineno": 242, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Calculates the duration, frame rate and msPerFrame values.", "kind": "function", "name": "calculateDuration", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation" } }, "description": "The target to set the values on.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of frames in the animation.", "name": "totalFrames" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "description": "The duration to calculate the frame rate from. Pass `null` if you wish to set the `frameRate` instead.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "description": "The frame rate to calculate the duration from.", "name": "frameRate" } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#calculateDuration", "scope": "instance", "___id": "T000002R000679", "___s": true }, { "comment": "/**\r\n * Add frames to the end of the animation.\r\n *\r\n * @method Phaser.Animations.Animation#addFrame\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Animations.AnimationFrame[])} config - Either a string, in which case it will use all frames from a texture with the matching key, or an array of Animation Frame configuration objects.\r\n *\r\n * @return {this} This Animation object.\r\n */", "meta": { "filename": "Animation.js", "lineno": 281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Add frames to the end of the animation.", "kind": "function", "name": "addFrame", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.AnimationFrame", "type": "NameExpression" } ] } ] } }, "description": "Either a string, in which case it will use all frames from a texture with the matching key, or an array of Animation Frame configuration objects.", "name": "config" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Animation object." } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#addFrame", "scope": "instance", "___id": "T000002R000688", "___s": true }, { "comment": "/**\r\n * Inserts one or more frames into the animation at the specified index.\r\n *\r\n * @method Phaser.Animations.Animation#addFrameAt\r\n * @since 3.0.0\r\n *\r\n * @param {number} index - The index to insert the frame at within the animation.\r\n * @param {(string|Phaser.Types.Animations.AnimationFrame[])} config - Either a string, in which case it will use all frames from a texture with the matching key, or an array of Animation Frame configuration objects.\r\n *\r\n * @return {this} This Animation object.\r\n */", "meta": { "filename": "Animation.js", "lineno": 296, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Inserts one or more frames into the animation at the specified index.", "kind": "function", "name": "addFrameAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index to insert the frame at within the animation.", "name": "index" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.AnimationFrame", "type": "NameExpression" } ] } ] } }, "description": "Either a string, in which case it will use all frames from a texture with the matching key, or an array of Animation Frame configuration objects.", "name": "config" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Animation object." } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#addFrameAt", "scope": "instance", "___id": "T000002R000690", "___s": true }, { "comment": "/**\r\n * Check if the given frame index is valid.\r\n *\r\n * @method Phaser.Animations.Animation#checkFrame\r\n * @since 3.0.0\r\n *\r\n * @param {number} index - The index to be checked.\r\n *\r\n * @return {boolean} `true` if the index is valid, otherwise `false`.\r\n */", "meta": { "filename": "Animation.js", "lineno": 335, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Check if the given frame index is valid.", "kind": "function", "name": "checkFrame", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index to be checked.", "name": "index" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the index is valid, otherwise `false`." } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#checkFrame", "scope": "instance", "___id": "T000002R000698", "___s": true }, { "comment": "/**\r\n * Called internally when this Animation first starts to play.\r\n * Sets the accumulator and nextTick properties.\r\n *\r\n * @method Phaser.Animations.Animation#getFirstTick\r\n * @protected\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Animations.AnimationState} state - The Animation State belonging to the Game Object invoking this call.\r\n */", "meta": { "filename": "Animation.js", "lineno": 350, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Called internally when this Animation first starts to play.\rSets the accumulator and nextTick properties.", "kind": "function", "name": "getFirstTick", "access": "protected", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Animations.AnimationState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationState" } }, "description": "The Animation State belonging to the Game Object invoking this call.", "name": "state" } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#getFirstTick", "scope": "instance", "___id": "T000002R000700", "___s": true }, { "comment": "/**\r\n * Returns the AnimationFrame at the provided index\r\n *\r\n * @method Phaser.Animations.Animation#getFrameAt\r\n * @since 3.0.0\r\n *\r\n * @param {number} index - The index in the AnimationFrame array\r\n *\r\n * @return {Phaser.Animations.AnimationFrame} The frame at the index provided from the animation sequence\r\n */", "meta": { "filename": "Animation.js", "lineno": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Returns the AnimationFrame at the provided index", "kind": "function", "name": "getFrameAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index in the AnimationFrame array", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The frame at the index provided from the animation sequence" } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#getFrameAt", "scope": "instance", "___id": "T000002R000704", "___s": true }, { "comment": "/**\r\n * Creates AnimationFrame instances based on the given frame data.\r\n *\r\n * @method Phaser.Animations.Animation#getFrames\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Textures.TextureManager} textureManager - A reference to the global Texture Manager.\r\n * @param {(string|Phaser.Types.Animations.AnimationFrame[])} frames - Either a string, in which case it will use all frames from a texture with the matching key, or an array of Animation Frame configuration objects.\r\n * @param {string} [defaultTextureKey] - The key to use if no key is set in the frame configuration object.\r\n *\r\n * @return {Phaser.Animations.AnimationFrame[]} An array of newly created AnimationFrame instances.\r\n */", "meta": { "filename": "Animation.js", "lineno": 383, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Creates AnimationFrame instances based on the given frame data.", "kind": "function", "name": "getFrames", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "description": "A reference to the global Texture Manager.", "name": "textureManager" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.AnimationFrame", "type": "NameExpression" } ] } ] } }, "description": "Either a string, in which case it will use all frames from a texture with the matching key, or an array of Animation Frame configuration objects.", "name": "frames" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The key to use if no key is set in the frame configuration object.", "name": "defaultTextureKey" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Animations.AnimationFrame", "type": "NameExpression" } ] } }, "description": "An array of newly created AnimationFrame instances." } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#getFrames", "scope": "instance", "___id": "T000002R000706", "___s": true }, { "comment": "/**\r\n * Called internally. Sets the accumulator and nextTick values of the current Animation.\r\n *\r\n * @method Phaser.Animations.Animation#getNextTick\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Animations.AnimationState} state - The Animation State belonging to the Game Object invoking this call.\r\n */", "meta": { "filename": "Animation.js", "lineno": 506, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Called internally. Sets the accumulator and nextTick values of the current Animation.", "kind": "function", "name": "getNextTick", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Animations.AnimationState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationState" } }, "description": "The Animation State belonging to the Game Object invoking this call.", "name": "state" } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#getNextTick", "scope": "instance", "___id": "T000002R000738", "___s": true }, { "comment": "/**\r\n * Returns the frame closest to the given progress value between 0 and 1.\r\n *\r\n * @method Phaser.Animations.Animation#getFrameByProgress\r\n * @since 3.4.0\r\n *\r\n * @param {number} value - A value between 0 and 1.\r\n *\r\n * @return {Phaser.Animations.AnimationFrame} The frame closest to the given progress value.\r\n */", "meta": { "filename": "Animation.js", "lineno": 521, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A value between 0 and 1.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The frame closest to the given progress value." } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#getFrameByProgress", "scope": "instance", "___id": "T000002R000742", "___s": true }, { "comment": "/**\r\n * Advance the animation frame.\r\n *\r\n * @method Phaser.Animations.Animation#nextFrame\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Animations.AnimationState} state - The Animation State to advance.\r\n */", "meta": { "filename": "Animation.js", "lineno": 538, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Advance the animation frame.", "kind": "function", "name": "nextFrame", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Animations.AnimationState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationState" } }, "description": "The Animation State to advance.", "name": "state" } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#nextFrame", "scope": "instance", "___id": "T000002R000745", "___s": true }, { "comment": "/**\r\n * Returns the last frame in this animation.\r\n *\r\n * @method Phaser.Animations.Animation#getLastFrame\r\n * @since 3.12.0\r\n *\r\n * @return {Phaser.Animations.AnimationFrame} The last Animation Frame.\r\n */", "meta": { "filename": "Animation.js", "lineno": 623, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Returns the last frame in this animation.", "kind": "function", "name": "getLastFrame", "since": "3.12.0", "returns": [ { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The last Animation Frame." } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#getLastFrame", "scope": "instance", "___id": "T000002R000755", "___s": true }, { "comment": "/**\r\n * Called internally when the Animation is playing backwards.\r\n * Sets the previous frame, causing a yoyo, repeat, complete or update, accordingly.\r\n *\r\n * @method Phaser.Animations.Animation#previousFrame\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Animations.AnimationState} state - The Animation State belonging to the Game Object invoking this call.\r\n */", "meta": { "filename": "Animation.js", "lineno": 636, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Called internally when the Animation is playing backwards.\rSets the previous frame, causing a yoyo, repeat, complete or update, accordingly.", "kind": "function", "name": "previousFrame", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Animations.AnimationState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationState" } }, "description": "The Animation State belonging to the Game Object invoking this call.", "name": "state" } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#previousFrame", "scope": "instance", "___id": "T000002R000757", "___s": true }, { "comment": "/**\r\n * Removes the given AnimationFrame from this Animation instance.\r\n * This is a global action. Any Game Object using this Animation will be impacted by this change.\r\n *\r\n * @method Phaser.Animations.Animation#removeFrame\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Animations.AnimationFrame} frame - The AnimationFrame to be removed.\r\n *\r\n * @return {this} This Animation object.\r\n */", "meta": { "filename": "Animation.js", "lineno": 698, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Removes the given AnimationFrame from this Animation instance.\rThis is a global action. Any Game Object using this Animation will be impacted by this change.", "kind": "function", "name": "removeFrame", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The AnimationFrame to be removed.", "name": "frame" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Animation object." } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#removeFrame", "scope": "instance", "___id": "T000002R000763", "___s": true }, { "comment": "/**\r\n * Removes a frame from the AnimationFrame array at the provided index\r\n * and updates the animation accordingly.\r\n *\r\n * @method Phaser.Animations.Animation#removeFrameAt\r\n * @since 3.0.0\r\n *\r\n * @param {number} index - The index in the AnimationFrame array\r\n *\r\n * @return {this} This Animation object.\r\n */", "meta": { "filename": "Animation.js", "lineno": 721, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Removes a frame from the AnimationFrame array at the provided index\rand updates the animation accordingly.", "kind": "function", "name": "removeFrameAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index in the AnimationFrame array", "name": "index" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Animation object." } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#removeFrameAt", "scope": "instance", "___id": "T000002R000766", "___s": true }, { "comment": "/**\r\n * Called internally during playback. Forces the animation to repeat, provided there are enough counts left\r\n * in the repeat counter.\r\n *\r\n * @method Phaser.Animations.Animation#repeatAnimation\r\n * @fires Phaser.Animations.Events#ANIMATION_REPEAT\r\n * @fires Phaser.Animations.Events#SPRITE_ANIMATION_REPEAT\r\n * @fires Phaser.Animations.Events#SPRITE_ANIMATION_KEY_REPEAT\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Animations.AnimationState} state - The Animation State belonging to the Game Object invoking this call.\r\n */", "meta": { "filename": "Animation.js", "lineno": 741, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Called internally during playback. Forces the animation to repeat, provided there are enough counts left\rin the repeat counter.", "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.Animations.AnimationState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationState" } }, "description": "The Animation State belonging to the Game Object invoking this call.", "name": "state" } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#repeatAnimation", "scope": "instance", "___id": "T000002R000768", "___s": true }, { "comment": "/**\r\n * Converts the animation data to JSON.\r\n *\r\n * @method Phaser.Animations.Animation#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.Animations.JSONAnimation} The resulting JSONAnimation formatted object.\r\n */", "meta": { "filename": "Animation.js", "lineno": 795, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Converts the animation data to JSON.", "kind": "function", "name": "toJSON", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.Animations.JSONAnimation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Animations.JSONAnimation" } }, "description": "The resulting JSONAnimation formatted object." } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#toJSON", "scope": "instance", "___id": "T000002R000773", "___s": true }, { "comment": "/**\r\n * Called internally whenever frames are added to, or removed from, this Animation.\r\n *\r\n * @method Phaser.Animations.Animation#updateFrameSequence\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Animation object.\r\n */", "meta": { "filename": "Animation.js", "lineno": 830, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Called internally whenever frames are added to, or removed from, this Animation.", "kind": "function", "name": "updateFrameSequence", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Animation object." } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#updateFrameSequence", "scope": "instance", "___id": "T000002R000790", "___s": true }, { "comment": "/**\r\n * Pauses playback of this Animation. The paused state is set immediately.\r\n *\r\n * @method Phaser.Animations.Animation#pause\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Animation object.\r\n */", "meta": { "filename": "Animation.js", "lineno": 887, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Pauses playback of this Animation. The paused state is set immediately.", "kind": "function", "name": "pause", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Animation object." } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#pause", "scope": "instance", "___id": "T000002R000813", "___s": true }, { "comment": "/**\r\n * Resumes playback of this Animation. The paused state is reset immediately.\r\n *\r\n * @method Phaser.Animations.Animation#resume\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Animation object.\r\n */", "meta": { "filename": "Animation.js", "lineno": 902, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Resumes playback of this Animation. The paused state is reset immediately.", "kind": "function", "name": "resume", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Animation object." } ], "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#resume", "scope": "instance", "___id": "T000002R000816", "___s": true }, { "comment": "/**\r\n * Destroys this Animation instance. It will remove all event listeners,\r\n * remove this animation and its key from the global Animation Manager,\r\n * and then destroy all Animation Frames in turn.\r\n *\r\n * @method Phaser.Animations.Animation#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Animation.js", "lineno": 917, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Destroys this Animation instance. It will remove all event listeners,\rremove this animation and its key from the global Animation Manager,\rand then destroy all Animation Frames in turn.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Animations.Animation", "longname": "Phaser.Animations.Animation#destroy", "scope": "instance", "___id": "T000002R000819", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single frame within an Animation sequence.\r\n *\r\n * An AnimationFrame holds a reference to the Texture Frame it uses for rendering, links to the\r\n * previous and next frames in the sequence, its position index, and playback progress data.\r\n * It can also carry an optional per-frame duration that overrides the parent Animation's default\r\n * frame rate, and can be flagged as a keyframe to mark significant moments in the sequence.\r\n *\r\n * AnimationFrames are created and managed automatically by the Animation class when an animation\r\n * is built via the Animation Manager. You would not typically instantiate AnimationFrame directly.\r\n *\r\n * @class AnimationFrame\r\n * @memberof Phaser.Animations\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {string} textureKey - The key of the Texture this AnimationFrame uses.\r\n * @param {(string|number)} textureFrame - The key of the Frame within the Texture that this AnimationFrame uses.\r\n * @param {number} index - The index of this AnimationFrame within the Animation sequence.\r\n * @param {Phaser.Textures.Frame} frame - A reference to the Texture Frame this AnimationFrame uses for rendering.\r\n * @param {boolean} [isKeyFrame=false] - Is this Frame a Keyframe within the Animation?\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "classdesc": "A single frame within an Animation sequence.\r\rAn AnimationFrame holds a reference to the Texture Frame it uses for rendering, links to the\rprevious and next frames in the sequence, its position index, and playback progress data.\rIt can also carry an optional per-frame duration that overrides the parent Animation's default\rframe rate, and can be flagged as a keyframe to mark significant moments in the sequence.\r\rAnimationFrames are created and managed automatically by the Animation class when an animation\ris built via the Animation Manager. You would not typically instantiate AnimationFrame directly.", "kind": "class", "name": "AnimationFrame", "memberof": "Phaser.Animations", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Texture this AnimationFrame uses.", "name": "textureKey" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The key of the Frame within the Texture that this AnimationFrame uses.", "name": "textureFrame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of this AnimationFrame within the Animation sequence.", "name": "index" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "A reference to the Texture Frame this AnimationFrame uses for rendering.", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is this Frame a Keyframe within the Animation?", "name": "isKeyFrame" } ], "scope": "static", "longname": "Phaser.Animations.AnimationFrame", "___id": "T000002R000826", "___s": true }, { "comment": "/**\r\n * The key of the Texture this AnimationFrame uses.\r\n *\r\n * @name Phaser.Animations.AnimationFrame#textureKey\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The key of the Texture this AnimationFrame uses.", "name": "textureKey", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Animations.AnimationFrame", "longname": "Phaser.Animations.AnimationFrame#textureKey", "scope": "instance", "kind": "member", "___id": "T000002R000830", "___s": true }, { "comment": "/**\r\n * The key of the Frame within the Texture that this AnimationFrame uses.\r\n *\r\n * @name Phaser.Animations.AnimationFrame#textureFrame\r\n * @type {(string|number)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The key of the Frame within the Texture that this AnimationFrame uses.", "name": "textureFrame", "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "since": "3.0.0", "memberof": "Phaser.Animations.AnimationFrame", "longname": "Phaser.Animations.AnimationFrame#textureFrame", "scope": "instance", "kind": "member", "___id": "T000002R000832", "___s": true }, { "comment": "/**\r\n * The index of this AnimationFrame within the Animation sequence.\r\n *\r\n * @name Phaser.Animations.AnimationFrame#index\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The index of this AnimationFrame within the Animation sequence.", "name": "index", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Animations.AnimationFrame", "longname": "Phaser.Animations.AnimationFrame#index", "scope": "instance", "kind": "member", "___id": "T000002R000834", "___s": true }, { "comment": "/**\r\n * A reference to the Texture Frame this AnimationFrame uses for rendering.\r\n *\r\n * @name Phaser.Animations.AnimationFrame#frame\r\n * @type {Phaser.Textures.Frame}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "A reference to the Texture Frame this AnimationFrame uses for rendering.", "name": "frame", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.Animations.AnimationFrame", "longname": "Phaser.Animations.AnimationFrame#frame", "scope": "instance", "kind": "member", "___id": "T000002R000836", "___s": true }, { "comment": "/**\r\n * Is this the first frame in an animation sequence?\r\n *\r\n * @name Phaser.Animations.AnimationFrame#isFirst\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Is this the first frame in an animation sequence?", "name": "isFirst", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Animations.AnimationFrame", "longname": "Phaser.Animations.AnimationFrame#isFirst", "scope": "instance", "kind": "member", "___id": "T000002R000838", "___s": true }, { "comment": "/**\r\n * Is this the last frame in an animation sequence?\r\n *\r\n * @name Phaser.Animations.AnimationFrame#isLast\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 87, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Is this the last frame in an animation sequence?", "name": "isLast", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Animations.AnimationFrame", "longname": "Phaser.Animations.AnimationFrame#isLast", "scope": "instance", "kind": "member", "___id": "T000002R000840", "___s": true }, { "comment": "/**\r\n * A reference to the AnimationFrame that comes before this one in the animation, if any.\r\n *\r\n * @name Phaser.Animations.AnimationFrame#prevFrame\r\n * @type {?Phaser.Animations.AnimationFrame}\r\n * @default null\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "A reference to the AnimationFrame that comes before this one in the animation, if any.", "name": "prevFrame", "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame", "nullable": true } }, "nullable": true, "defaultvalue": "null", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Animations.AnimationFrame", "longname": "Phaser.Animations.AnimationFrame#prevFrame", "scope": "instance", "kind": "member", "___id": "T000002R000842", "___s": true }, { "comment": "/**\r\n * A reference to the AnimationFrame that comes after this one in the animation, if any.\r\n *\r\n * @name Phaser.Animations.AnimationFrame#nextFrame\r\n * @type {?Phaser.Animations.AnimationFrame}\r\n * @default null\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 109, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "A reference to the AnimationFrame that comes after this one in the animation, if any.", "name": "nextFrame", "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame", "nullable": true } }, "nullable": true, "defaultvalue": "null", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Animations.AnimationFrame", "longname": "Phaser.Animations.AnimationFrame#nextFrame", "scope": "instance", "kind": "member", "___id": "T000002R000844", "___s": true }, { "comment": "/**\r\n * The duration, in ms, of this frame of the animation.\r\n *\r\n * @name Phaser.Animations.AnimationFrame#duration\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The duration, in ms, of this frame of the animation.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationFrame", "longname": "Phaser.Animations.AnimationFrame#duration", "scope": "instance", "kind": "member", "___id": "T000002R000846", "___s": true }, { "comment": "/**\r\n * The normalized progress of this frame within the animation, in the range 0 to 1.\r\n * A value of 0 means the very start of the animation and 1 means the very end.\r\n * This value is calculated when the animation is created and cached here.\r\n *\r\n * @name Phaser.Animations.AnimationFrame#progress\r\n * @type {number}\r\n * @default 0\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The normalized progress of this frame within the animation, in the range 0 to 1.\rA value of 0 means the very start of the animation and 1 means the very end.\rThis value is calculated when the animation is created and cached here.", "name": "progress", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "readonly": true, "since": "3.0.0", "memberof": "Phaser.Animations.AnimationFrame", "longname": "Phaser.Animations.AnimationFrame#progress", "scope": "instance", "kind": "member", "___id": "T000002R000848", "___s": true }, { "comment": "/**\r\n * Is this Frame a KeyFrame within the Animation?\r\n *\r\n * @name Phaser.Animations.AnimationFrame#isKeyFrame\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 143, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Is this Frame a KeyFrame within the Animation?", "name": "isKeyFrame", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Animations.AnimationFrame", "longname": "Phaser.Animations.AnimationFrame#isKeyFrame", "scope": "instance", "kind": "member", "___id": "T000002R000850", "___s": true }, { "comment": "/**\r\n * Generates a JavaScript object suitable for converting to JSON.\r\n *\r\n * @method Phaser.Animations.AnimationFrame#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.Animations.JSONAnimationFrame} The AnimationFrame data.\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 153, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Animations.JSONAnimationFrame" } }, "description": "The AnimationFrame data." } ], "memberof": "Phaser.Animations.AnimationFrame", "longname": "Phaser.Animations.AnimationFrame#toJSON", "scope": "instance", "___id": "T000002R000852", "___s": true }, { "comment": "/**\r\n * Destroys this object by removing references to external resources.\r\n *\r\n * @method Phaser.Animations.AnimationFrame#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 171, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Destroys this object by removing references to external resources.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationFrame", "longname": "Phaser.Animations.AnimationFrame#destroy", "scope": "instance", "___id": "T000002R000858", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Animation Manager is a global system responsible for defining, storing, and managing all\r\n * animations in your Phaser game. It is a singleton owned by the Game instance, meaning it persists\r\n * across all Scenes and is not tied to any single Scene's lifecycle.\r\n *\r\n * You create animations once via `this.anims.create()` (or `this.anims.createFromAseprite()` for\r\n * Aseprite exports), and those animations are then available to every Sprite or Game Object that has\r\n * an Animation Component, across every Scene.\r\n *\r\n * The Animation Manager handles frame sequencing, timing, and playback configuration. Individual\r\n * Game Objects each maintain their own playback state (current frame, repeat count, etc.) via their\r\n * AnimationState component, but the frame data and timing definitions live here.\r\n *\r\n * You can access the Animation Manager from any Scene via `this.anims`.\r\n *\r\n * @class AnimationManager\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Animations\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser.Game instance.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "classdesc": "The Animation Manager is a global system responsible for defining, storing, and managing all\ranimations in your Phaser game. It is a singleton owned by the Game instance, meaning it persists\racross all Scenes and is not tied to any single Scene's lifecycle.\r\rYou create animations once via `this.anims.create()` (or `this.anims.createFromAseprite()` for\rAseprite exports), and those animations are then available to every Sprite or Game Object that has\ran Animation Component, across every Scene.\r\rThe Animation Manager handles frame sequencing, timing, and playback configuration. Individual\rGame Objects each maintain their own playback state (current frame, repeat count, etc.) via their\rAnimationState component, but the frame data and timing definitions live here.\r\rYou can access the Animation Manager from any Scene via `this.anims`.", "kind": "class", "name": "AnimationManager", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Animations", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "A reference to the Phaser.Game instance.", "name": "game" } ], "scope": "static", "longname": "Phaser.Animations.AnimationManager", "___id": "T000002R000873", "___s": true }, { "comment": "/**\r\n * A reference to the Phaser.Game instance.\r\n *\r\n * @name Phaser.Animations.AnimationManager#game\r\n * @type {Phaser.Game}\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "A reference to the Phaser.Game instance.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "access": "protected", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#game", "scope": "instance", "kind": "member", "___id": "T000002R000877", "___s": true }, { "comment": "/**\r\n * A reference to the Texture Manager.\r\n *\r\n * @name Phaser.Animations.AnimationManager#textureManager\r\n * @type {Phaser.Textures.TextureManager}\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "A reference to the Texture Manager.", "name": "textureManager", "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "access": "protected", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#textureManager", "scope": "instance", "kind": "member", "___id": "T000002R000879", "___s": true }, { "comment": "/**\r\n * The global time scale of the Animation Manager.\r\n *\r\n * This scales the time delta between two frames, thus influencing the speed of time for the Animation Manager.\r\n *\r\n * @name Phaser.Animations.AnimationManager#globalTimeScale\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The global time scale of the Animation Manager.\r\rThis scales the time delta between two frames, thus influencing the speed of time for the Animation Manager.", "name": "globalTimeScale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#globalTimeScale", "scope": "instance", "kind": "member", "___id": "T000002R000881", "___s": true }, { "comment": "/**\r\n * The Animations registered in the Animation Manager.\r\n *\r\n * This map should be modified with the {@link #add} and {@link #create} methods of the Animation Manager.\r\n *\r\n * @name Phaser.Animations.AnimationManager#anims\r\n * @type {Phaser.Structs.Map.}\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The Animations registered in the Animation Manager.\r\rThis map should be modified with the {@link #add} and {@link #create} methods of the Animation Manager.", "name": "anims", "type": { "names": [ "Phaser.Structs.Map." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Map" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" } ] } }, "access": "protected", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#anims", "scope": "instance", "kind": "member", "___id": "T000002R000883", "___s": true }, { "comment": "/**\r\n * A list of animation mix times.\r\n *\r\n * See the {@link #setMix} method for more details.\r\n *\r\n * @name Phaser.Animations.AnimationManager#mixes\r\n * @type {Phaser.Structs.Map.}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "A list of animation mix times.\r\rSee the {@link #setMix} method for more details.", "name": "mixes", "type": { "names": [ "Phaser.Structs.Map." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Map" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" } ] } }, "since": "3.50.0", "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#mixes", "scope": "instance", "kind": "member", "___id": "T000002R000885", "___s": true }, { "comment": "/**\r\n * Whether the Animation Manager is paused along with all of its Animations.\r\n *\r\n * @name Phaser.Animations.AnimationManager#paused\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Whether the Animation Manager is paused along with all of its Animations.", "name": "paused", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#paused", "scope": "instance", "kind": "member", "___id": "T000002R000887", "___s": true }, { "comment": "/**\r\n * The name of this Animation Manager.\r\n *\r\n * @name Phaser.Animations.AnimationManager#name\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 118, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The name of this Animation Manager.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#name", "scope": "instance", "kind": "member", "___id": "T000002R000889", "___s": true }, { "comment": "/**\r\n * Registers event listeners after the Game boots.\r\n *\r\n * @method Phaser.Animations.AnimationManager#boot\r\n * @listens Phaser.Core.Events#DESTROY\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "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", "___id": "T000002R000891", "___s": true }, { "comment": "/**\r\n * Adds a mix between two animations.\r\n *\r\n * Mixing allows you to specify a unique delay between a pairing of animations.\r\n *\r\n * When playing Animation A on a Game Object, if you then play Animation B, and a\r\n * mix exists, it will wait for the specified delay to be over before playing Animation B.\r\n *\r\n * This allows you to customise smoothing between different types of animation, such\r\n * as blending between an idle and a walk state, or a running and a firing state.\r\n *\r\n * Note that mixing is only applied if you use the `Sprite.play` method. If you opt to use\r\n * `playAfterRepeat` or `playAfterDelay` instead, those will take priority and the mix\r\n * delay will not be used.\r\n *\r\n * To update an existing mix, just call this method with the new delay.\r\n *\r\n * To remove a mix pairing, see the `removeMix` method.\r\n *\r\n * @method Phaser.Animations.AnimationManager#addMix\r\n * @since 3.50.0\r\n *\r\n * @param {(string|Phaser.Animations.Animation)} animA - The string-based key, or instance of, Animation A.\r\n * @param {(string|Phaser.Animations.Animation)} animB - The string-based key, or instance of, Animation B.\r\n * @param {number} delay - The delay, in milliseconds, to wait when transitioning from Animation A to B.\r\n *\r\n * @return {this} This Animation Manager.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Adds a mix between two animations.\r\rMixing allows you to specify a unique delay between a pairing of animations.\r\rWhen playing Animation A on a Game Object, if you then play Animation B, and a\rmix exists, it will wait for the specified delay to be over before playing Animation B.\r\rThis allows you to customise smoothing between different types of animation, such\ras blending between an idle and a walk state, or a running and a firing state.\r\rNote that mixing is only applied if you use the `Sprite.play` method. If you opt to use\r`playAfterRepeat` or `playAfterDelay` instead, those will take priority and the mix\rdelay will not be used.\r\rTo update an existing mix, just call this method with the new delay.\r\rTo remove a mix pairing, see the `removeMix` method.", "kind": "function", "name": "addMix", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "Phaser.Animations.Animation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" } ] } }, "description": "The string-based key, or instance of, Animation A.", "name": "animA" }, { "type": { "names": [ "string", "Phaser.Animations.Animation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" } ] } }, "description": "The string-based key, or instance of, Animation B.", "name": "animB" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delay, in milliseconds, to wait when transitioning from Animation A to B.", "name": "delay" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Animation Manager." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#addMix", "scope": "instance", "___id": "T000002R000894", "___s": true }, { "comment": "/**\r\n * Removes a mix between two animations.\r\n *\r\n * Mixing allows you to specify a unique delay between a pairing of animations.\r\n *\r\n * Calling this method lets you remove those pairings. You can either remove\r\n * it between `animA` and `animB`, or if you do not provide the `animB` parameter,\r\n * it will remove all `animA` mixes.\r\n *\r\n * If you wish to update an existing mix instead, call the `addMix` method with the\r\n * new delay.\r\n *\r\n * @method Phaser.Animations.AnimationManager#removeMix\r\n * @since 3.50.0\r\n *\r\n * @param {(string|Phaser.Animations.Animation)} animA - The string-based key, or instance of, Animation A.\r\n * @param {(string|Phaser.Animations.Animation)} [animB] - The string-based key, or instance of, Animation B. If not given, all mixes for Animation A will be removed.\r\n *\r\n * @return {this} This Animation Manager.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 197, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Removes a mix between two animations.\r\rMixing allows you to specify a unique delay between a pairing of animations.\r\rCalling this method lets you remove those pairings. You can either remove\rit between `animA` and `animB`, or if you do not provide the `animB` parameter,\rit will remove all `animA` mixes.\r\rIf you wish to update an existing mix instead, call the `addMix` method with the\rnew delay.", "kind": "function", "name": "removeMix", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "Phaser.Animations.Animation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" } ] } }, "description": "The string-based key, or instance of, Animation A.", "name": "animA" }, { "type": { "names": [ "string", "Phaser.Animations.Animation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" } ] } }, "optional": true, "description": "The string-based key, or instance of, Animation B. If not given, all mixes for Animation A will be removed.", "name": "animB" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Animation Manager." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#removeMix", "scope": "instance", "___id": "T000002R000903", "___s": true }, { "comment": "/**\r\n * Returns the mix delay between two animations.\r\n *\r\n * If no mix has been set up, this method will return zero.\r\n *\r\n * If you wish to create, or update, a new mix, call the `addMix` method.\r\n * If you wish to remove a mix, call the `removeMix` method.\r\n *\r\n * @method Phaser.Animations.AnimationManager#getMix\r\n * @since 3.50.0\r\n *\r\n * @param {(string|Phaser.Animations.Animation)} animA - The string-based key, or instance of, Animation A.\r\n * @param {(string|Phaser.Animations.Animation)} animB - The string-based key, or instance of, Animation B.\r\n *\r\n * @return {number} The mix duration, or zero if no mix exists.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Returns the mix delay between two animations.\r\rIf no mix has been set up, this method will return zero.\r\rIf you wish to create, or update, a new mix, call the `addMix` method.\rIf you wish to remove a mix, call the `removeMix` method.", "kind": "function", "name": "getMix", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "Phaser.Animations.Animation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" } ] } }, "description": "The string-based key, or instance of, Animation A.", "name": "animA" }, { "type": { "names": [ "string", "Phaser.Animations.Animation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" } ] } }, "description": "The string-based key, or instance of, Animation B.", "name": "animB" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The mix duration, or zero if no mix exists." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#getMix", "scope": "instance", "___id": "T000002R000909", "___s": true }, { "comment": "/**\r\n * Adds an existing Animation to the Animation Manager.\r\n *\r\n * @method Phaser.Animations.AnimationManager#add\r\n * @fires Phaser.Animations.Events#ADD_ANIMATION\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key under which the Animation should be added. The Animation will be updated with it. Must be unique.\r\n * @param {Phaser.Animations.Animation} animation - The Animation which should be added to the Animation Manager.\r\n *\r\n * @return {this} This Animation Manager.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 282, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation" } }, "description": "The Animation which should be added to the Animation Manager.", "name": "animation" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Animation Manager." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#add", "scope": "instance", "___id": "T000002R000915", "___s": true }, { "comment": "/**\r\n * Checks to see if the given key is already in use within the Animation Manager or not.\r\n *\r\n * Animations are global. Keys created in one scene can be used from any other Scene in your game. They are not Scene specific.\r\n *\r\n * @method Phaser.Animations.AnimationManager#exists\r\n * @since 3.16.0\r\n *\r\n * @param {string} key - The key of the Animation to check.\r\n *\r\n * @return {boolean} `true` if the Animation already exists in the Animation Manager, or `false` if the key is available.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 312, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Checks to see if the given key is already in use within the Animation Manager or not.\r\rAnimations 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Animation to check.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R000918", "___s": true }, { "comment": "/**\r\n * Create one, or more animations from a loaded Aseprite JSON file.\r\n *\r\n * Aseprite is a powerful animated sprite editor and pixel art tool.\r\n *\r\n * You can find more details at https://www.aseprite.org/\r\n *\r\n * To export a compatible JSON file in Aseprite, please do the following:\r\n *\r\n * 1. Go to \"File - Export Sprite Sheet\"\r\n *\r\n * 2. On the **Layout** tab:\r\n * 2a. Set the \"Sheet type\" to \"Packed\"\r\n * 2b. Set the \"Constraints\" to \"None\"\r\n * 2c. Check the \"Merge Duplicates\" checkbox\r\n *\r\n * 3. On the **Sprite** tab:\r\n * 3a. Set \"Layers\" to \"Visible layers\"\r\n * 3b. Set \"Frames\" to \"All frames\", unless you only wish to export a sub-set of tags\r\n *\r\n * 4. On the **Borders** tab:\r\n * 4a. Check the \"Trim Sprite\" and \"Trim Cells\" options\r\n * 4b. Ensure \"Border Padding\", \"Spacing\" and \"Inner Padding\" are all > 0 (1 is usually enough)\r\n *\r\n * 5. On the **Output** tab:\r\n * 5a. Check \"Output File\", give your image a name and make sure you choose \"png files\" as the file type\r\n * 5b. Check \"JSON Data\" and give your json file a name\r\n * 5c. The JSON Data type can be either a Hash or Array, Phaser doesn't mind.\r\n * 5d. Make sure \"Tags\" is checked in the Meta options\r\n * 5e. In the \"Item Filename\" input box, make sure it says just \"{frame}\" and nothing more.\r\n *\r\n * 6. Click export\r\n *\r\n * This was tested with Aseprite 1.2.25.\r\n *\r\n * This will export a png and json file which you can load using the Aseprite Loader, i.e.:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.path = 'assets/animations/aseprite/';\r\n * this.load.aseprite('paladin', 'paladin.png', 'paladin.json');\r\n * }\r\n * ```\r\n *\r\n * Once loaded, you can call this method from within a Scene with the 'atlas' key:\r\n *\r\n * ```javascript\r\n * this.anims.createFromAseprite('paladin');\r\n * ```\r\n *\r\n * Any animations defined in the JSON will now be available to use in Phaser and you play them\r\n * via their Tag name. For example, if you have an animation called 'War Cry' on your Aseprite timeline,\r\n * you can play it in Phaser using that Tag name:\r\n *\r\n * ```javascript\r\n * this.add.sprite(400, 300).play('War Cry');\r\n * ```\r\n *\r\n * When calling this method you can optionally provide an array of tag names, and only those animations\r\n * will be created. For example:\r\n *\r\n * ```javascript\r\n * this.anims.createFromAseprite('paladin', [ 'step', 'War Cry', 'Magnum Break' ]);\r\n * ```\r\n *\r\n * This will only create the 3 animations defined. Note that the tag names are case-sensitive.\r\n *\r\n * @method Phaser.Animations.AnimationManager#createFromAseprite\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the loaded Aseprite atlas. It must have been loaded prior to calling this method.\r\n * @param {string[]} [tags] - An array of Tag names. If provided, only animations found in this array will be created.\r\n * @param {(Phaser.Animations.AnimationManager|Phaser.GameObjects.GameObject)} [target] - Create the animations on this target Sprite. If not given, they will be created globally in this Animation Manager.\r\n *\r\n * @return {Phaser.Animations.Animation[]} An array of Animation instances that were successfully created.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 329, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Create one, or more animations from a loaded Aseprite JSON file.\r\rAseprite is a powerful animated sprite editor and pixel art tool.\r\rYou can find more details at https://www.aseprite.org/\r\rTo export a compatible JSON file in Aseprite, please do the following:\r\r1. Go to \"File - Export Sprite Sheet\"\r\r2. On the **Layout** tab:\r2a. Set the \"Sheet type\" to \"Packed\"\r2b. Set the \"Constraints\" to \"None\"\r2c. Check the \"Merge Duplicates\" checkbox\r\r3. On the **Sprite** tab:\r3a. Set \"Layers\" to \"Visible layers\"\r3b. Set \"Frames\" to \"All frames\", unless you only wish to export a sub-set of tags\r\r4. On the **Borders** tab:\r4a. Check the \"Trim Sprite\" and \"Trim Cells\" options\r4b. Ensure \"Border Padding\", \"Spacing\" and \"Inner Padding\" are all > 0 (1 is usually enough)\r\r5. On the **Output** tab:\r5a. Check \"Output File\", give your image a name and make sure you choose \"png files\" as the file type\r5b. Check \"JSON Data\" and give your json file a name\r5c. The JSON Data type can be either a Hash or Array, Phaser doesn't mind.\r5d. Make sure \"Tags\" is checked in the Meta options\r5e. In the \"Item Filename\" input box, make sure it says just \"{frame}\" and nothing more.\r\r6. Click export\r\rThis was tested with Aseprite 1.2.25.\r\rThis will export a png and json file which you can load using the Aseprite Loader, i.e.:\r\r```javascript\rfunction preload ()\r{\r this.load.path = 'assets/animations/aseprite/';\r this.load.aseprite('paladin', 'paladin.png', 'paladin.json');\r}\r```\r\rOnce loaded, you can call this method from within a Scene with the 'atlas' key:\r\r```javascript\rthis.anims.createFromAseprite('paladin');\r```\r\rAny animations defined in the JSON will now be available to use in Phaser and you play them\rvia their Tag name. For example, if you have an animation called 'War Cry' on your Aseprite timeline,\ryou can play it in Phaser using that Tag name:\r\r```javascript\rthis.add.sprite(400, 300).play('War Cry');\r```\r\rWhen calling this method you can optionally provide an array of tag names, and only those animations\rwill be created. For example:\r\r```javascript\rthis.anims.createFromAseprite('paladin', [ 'step', 'War Cry', 'Magnum Break' ]);\r```\r\rThis will only create the 3 animations defined. Note that the tag names are case-sensitive.", "kind": "function", "name": "createFromAseprite", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the loaded Aseprite atlas. It must have been loaded prior to calling this method.", "name": "key" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of Tag names. If provided, only animations found in this array will be created.", "name": "tags" }, { "type": { "names": [ "Phaser.Animations.AnimationManager", "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Animations.AnimationManager" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "optional": true, "description": "Create the animations on this target Sprite. If not given, they will be created globally in this Animation Manager.", "name": "target" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Animations.Animation", "type": "NameExpression" } ] } }, "description": "An array of Animation instances that were successfully created." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#createFromAseprite", "scope": "instance", "___id": "T000002R000920", "___s": true }, { "comment": "/**\r\n * Creates a new Animation and adds it to the Animation Manager.\r\n *\r\n * Animations are global. Once created, you can use them in any Scene in your game. They are not Scene specific.\r\n *\r\n * If an invalid key is given this method will return `false`.\r\n *\r\n * If you pass the key of an animation that already exists in the Animation Manager, that animation will be returned.\r\n *\r\n * A brand new animation is only created if the key is valid and not already in use.\r\n *\r\n * If you wish to re-use an existing key, call `AnimationManager.remove` first, then this method.\r\n *\r\n * @method Phaser.Animations.AnimationManager#create\r\n * @fires Phaser.Animations.Events#ADD_ANIMATION\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Animations.Animation} config - The configuration settings for the Animation.\r\n *\r\n * @return {(Phaser.Animations.Animation|false)} The Animation that was created, or `false` if the key is already in use.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 498, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Creates a new Animation and adds it to the Animation Manager.\r\rAnimations are global. Once created, you can use them in any Scene in your game. They are not Scene specific.\r\rIf an invalid key is given this method will return `false`.\r\rIf you pass the key of an animation that already exists in the Animation Manager, that animation will be returned.\r\rA brand new animation is only created if the key is valid and not already in use.\r\rIf 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Animations.Animation" } }, "description": "The configuration settings for the Animation.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Animations.Animation", "false" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "false", "reservedWord": true } ] } }, "description": "The Animation that was created, or `false` if the key is already in use." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#create", "scope": "instance", "___id": "T000002R000951", "___s": true }, { "comment": "/**\r\n * Loads this Animation Manager's Animations and settings from a JSON object.\r\n *\r\n * @method Phaser.Animations.AnimationManager#fromJSON\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Animations.JSONAnimations|Phaser.Types.Animations.JSONAnimation)} data - The JSON object to parse.\r\n * @param {boolean} [clearCurrentAnimations=false] - If set to `true`, the current animations will be removed (`anims.clear()`). If set to `false` (default), the animations in `data` will be added.\r\n *\r\n * @return {Phaser.Animations.Animation[]} An array containing all of the Animation objects that were created as a result of this call.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 546, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.JSONAnimations" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.JSONAnimation" } ] } }, "description": "The JSON object to parse.", "name": "data" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Animations.Animation", "type": "NameExpression" } ] } }, "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", "___id": "T000002R000957", "___s": true }, { "comment": "/**\r\n * Generate an array of {@link Phaser.Types.Animations.AnimationFrame} objects from a texture key and configuration object.\r\n *\r\n * Generates objects with string based frame names, as configured by the given {@link Phaser.Types.Animations.GenerateFrameNames}.\r\n *\r\n * It's a helper method, designed to make it easier for you to extract all of the frame names from texture atlases.\r\n *\r\n * If you're working with a sprite sheet, see the `generateFrameNumbers` method instead.\r\n *\r\n * Example:\r\n *\r\n * If you have a texture atlases loaded called `gems` and it contains 6 frames called `ruby_0001`, `ruby_0002`, and so on,\r\n * then you can call this method using: `this.anims.generateFrameNames('gems', { prefix: 'ruby_', start: 1, end: 6, zeroPad: 4 })`.\r\n *\r\n * The `end` value tells it to select frames 1 through 6, incrementally numbered, all starting with the prefix `ruby_`. The `zeroPad`\r\n * value tells it how many zeroes pad out the numbers. To create an animation using this method, you can do:\r\n *\r\n * ```javascript\r\n * this.anims.create({\r\n * key: 'ruby',\r\n * repeat: -1,\r\n * frames: this.anims.generateFrameNames('gems', {\r\n * prefix: 'ruby_',\r\n * end: 6,\r\n * zeroPad: 4\r\n * })\r\n * });\r\n * ```\r\n *\r\n * Please see the animation examples for further details.\r\n *\r\n * @method Phaser.Animations.AnimationManager#generateFrameNames\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key for the texture containing the animation frames.\r\n * @param {Phaser.Types.Animations.GenerateFrameNames} [config] - The configuration object for the animation frame names.\r\n *\r\n * @return {Phaser.Types.Animations.AnimationFrame[]} The array of {@link Phaser.Types.Animations.AnimationFrame} objects.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 595, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Generate an array of {@link Phaser.Types.Animations.AnimationFrame} objects from a texture key and configuration object.\r\rGenerates objects with string based frame names, as configured by the given {@link Phaser.Types.Animations.GenerateFrameNames}.\r\rIt's a helper method, designed to make it easier for you to extract all of the frame names from texture atlases.\r\rIf you're working with a sprite sheet, see the `generateFrameNumbers` method instead.\r\rExample:\r\rIf you have a texture atlases loaded called `gems` and it contains 6 frames called `ruby_0001`, `ruby_0002`, and so on,\rthen you can call this method using: `this.anims.generateFrameNames('gems', { prefix: 'ruby_', start: 1, end: 6, zeroPad: 4 })`.\r\rThe `end` value tells it to select frames 1 through 6, incrementally numbered, all starting with the prefix `ruby_`. The `zeroPad`\rvalue tells it how many zeroes pad out the numbers. To create an animation using this method, you can do:\r\r```javascript\rthis.anims.create({\r key: 'ruby',\r repeat: -1,\r frames: this.anims.generateFrameNames('gems', {\r prefix: 'ruby_',\r end: 6,\r zeroPad: 4\r })\r});\r```\r\rPlease see the animation examples for further details.", "kind": "function", "name": "generateFrameNames", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key for the texture containing the animation frames.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Animations.GenerateFrameNames" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Animations.GenerateFrameNames" } }, "optional": true, "description": "The configuration object for the animation frame names.", "name": "config" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.AnimationFrame", "type": "NameExpression" } ] } }, "description": "The array of {@link Phaser.Types.Animations.AnimationFrame} objects." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#generateFrameNames", "scope": "instance", "___id": "T000002R000964", "___s": true }, { "comment": "/**\r\n * Generate an array of {@link Phaser.Types.Animations.AnimationFrame} objects from a texture key and configuration object.\r\n *\r\n * Generates objects with numbered frame names, as configured by the given {@link Phaser.Types.Animations.GenerateFrameNumbers}.\r\n *\r\n * If you're working with a texture atlas, see the `generateFrameNames` method instead.\r\n *\r\n * It's a helper method, designed to make it easier for you to extract frames from sprite sheets.\r\n *\r\n * Example:\r\n *\r\n * If you have a sprite sheet loaded called `explosion` and it contains 12 frames, then you can call this method using:\r\n *\r\n * `this.anims.generateFrameNumbers('explosion', { start: 0, end: 11 })`.\r\n *\r\n * The `end` value of 11 tells it to stop after the 12th frame has been added, because it started at zero.\r\n *\r\n * To create an animation using this method, you can do:\r\n *\r\n * ```javascript\r\n * this.anims.create({\r\n * key: 'boom',\r\n * frames: this.anims.generateFrameNumbers('explosion', {\r\n * start: 0,\r\n * end: 11\r\n * })\r\n * });\r\n * ```\r\n *\r\n * Note that `start` is optional and you don't need to include it if the animation starts from frame 0.\r\n *\r\n * To specify an animation in reverse, swap the `start` and `end` values.\r\n *\r\n * If the frames are not sequential, you may pass an array of frame numbers instead, for example:\r\n *\r\n * `this.anims.generateFrameNumbers('explosion', { frames: [ 0, 1, 2, 1, 2, 3, 4, 0, 1, 2 ] })`\r\n *\r\n * Please see the animation examples and `GenerateFrameNumbers` config docs for further details.\r\n *\r\n * @method Phaser.Animations.AnimationManager#generateFrameNumbers\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key for the texture containing the animation frames.\r\n * @param {Phaser.Types.Animations.GenerateFrameNumbers} [config] - The configuration object for the animation frames.\r\n *\r\n * @return {Phaser.Types.Animations.AnimationFrame[]} The array of {@link Phaser.Types.Animations.AnimationFrame} objects.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 695, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Generate an array of {@link Phaser.Types.Animations.AnimationFrame} objects from a texture key and configuration object.\r\rGenerates objects with numbered frame names, as configured by the given {@link Phaser.Types.Animations.GenerateFrameNumbers}.\r\rIf you're working with a texture atlas, see the `generateFrameNames` method instead.\r\rIt's a helper method, designed to make it easier for you to extract frames from sprite sheets.\r\rExample:\r\rIf you have a sprite sheet loaded called `explosion` and it contains 12 frames, then you can call this method using:\r\r`this.anims.generateFrameNumbers('explosion', { start: 0, end: 11 })`.\r\rThe `end` value of 11 tells it to stop after the 12th frame has been added, because it started at zero.\r\rTo create an animation using this method, you can do:\r\r```javascript\rthis.anims.create({\r key: 'boom',\r frames: this.anims.generateFrameNumbers('explosion', {\r start: 0,\r end: 11\r })\r});\r```\r\rNote that `start` is optional and you don't need to include it if the animation starts from frame 0.\r\rTo specify an animation in reverse, swap the `start` and `end` values.\r\rIf the frames are not sequential, you may pass an array of frame numbers instead, for example:\r\r`this.anims.generateFrameNumbers('explosion', { frames: [ 0, 1, 2, 1, 2, 3, 4, 0, 1, 2 ] })`\r\rPlease see the animation examples and `GenerateFrameNumbers` config docs for further details.", "kind": "function", "name": "generateFrameNumbers", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key for the texture containing the animation frames.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Animations.GenerateFrameNumbers" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Animations.GenerateFrameNumbers" } }, "optional": true, "description": "The configuration object for the animation frames.", "name": "config" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.AnimationFrame", "type": "NameExpression" } ] } }, "description": "The array of {@link Phaser.Types.Animations.AnimationFrame} objects." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#generateFrameNumbers", "scope": "instance", "___id": "T000002R000984", "___s": true }, { "comment": "/**\r\n * Retrieves an Animation from the Animation Manager by its key.\r\n *\r\n * Returns `undefined` if no Animation with the given key exists.\r\n *\r\n * @method Phaser.Animations.AnimationManager#get\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key of the Animation to retrieve.\r\n *\r\n * @return {Phaser.Animations.Animation} The Animation.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 799, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Retrieves an Animation from the Animation Manager by its key.\r\rReturns `undefined` if no Animation with the given key exists.", "kind": "function", "name": "get", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Animation to retrieve.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation" } }, "description": "The Animation." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#get", "scope": "instance", "___id": "T000002R001000", "___s": true }, { "comment": "/**\r\n * Returns an array of all Animation keys that are using the given\r\n * Texture. Only Animations that have at least one AnimationFrame\r\n * entry using this texture will be included in the result.\r\n *\r\n * @method Phaser.Animations.AnimationManager#getAnimsFromTexture\r\n * @since 3.60.0\r\n *\r\n * @param {(string|Phaser.Textures.Texture|Phaser.Textures.Frame)} key - The unique string-based key of the Texture, or a Texture, or Frame instance.\r\n *\r\n * @return {string[]} An array of Animation keys that feature the given Texture.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 816, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Returns an array of all Animation keys that are using the given\rTexture. Only Animations that have at least one AnimationFrame\rentry using this texture will be included in the result.", "kind": "function", "name": "getAnimsFromTexture", "since": "3.60.0", "params": [ { "type": { "names": [ "string", "Phaser.Textures.Texture", "Phaser.Textures.Frame" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" }, { "type": "NameExpression", "name": "Phaser.Textures.Frame" } ] } }, "description": "The unique string-based key of the Texture, or a Texture, or Frame instance.", "name": "key" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "An array of Animation keys that feature the given Texture." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#getAnimsFromTexture", "scope": "instance", "___id": "T000002R001002", "___s": true }, { "comment": "/**\r\n * Pauses all animations in the Animation Manager by setting the `paused` flag to `true`.\r\n * This affects all Game Objects that are playing animations globally. Has no effect if\r\n * the Animation Manager is already paused.\r\n *\r\n * @method Phaser.Animations.AnimationManager#pauseAll\r\n * @fires Phaser.Animations.Events#PAUSE_ALL\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Animation Manager.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 856, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Pauses all animations in the Animation Manager by setting the `paused` flag to `true`.\rThis affects all Game Objects that are playing animations globally. Has no effect if\rthe Animation Manager is already paused.", "kind": "function", "name": "pauseAll", "fires": [ "Phaser.Animations.Events#event:PAUSE_ALL" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Animation Manager." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#pauseAll", "scope": "instance", "___id": "T000002R001012", "___s": true }, { "comment": "/**\r\n * Play an animation on the given Game Objects that have an Animation Component.\r\n *\r\n * @method Phaser.Animations.AnimationManager#play\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig)} key - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.\r\n * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} children - An array of Game Objects to play the animation on. They must have an Animation Component.\r\n *\r\n * @return {this} This Animation Manager.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 879, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "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", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ] } }, "description": "The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.", "name": "key" }, { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects to play the animation on. They must have an Animation Component.", "name": "children" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Animation Manager." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#play", "scope": "instance", "___id": "T000002R001015", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects that have an Animation Component and then\r\n * starts the given animation playing on them. The start time of each Game Object\r\n * is offset, incrementally, by the `stagger` amount.\r\n *\r\n * For example, if you pass an array with 4 children and a stagger time of 1000,\r\n * the delays will be:\r\n *\r\n * child 1: 1000ms delay\r\n * child 2: 2000ms delay\r\n * child 3: 3000ms delay\r\n * child 4: 4000ms delay\r\n *\r\n * If you set the `staggerFirst` parameter to `false` they would be:\r\n *\r\n * child 1: 0ms delay\r\n * child 2: 1000ms delay\r\n * child 3: 2000ms delay\r\n * child 4: 3000ms delay\r\n *\r\n * You can also set `stagger` to be a negative value. If it was -1000, the above would be:\r\n *\r\n * child 1: 3000ms delay\r\n * child 2: 2000ms delay\r\n * child 3: 1000ms delay\r\n * child 4: 0ms delay\r\n *\r\n * @method Phaser.Animations.AnimationManager#staggerPlay\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [items,$return]\r\n *\r\n * @param {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig)} key - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.\r\n * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} children - An array of Game Objects to play the animation on. They must have an Animation Component.\r\n * @param {number} stagger - The amount of time, in milliseconds, to offset each play time by. If a negative value is given, it's applied to the children in reverse order.\r\n * @param {boolean} [staggerFirst=true] - Should the first child be staggered as well?\r\n *\r\n * @return {this} This Animation Manager.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 905, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Takes an array of Game Objects that have an Animation Component and then\rstarts the given animation playing on them. The start time of each Game Object\ris offset, incrementally, by the `stagger` amount.\r\rFor example, if you pass an array with 4 children and a stagger time of 1000,\rthe delays will be:\r\rchild 1: 1000ms delay\rchild 2: 2000ms delay\rchild 3: 3000ms delay\rchild 4: 4000ms delay\r\rIf you set the `staggerFirst` parameter to `false` they would be:\r\rchild 1: 0ms delay\rchild 2: 1000ms delay\rchild 3: 2000ms delay\rchild 4: 3000ms delay\r\rYou can also set `stagger` to be a negative value. If it was -1000, the above would be:\r\rchild 1: 3000ms delay\rchild 2: 2000ms delay\rchild 3: 1000ms delay\rchild 4: 0ms delay", "kind": "function", "name": "staggerPlay", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [items,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [items,$return]" } ], "params": [ { "type": { "names": [ "string", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ] } }, "description": "The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.", "name": "key" }, { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects to play the animation on. They must have an Animation Component.", "name": "children" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of time, in milliseconds, to offset each play time by. If a negative value is given, it's applied to the children in reverse order.", "name": "stagger" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the first child be staggered as well?", "name": "staggerFirst" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Animation Manager." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#staggerPlay", "scope": "instance", "___id": "T000002R001019", "___s": true }, { "comment": "/**\r\n * Removes an Animation from this Animation Manager, based on the given key.\r\n *\r\n * This is a global action. Once an Animation has been removed, no Game Objects\r\n * can carry on using it.\r\n *\r\n * @method Phaser.Animations.AnimationManager#remove\r\n * @fires Phaser.Animations.Events#REMOVE_ANIMATION\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key of the animation to remove.\r\n *\r\n * @return {Phaser.Animations.Animation} The Animation instance that was removed from the Animation Manager.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 971, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Removes an Animation from this Animation Manager, based on the given key.\r\rThis is a global action. Once an Animation has been removed, no Game Objects\rcan carry on using it.", "kind": "function", "name": "remove", "fires": [ "Phaser.Animations.Events#event:REMOVE_ANIMATION" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the animation to remove.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation" } }, "description": "The Animation instance that was removed from the Animation Manager." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#remove", "scope": "instance", "___id": "T000002R001027", "___s": true }, { "comment": "/**\r\n * Resumes all paused animations in the Animation Manager by setting the `paused` flag to `false`.\r\n * Has no effect if the Animation Manager is not currently paused.\r\n *\r\n * @method Phaser.Animations.AnimationManager#resumeAll\r\n * @fires Phaser.Animations.Events#RESUME_ALL\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Animation Manager.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 1001, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Resumes all paused animations in the Animation Manager by setting the `paused` flag to `false`.\rHas no effect if the Animation Manager is not currently paused.", "kind": "function", "name": "resumeAll", "fires": [ "Phaser.Animations.Events#event:RESUME_ALL" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Animation Manager." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#resumeAll", "scope": "instance", "___id": "T000002R001030", "___s": true }, { "comment": "/**\r\n * Returns the Animation data as JavaScript object based on the given key.\r\n * Or, if no key is defined, it will return the data of all animations as array of objects.\r\n *\r\n * @method Phaser.Animations.AnimationManager#toJSON\r\n * @since 3.0.0\r\n *\r\n * @param {string} [key] - The animation to get the JSONAnimation data from. If not provided, all animations are returned as an array.\r\n *\r\n * @return {Phaser.Types.Animations.JSONAnimations} The resulting JSONAnimations formatted object.\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 1023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Returns the Animation data as JavaScript object based on the given key.\rOr, if no key is defined, it will return the data of all animations as array of objects.", "kind": "function", "name": "toJSON", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The animation to get the JSONAnimation data from. If not provided, all animations are returned as an array.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Animations.JSONAnimations" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Animations.JSONAnimations" } }, "description": "The resulting JSONAnimations formatted object." } ], "memberof": "Phaser.Animations.AnimationManager", "longname": "Phaser.Animations.AnimationManager#toJSON", "scope": "instance", "___id": "T000002R001033", "___s": true }, { "comment": "/**\r\n * Destroy this Animation Manager and clean up animation definitions and references to other objects.\r\n * This method should not be called directly. It will be called automatically as a response to a `destroy` event from the Phaser.Game instance.\r\n *\r\n * @method Phaser.Animations.AnimationManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationManager.js", "lineno": 1056, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Destroy this Animation Manager and clean up animation definitions and references to other objects.\rThis 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", "___id": "T000002R001038", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Animation State Component.\r\n *\r\n * This component provides features to apply animations to Game Objects. It is responsible for\r\n * loading, queuing animations for later playback, mixing between animations and setting\r\n * the current animation frame to the Game Object that owns this component.\r\n *\r\n * This component lives as an instance within any Game Object that has it defined, such as Sprites.\r\n *\r\n * You can access its properties and methods via the `anims` property, i.e. `Sprite.anims`.\r\n *\r\n * As well as playing animations stored in the global Animation Manager, this component\r\n * can also create animations that are stored locally within it. See the `create` method\r\n * for more details.\r\n *\r\n * Prior to Phaser 3.50 this component was called just `Animation` and lived in the\r\n * `Phaser.GameObjects.Components` namespace. It was renamed to `AnimationState`\r\n * in 3.50 to help better identify its true purpose when browsing the documentation.\r\n *\r\n * @class AnimationState\r\n * @memberof Phaser.Animations\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} parent - The Game Object to which this animation component belongs.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "classdesc": "The Animation State Component.\r\rThis component provides features to apply animations to Game Objects. It is responsible for\rloading, queuing animations for later playback, mixing between animations and setting\rthe current animation frame to the Game Object that owns this component.\r\rThis component lives as an instance within any Game Object that has it defined, such as Sprites.\r\rYou can access its properties and methods via the `anims` property, i.e. `Sprite.anims`.\r\rAs well as playing animations stored in the global Animation Manager, this component\rcan also create animations that are stored locally within it. See the `create` method\rfor more details.\r\rPrior to Phaser 3.50 this component was called just `Animation` and lived in the\r`Phaser.GameObjects.Components` namespace. It was renamed to `AnimationState`\rin 3.50 to help better identify its true purpose when browsing the documentation.", "kind": "class", "name": "AnimationState", "memberof": "Phaser.Animations", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to which this animation component belongs.", "name": "parent" } ], "scope": "static", "longname": "Phaser.Animations.AnimationState", "___id": "T000002R001049", "___s": true }, { "comment": "/**\r\n * The Game Object to which this animation component belongs.\r\n *\r\n * You can typically access this component from the Game Object\r\n * via the `this.anims` property.\r\n *\r\n * @name Phaser.Animations.AnimationState#parent\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The Game Object to which this animation component belongs.\r\rYou can typically access this component from the Game Object\rvia the `this.anims` property.", "name": "parent", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#parent", "scope": "instance", "kind": "member", "___id": "T000002R001052", "___s": true }, { "comment": "/**\r\n * A reference to the global Animation Manager.\r\n *\r\n * @name Phaser.Animations.AnimationState#animationManager\r\n * @type {Phaser.Animations.AnimationManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "A reference to the global Animation Manager.", "name": "animationManager", "type": { "names": [ "Phaser.Animations.AnimationManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationManager" } }, "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#animationManager", "scope": "instance", "kind": "member", "___id": "T000002R001054", "___s": true }, { "comment": "/**\r\n * A reference to the Texture Manager.\r\n *\r\n * @name Phaser.Animations.AnimationState#textureManager\r\n * @type {Phaser.Textures.TextureManager}\r\n * @protected\r\n * @since 3.50.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "A reference to the Texture Manager.", "name": "textureManager", "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "access": "protected", "since": "3.50.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#textureManager", "scope": "instance", "kind": "member", "___id": "T000002R001056", "___s": true }, { "comment": "/**\r\n * The Animations stored locally in this Animation component.\r\n *\r\n * Do not modify the contents of this Map directly, instead use the\r\n * `add`, `create` and `remove` methods of this class instead.\r\n *\r\n * @name Phaser.Animations.AnimationState#anims\r\n * @type {Phaser.Structs.Map.}\r\n * @protected\r\n * @since 3.50.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The Animations stored locally in this Animation component.\r\rDo not modify the contents of this Map directly, instead use the\r`add`, `create` and `remove` methods of this class instead.", "name": "anims", "type": { "names": [ "Phaser.Structs.Map." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Map" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" } ] } }, "access": "protected", "since": "3.50.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#anims", "scope": "instance", "kind": "member", "___id": "T000002R001058", "___s": true }, { "comment": "/**\r\n * Is an animation currently playing or not?\r\n *\r\n * @name Phaser.Animations.AnimationState#isPlaying\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Is an animation currently playing or not?", "name": "isPlaying", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#isPlaying", "scope": "instance", "kind": "member", "___id": "T000002R001060", "___s": true }, { "comment": "/**\r\n * Has the current animation started playing, or is it waiting for a delay to expire?\r\n *\r\n * @name Phaser.Animations.AnimationState#hasStarted\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.50.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 103, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Has the current animation started playing, or is it waiting for a delay to expire?", "name": "hasStarted", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.50.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#hasStarted", "scope": "instance", "kind": "member", "___id": "T000002R001062", "___s": true }, { "comment": "/**\r\n * The current Animation loaded into this Animation component.\r\n *\r\n * Will be `null` if no animation is yet loaded.\r\n *\r\n * @name Phaser.Animations.AnimationState#currentAnim\r\n * @type {?Phaser.Animations.Animation}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The current Animation loaded into this Animation component.\r\rWill be `null` if no animation is yet loaded.", "name": "currentAnim", "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#currentAnim", "scope": "instance", "kind": "member", "___id": "T000002R001064", "___s": true }, { "comment": "/**\r\n * The current AnimationFrame being displayed by this Animation component.\r\n *\r\n * Will be `null` if no animation is yet loaded.\r\n *\r\n * @name Phaser.Animations.AnimationState#currentFrame\r\n * @type {?Phaser.Animations.AnimationFrame}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The current AnimationFrame being displayed by this Animation component.\r\rWill be `null` if no animation is yet loaded.", "name": "currentFrame", "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#currentFrame", "scope": "instance", "kind": "member", "___id": "T000002R001066", "___s": true }, { "comment": "/**\r\n * The key, instance, or config of the next Animation to be loaded into this Animation component\r\n * when the current animation completes.\r\n *\r\n * Will be `null` if no animation has been queued.\r\n *\r\n * @name Phaser.Animations.AnimationState#nextAnim\r\n * @type {?(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig)}\r\n * @default null\r\n * @since 3.16.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 137, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The key, instance, or config of the next Animation to be loaded into this Animation component\rwhen the current animation completes.\r\rWill be `null` if no animation has been queued.", "name": "nextAnim", "type": { "names": [ "string", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ], "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.16.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#nextAnim", "scope": "instance", "kind": "member", "___id": "T000002R001068", "___s": true }, { "comment": "/**\r\n * A queue of Animations to be loaded into this Animation component when the current animation completes.\r\n *\r\n * Populate this queue via the `chain` method.\r\n *\r\n * @name Phaser.Animations.AnimationState#nextAnimsQueue\r\n * @type {array}\r\n * @since 3.24.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "A queue of Animations to be loaded into this Animation component when the current animation completes.\r\rPopulate this queue via the `chain` method.", "name": "nextAnimsQueue", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "since": "3.24.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#nextAnimsQueue", "scope": "instance", "kind": "member", "___id": "T000002R001070", "___s": true }, { "comment": "/**\r\n * The Time Scale factor.\r\n *\r\n * You can adjust this value to modify the passage of time for the animation that is currently\r\n * playing. For example, setting it to 2 will make the animation play twice as fast. Or setting\r\n * it to 0.5 will slow the animation down.\r\n *\r\n * You can change this value at run-time, or set it via the `PlayAnimationConfig`.\r\n *\r\n * Prior to Phaser 3.50 this property was private and called `_timeScale`.\r\n *\r\n * @name Phaser.Animations.AnimationState#timeScale\r\n * @type {number}\r\n * @default 1\r\n * @since 3.50.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The Time Scale factor.\r\rYou can adjust this value to modify the passage of time for the animation that is currently\rplaying. For example, setting it to 2 will make the animation play twice as fast. Or setting\rit to 0.5 will slow the animation down.\r\rYou can change this value at run-time, or set it via the `PlayAnimationConfig`.\r\rPrior to Phaser 3.50 this property was private and called `_timeScale`.", "name": "timeScale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.50.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#timeScale", "scope": "instance", "kind": "member", "___id": "T000002R001072", "___s": true }, { "comment": "/**\r\n * The frame rate of playback, of the current animation, in frames per second.\r\n *\r\n * This value is set when a new animation is loaded into this component and should\r\n * be treated as read-only, as changing it once playback has started will not alter\r\n * the animation. To change the frame rate, provide a new value in the `PlayAnimationConfig` object.\r\n *\r\n * @name Phaser.Animations.AnimationState#frameRate\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The frame rate of playback, of the current animation, in frames per second.\r\rThis value is set when a new animation is loaded into this component and should\rbe treated as read-only, as changing it once playback has started will not alter\rthe animation. To change the frame rate, provide a new value in the `PlayAnimationConfig` object.", "name": "frameRate", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#frameRate", "scope": "instance", "kind": "member", "___id": "T000002R001074", "___s": true }, { "comment": "/**\r\n * The duration of the current animation, in milliseconds.\r\n *\r\n * This value is set when a new animation is loaded into this component and should\r\n * be treated as read-only, as changing it once playback has started will not alter\r\n * the animation. To change the duration, provide a new value in the `PlayAnimationConfig` object.\r\n *\r\n * @name Phaser.Animations.AnimationState#duration\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 193, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The duration of the current animation, in milliseconds.\r\rThis value is set when a new animation is loaded into this component and should\rbe treated as read-only, as changing it once playback has started will not alter\rthe animation. To change the duration, provide a new value in the `PlayAnimationConfig` object.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#duration", "scope": "instance", "kind": "member", "___id": "T000002R001076", "___s": true }, { "comment": "/**\r\n * The number of milliseconds per frame, not including frame specific modifiers that may be present in the\r\n * Animation data.\r\n *\r\n * This value is calculated when a new animation is loaded into this component and should\r\n * be treated as read-only. Changing it will not alter playback speed.\r\n *\r\n * @name Phaser.Animations.AnimationState#msPerFrame\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The number of milliseconds per frame, not including frame specific modifiers that may be present in the\rAnimation data.\r\rThis value is calculated when a new animation is loaded into this component and should\rbe treated as read-only. Changing it will not alter playback speed.", "name": "msPerFrame", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#msPerFrame", "scope": "instance", "kind": "member", "___id": "T000002R001078", "___s": true }, { "comment": "/**\r\n * Skip frames if the time lags, or always advanced anyway?\r\n *\r\n * @name Phaser.Animations.AnimationState#skipMissedFrames\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 221, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Skip frames if the time lags, or always advanced anyway?", "name": "skipMissedFrames", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#skipMissedFrames", "scope": "instance", "kind": "member", "___id": "T000002R001080", "___s": true }, { "comment": "/**\r\n * Start playback of this animation from a random frame?\r\n *\r\n * @name Phaser.Animations.AnimationState#randomFrame\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 231, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Start playback of this animation from a random frame?", "name": "randomFrame", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#randomFrame", "scope": "instance", "kind": "member", "___id": "T000002R001082", "___s": true }, { "comment": "/**\r\n * The delay before starting playback of the current animation, in milliseconds.\r\n *\r\n * This value is set when a new animation is loaded into this component and should\r\n * be treated as read-only, as changing it once playback has started will not alter\r\n * the animation. To change the delay, provide a new value in the `PlayAnimationConfig` object.\r\n *\r\n * Prior to Phaser 3.50 this property was private and called `_delay`.\r\n *\r\n * @name Phaser.Animations.AnimationState#delay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.50.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 241, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The delay before starting playback of the current animation, in milliseconds.\r\rThis value is set when a new animation is loaded into this component and should\rbe treated as read-only, as changing it once playback has started will not alter\rthe animation. To change the delay, provide a new value in the `PlayAnimationConfig` object.\r\rPrior to Phaser 3.50 this property was private and called `_delay`.", "name": "delay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.50.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#delay", "scope": "instance", "kind": "member", "___id": "T000002R001084", "___s": true }, { "comment": "/**\r\n * The number of times to repeat playback of the current animation.\r\n *\r\n * If -1, it means the animation will repeat forever.\r\n *\r\n * This value is set when a new animation is loaded into this component and should\r\n * be treated as read-only, as changing it once playback has started will not alter\r\n * the animation. To change the number of repeats, provide a new value in the `PlayAnimationConfig` object.\r\n *\r\n * Prior to Phaser 3.50 this property was private and called `_repeat`.\r\n *\r\n * @name Phaser.Animations.AnimationState#repeat\r\n * @type {number}\r\n * @default 0\r\n * @since 3.50.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 257, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The number of times to repeat playback of the current animation.\r\rIf -1, it means the animation will repeat forever.\r\rThis value is set when a new animation is loaded into this component and should\rbe treated as read-only, as changing it once playback has started will not alter\rthe animation. To change the number of repeats, provide a new value in the `PlayAnimationConfig` object.\r\rPrior to Phaser 3.50 this property was private and called `_repeat`.", "name": "repeat", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.50.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#repeat", "scope": "instance", "kind": "member", "___id": "T000002R001086", "___s": true }, { "comment": "/**\r\n * The number of milliseconds to wait before starting the repeat playback of the current animation.\r\n *\r\n * This value is set when a new animation is loaded into this component, but can also be modified\r\n * at run-time.\r\n *\r\n * You can change the repeat delay by providing a new value in the `PlayAnimationConfig` object.\r\n *\r\n * Prior to Phaser 3.50 this property was private and called `_repeatDelay`.\r\n *\r\n * @name Phaser.Animations.AnimationState#repeatDelay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 275, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The number of milliseconds to wait before starting the repeat playback of the current animation.\r\rThis value is set when a new animation is loaded into this component, but can also be modified\rat run-time.\r\rYou can change the repeat delay by providing a new value in the `PlayAnimationConfig` object.\r\rPrior to Phaser 3.50 this property was private and called `_repeatDelay`.", "name": "repeatDelay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#repeatDelay", "scope": "instance", "kind": "member", "___id": "T000002R001088", "___s": true }, { "comment": "/**\r\n * Should the current animation yoyo? An animation that yoyos will play in reverse, from the end\r\n * to the start, before then repeating or completing. An animation that does not yoyo will just\r\n * play from the start to the end.\r\n *\r\n * This value is set when a new animation is loaded into this component, but can also be modified\r\n * at run-time.\r\n *\r\n * You can change the yoyo by providing a new value in the `PlayAnimationConfig` object.\r\n *\r\n * Prior to Phaser 3.50 this property was private and called `_yoyo`.\r\n *\r\n * @name Phaser.Animations.AnimationState#yoyo\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.50.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 292, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Should the current animation yoyo? An animation that yoyos will play in reverse, from the end\rto the start, before then repeating or completing. An animation that does not yoyo will just\rplay from the start to the end.\r\rThis value is set when a new animation is loaded into this component, but can also be modified\rat run-time.\r\rYou can change the yoyo by providing a new value in the `PlayAnimationConfig` object.\r\rPrior to Phaser 3.50 this property was private and called `_yoyo`.", "name": "yoyo", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.50.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#yoyo", "scope": "instance", "kind": "member", "___id": "T000002R001090", "___s": true }, { "comment": "/**\r\n * If the animation has a delay set, before playback will begin, this\r\n * controls when the first frame is set on the Sprite. If this property\r\n * is 'false' then the frame is set only after the delay has expired.\r\n * This is the default behavior.\r\n *\r\n * If this property is 'true' then the first frame of this animation\r\n * is set immediately, and then when the delay expires, playback starts.\r\n *\r\n * @name Phaser.Animations.AnimationState#showBeforeDelay\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 311, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "If the animation has a delay set, before playback will begin, this\rcontrols when the first frame is set on the Sprite. If this property\ris 'false' then the frame is set only after the delay has expired.\rThis is the default behavior.\r\rIf this property is 'true' then the first frame of this animation\ris set immediately, and then when the delay expires, playback starts.", "name": "showBeforeDelay", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#showBeforeDelay", "scope": "instance", "kind": "member", "___id": "T000002R001092", "___s": true }, { "comment": "/**\r\n * Should the GameObject's `visible` property be set to `true` when the animation starts to play?\r\n *\r\n * This will happen _after_ any delay that may have been set.\r\n *\r\n * This value is set when a new animation is loaded into this component, but can also be modified\r\n * at run-time, assuming the animation is currently delayed.\r\n *\r\n * @name Phaser.Animations.AnimationState#showOnStart\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 326, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Should the GameObject's `visible` property be set to `true` when the animation starts to play?\r\rThis will happen _after_ any delay that may have been set.\r\rThis value is set when a new animation is loaded into this component, but can also be modified\rat run-time, assuming the animation is currently delayed.", "name": "showOnStart", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#showOnStart", "scope": "instance", "kind": "member", "___id": "T000002R001094", "___s": true }, { "comment": "/**\r\n * Should the GameObject's `visible` property be set to `false` when the animation completes?\r\n *\r\n * This value is set when a new animation is loaded into this component, but can also be modified\r\n * at run-time, assuming the animation is still actively playing.\r\n *\r\n * @name Phaser.Animations.AnimationState#hideOnComplete\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 340, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Should the GameObject's `visible` property be set to `false` when the animation completes?\r\rThis value is set when a new animation is loaded into this component, but can also be modified\rat run-time, assuming the animation is still actively playing.", "name": "hideOnComplete", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#hideOnComplete", "scope": "instance", "kind": "member", "___id": "T000002R001096", "___s": true }, { "comment": "/**\r\n * Is the playhead moving forwards (`true`) or in reverse (`false`) ?\r\n *\r\n * @name Phaser.Animations.AnimationState#forward\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 352, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Is the playhead moving forwards (`true`) or in reverse (`false`) ?", "name": "forward", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#forward", "scope": "instance", "kind": "member", "___id": "T000002R001098", "___s": true }, { "comment": "/**\r\n * An internal trigger that tells the component if it should plays the animation\r\n * in reverse mode ('true') or not ('false'). This is used because `forward` can\r\n * be changed by the `yoyo` feature.\r\n *\r\n * Prior to Phaser 3.50 this property was private and called `_reverse`.\r\n *\r\n * @name Phaser.Animations.AnimationState#inReverse\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.50.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 362, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "An internal trigger that tells the component if it should plays the animation\rin reverse mode ('true') or not ('false'). This is used because `forward` can\rbe changed by the `yoyo` feature.\r\rPrior to Phaser 3.50 this property was private and called `_reverse`.", "name": "inReverse", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.50.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#inReverse", "scope": "instance", "kind": "member", "___id": "T000002R001100", "___s": true }, { "comment": "/**\r\n * Internal time overflow accumulator.\r\n *\r\n * This has the `delta` time added to it as part of the `update` step.\r\n *\r\n * @name Phaser.Animations.AnimationState#accumulator\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 376, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Internal time overflow accumulator.\r\rThis has the `delta` time added to it as part of the `update` step.", "name": "accumulator", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#accumulator", "scope": "instance", "kind": "member", "___id": "T000002R001102", "___s": true }, { "comment": "/**\r\n * The time point at which the next animation frame will change.\r\n *\r\n * This value is compared against the `accumulator` as part of the `update` step.\r\n *\r\n * @name Phaser.Animations.AnimationState#nextTick\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 388, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The time point at which the next animation frame will change.\r\rThis value is compared against the `accumulator` as part of the `update` step.", "name": "nextTick", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#nextTick", "scope": "instance", "kind": "member", "___id": "T000002R001104", "___s": true }, { "comment": "/**\r\n * A counter keeping track of how much delay time, in milliseconds, is left before playback begins.\r\n *\r\n * This is set via the `playAfterDelay` method, although it can be modified at run-time\r\n * if required, as long as the animation has not already started playing.\r\n *\r\n * @name Phaser.Animations.AnimationState#delayCounter\r\n * @type {number}\r\n * @default 0\r\n * @since 3.50.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 400, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "A counter keeping track of how much delay time, in milliseconds, is left before playback begins.\r\rThis is set via the `playAfterDelay` method, although it can be modified at run-time\rif required, as long as the animation has not already started playing.", "name": "delayCounter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.50.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#delayCounter", "scope": "instance", "kind": "member", "___id": "T000002R001106", "___s": true }, { "comment": "/**\r\n * A counter that keeps track of how many repeats are left to run.\r\n *\r\n * This value is set when a new animation is loaded into this component, but can also be modified\r\n * at run-time.\r\n *\r\n * @name Phaser.Animations.AnimationState#repeatCounter\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 413, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "A counter that keeps track of how many repeats are left to run.\r\rThis value is set when a new animation is loaded into this component, but can also be modified\rat run-time.", "name": "repeatCounter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#repeatCounter", "scope": "instance", "kind": "member", "___id": "T000002R001108", "___s": true }, { "comment": "/**\r\n * An internal flag keeping track of pending repeats.\r\n *\r\n * @name Phaser.Animations.AnimationState#pendingRepeat\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 426, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "An internal flag keeping track of pending repeats.", "name": "pendingRepeat", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#pendingRepeat", "scope": "instance", "kind": "member", "___id": "T000002R001110", "___s": true }, { "comment": "/**\r\n * Sets an animation, or an array of animations, to be played in the future, after the current one completes or stops.\r\n *\r\n * The current animation must enter a 'completed' state for this to happen, i.e. finish all of its repeats, delays, etc,\r\n * or have one of the `stop` methods called.\r\n *\r\n * An animation set to repeat forever will never enter a completed state unless stopped.\r\n *\r\n * You can chain a new animation at any point, including before the current one starts playing, during it, or when it ends (via its `animationcomplete` event).\r\n *\r\n * Chained animations are specific to a Game Object, meaning different Game Objects can have different chained animations without impacting the global animation they're playing.\r\n *\r\n * Call this method with no arguments to reset all currently chained animations.\r\n *\r\n * @method Phaser.Animations.AnimationState#chain\r\n * @since 3.16.0\r\n *\r\n * @param {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig|string[]|Phaser.Animations.Animation[]|Phaser.Types.Animations.PlayAnimationConfig[])} [key] - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object, or an array of them.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 484, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Sets an animation, or an array of animations, to be played in the future, after the current one completes or stops.\r\rThe current animation must enter a 'completed' state for this to happen, i.e. finish all of its repeats, delays, etc,\ror have one of the `stop` methods called.\r\rAn animation set to repeat forever will never enter a completed state unless stopped.\r\rYou can chain a new animation at any point, including before the current one starts playing, during it, or when it ends (via its `animationcomplete` event).\r\rChained animations are specific to a Game Object, meaning different Game Objects can have different chained animations without impacting the global animation they're playing.\r\rCall this method with no arguments to reset all currently chained animations.", "kind": "function", "name": "chain", "since": "3.16.0", "params": [ { "type": { "names": [ "string", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig", "Array.", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Animations.Animation", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.PlayAnimationConfig", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object, or an array of them.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#chain", "scope": "instance", "___id": "T000002R001120", "___s": true }, { "comment": "/**\r\n * Returns the key of the animation currently loaded into this component.\r\n *\r\n * Prior to Phaser 3.50 this method was called `getCurrentKey`.\r\n *\r\n * @method Phaser.Animations.AnimationState#getName\r\n * @since 3.50.0\r\n *\r\n * @return {string} The key of the Animation currently loaded into this component, or an empty string if none loaded.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 539, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Returns the key of the animation currently loaded into this component.\r\rPrior to Phaser 3.50 this method was called `getCurrentKey`.", "kind": "function", "name": "getName", "since": "3.50.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Animation currently loaded into this component, or an empty string if none loaded." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#getName", "scope": "instance", "___id": "T000002R001129", "___s": true }, { "comment": "/**\r\n * Returns the key of the animation frame currently displayed by this component.\r\n *\r\n * @method Phaser.Animations.AnimationState#getFrameName\r\n * @since 3.50.0\r\n *\r\n * @return {string} The key of the Animation Frame currently displayed by this component, or an empty string if no animation has been loaded.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 554, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Returns the key of the animation frame currently displayed by this component.", "kind": "function", "name": "getFrameName", "since": "3.50.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Animation Frame currently displayed by this component, or an empty string if no animation has been loaded." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#getFrameName", "scope": "instance", "___id": "T000002R001131", "___s": true }, { "comment": "/**\r\n * Internal method used to load an animation into this component.\r\n *\r\n * @method Phaser.Animations.AnimationState#load\r\n * @protected\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Animations.PlayAnimationConfig)} key - The string-based key of the animation to play, or a `PlayAnimationConfig` object.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 567, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Internal method used to load an animation into this component.", "kind": "function", "name": "load", "access": "protected", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ] } }, "description": "The string-based key of the animation to play, or a `PlayAnimationConfig` object.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#load", "scope": "instance", "___id": "T000002R001133", "___s": true }, { "comment": "/**\r\n * Pause the current animation and set the `isPlaying` property to `false`.\r\n * You can optionally pause it at a specific frame.\r\n *\r\n * @method Phaser.Animations.AnimationState#pause\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Animations.AnimationFrame} [atFrame] - An optional frame to set after pausing the animation.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 644, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Pause the current animation and set the `isPlaying` property to `false`.\rYou can optionally pause it at a specific frame.", "kind": "function", "name": "pause", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "optional": true, "description": "An optional frame to set after pausing the animation.", "name": "atFrame" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#pause", "scope": "instance", "___id": "T000002R001158", "___s": true }, { "comment": "/**\r\n * Resumes playback of a paused animation and sets the `isPlaying` property to `true`.\r\n * You can optionally tell it to start playback from a specific frame.\r\n *\r\n * @method Phaser.Animations.AnimationState#resume\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Animations.AnimationFrame} [fromFrame] - An optional frame to set before restarting playback.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 672, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Resumes playback of a paused animation and sets the `isPlaying` property to `true`.\rYou 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "optional": true, "description": "An optional frame to set before restarting playback.", "name": "fromFrame" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#resume", "scope": "instance", "___id": "T000002R001163", "___s": true }, { "comment": "/**\r\n * Waits for the specified delay, in milliseconds, then starts playback of the given animation.\r\n *\r\n * If the animation _also_ has a delay value set in its config, it will be **added** to the delay given here.\r\n *\r\n * If an animation is already running and a new animation is given to this method, it will wait for\r\n * the given delay before starting the new animation.\r\n *\r\n * If no animation is currently running, the given one begins after the delay.\r\n *\r\n * Prior to Phaser 3.50 this method was called 'delayedPlay' and the parameters were in the reverse order.\r\n *\r\n * @method Phaser.Animations.AnimationState#playAfterDelay\r\n * @fires Phaser.Animations.Events#ANIMATION_START\r\n * @since 3.50.0\r\n *\r\n * @param {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig)} key - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.\r\n * @param {number} delay - The delay, in milliseconds, to wait before starting the animation playing.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 699, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Waits for the specified delay, in milliseconds, then starts playback of the given animation.\r\rIf the animation _also_ has a delay value set in its config, it will be **added** to the delay given here.\r\rIf an animation is already running and a new animation is given to this method, it will wait for\rthe given delay before starting the new animation.\r\rIf no animation is currently running, the given one begins after the delay.\r\rPrior to Phaser 3.50 this method was called 'delayedPlay' and the parameters were in the reverse order.", "kind": "function", "name": "playAfterDelay", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "params": [ { "type": { "names": [ "string", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ] } }, "description": "The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delay, in milliseconds, to wait before starting the animation playing.", "name": "delay" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#playAfterDelay", "scope": "instance", "___id": "T000002R001167", "___s": true }, { "comment": "/**\r\n * Waits for the current animation to complete the `repeatCount` number of repeat cycles, then starts playback\r\n * of the given animation.\r\n *\r\n * You can use this to ensure there are no harsh jumps between two sets of animations, i.e. going from an\r\n * idle animation to a walking animation, by making them blend smoothly into each other.\r\n *\r\n * If no animation is currently running, the given one will start immediately.\r\n *\r\n * @method Phaser.Animations.AnimationState#playAfterRepeat\r\n * @fires Phaser.Animations.Events#ANIMATION_START\r\n * @since 3.50.0\r\n *\r\n * @param {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig)} key - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.\r\n * @param {number} [repeatCount=1] - How many times should the animation repeat before the next one starts?\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 748, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Waits for the current animation to complete the `repeatCount` number of repeat cycles, then starts playback\rof the given animation.\r\rYou can use this to ensure there are no harsh jumps between two sets of animations, i.e. going from an\ridle animation to a walking animation, by making them blend smoothly into each other.\r\rIf no animation is currently running, the given one will start immediately.", "kind": "function", "name": "playAfterRepeat", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "params": [ { "type": { "names": [ "string", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ] } }, "description": "The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How many times should the animation repeat before the next one starts?", "name": "repeatCount" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#playAfterRepeat", "scope": "instance", "___id": "T000002R001175", "___s": true }, { "comment": "/**\r\n * Start playing the given animation on this Sprite.\r\n *\r\n * Animations in Phaser can either belong to the global Animation Manager, or specifically to this Sprite.\r\n *\r\n * The benefit of a global animation is that multiple Sprites can all play the same animation, without\r\n * having to duplicate the data. You can just create it once and then play it on any Sprite.\r\n *\r\n * The following code shows how to create a global repeating animation. The animation will be created\r\n * from all of the frames within the sprite sheet that was loaded with the key 'muybridge':\r\n *\r\n * ```javascript\r\n * var config = {\r\n * key: 'run',\r\n * frames: 'muybridge',\r\n * frameRate: 15,\r\n * repeat: -1\r\n * };\r\n *\r\n * // This code should be run from within a Scene:\r\n * this.anims.create(config);\r\n * ```\r\n *\r\n * However, if you wish to create an animation that is unique to this Sprite, and this Sprite alone,\r\n * you can call the `Animation.create` method instead. It accepts the exact same parameters as when\r\n * creating a global animation, however the resulting data is kept locally in this Sprite.\r\n *\r\n * With the animation created, either globally or locally, you can now play it on this Sprite:\r\n *\r\n * ```javascript\r\n * this.add.sprite(x, y).play('run');\r\n * ```\r\n *\r\n * Alternatively, if you wish to run it at a different frame rate, for example, you can pass a config\r\n * object instead:\r\n *\r\n * ```javascript\r\n * this.add.sprite(x, y).play({ key: 'run', frameRate: 24 });\r\n * ```\r\n *\r\n * When playing an animation on a Sprite it will first check to see if it can find a matching key\r\n * locally within the Sprite. If it can, it will play the local animation. If not, it will then\r\n * search the global Animation Manager and look for it there.\r\n *\r\n * If you need a Sprite to be able to play both local and global animations, make sure they don't\r\n * have conflicting keys.\r\n *\r\n * See the documentation for the `PlayAnimationConfig` config object for more details about this.\r\n *\r\n * Also, see the documentation in the Animation Manager for further details on creating animations.\r\n *\r\n * @method Phaser.Animations.AnimationState#play\r\n * @fires Phaser.Animations.Events#ANIMATION_START\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig)} key - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.\r\n * @param {boolean} [ignoreIfPlaying=false] - If this animation is already playing then ignore this call.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 799, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Start playing the given animation on this Sprite.\r\rAnimations in Phaser can either belong to the global Animation Manager, or specifically to this Sprite.\r\rThe benefit of a global animation is that multiple Sprites can all play the same animation, without\rhaving to duplicate the data. You can just create it once and then play it on any Sprite.\r\rThe following code shows how to create a global repeating animation. The animation will be created\rfrom all of the frames within the sprite sheet that was loaded with the key 'muybridge':\r\r```javascript\rvar config = {\r key: 'run',\r frames: 'muybridge',\r frameRate: 15,\r repeat: -1\r};\r\r// This code should be run from within a Scene:\rthis.anims.create(config);\r```\r\rHowever, if you wish to create an animation that is unique to this Sprite, and this Sprite alone,\ryou can call the `Animation.create` method instead. It accepts the exact same parameters as when\rcreating a global animation, however the resulting data is kept locally in this Sprite.\r\rWith the animation created, either globally or locally, you can now play it on this Sprite:\r\r```javascript\rthis.add.sprite(x, y).play('run');\r```\r\rAlternatively, if you wish to run it at a different frame rate, for example, you can pass a config\robject instead:\r\r```javascript\rthis.add.sprite(x, y).play({ key: 'run', frameRate: 24 });\r```\r\rWhen playing an animation on a Sprite it will first check to see if it can find a matching key\rlocally within the Sprite. If it can, it will play the local animation. If not, it will then\rsearch the global Animation Manager and look for it there.\r\rIf you need a Sprite to be able to play both local and global animations, make sure they don't\rhave conflicting keys.\r\rSee the documentation for the `PlayAnimationConfig` config object for more details about this.\r\rAlso, see the documentation in the Animation Manager for further details on creating animations.", "kind": "function", "name": "play", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ] } }, "description": "The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If this animation is already playing then ignore this call.", "name": "ignoreIfPlaying" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#play", "scope": "instance", "___id": "T000002R001184", "___s": true }, { "comment": "/**\r\n * Start playing the given animation on this Sprite, in reverse.\r\n *\r\n * Animations in Phaser can either belong to the global Animation Manager, or specifically to this Sprite.\r\n *\r\n * The benefit of a global animation is that multiple Sprites can all play the same animation, without\r\n * having to duplicate the data. You can just create it once and then play it on any Sprite.\r\n *\r\n * The following code shows how to create a global repeating animation. The animation will be created\r\n * from all of the frames within the sprite sheet that was loaded with the key 'muybridge':\r\n *\r\n * ```javascript\r\n * var config = {\r\n * key: 'run',\r\n * frames: 'muybridge',\r\n * frameRate: 15,\r\n * repeat: -1\r\n * };\r\n *\r\n * // This code should be run from within a Scene:\r\n * this.anims.create(config);\r\n * ```\r\n *\r\n * However, if you wish to create an animation that is unique to this Sprite, and this Sprite alone,\r\n * you can call the `Animation.create` method instead. It accepts the exact same parameters as when\r\n * creating a global animation, however the resulting data is kept locally in this Sprite.\r\n *\r\n * With the animation created, either globally or locally, you can now play it on this Sprite:\r\n *\r\n * ```javascript\r\n * this.add.sprite(x, y).playReverse('run');\r\n * ```\r\n *\r\n * Alternatively, if you wish to run it at a different frame rate, for example, you can pass a config\r\n * object instead:\r\n *\r\n * ```javascript\r\n * this.add.sprite(x, y).playReverse({ key: 'run', frameRate: 24 });\r\n * ```\r\n *\r\n * When playing an animation on a Sprite it will first check to see if it can find a matching key\r\n * locally within the Sprite. If it can, it will play the local animation. If not, it will then\r\n * search the global Animation Manager and look for it there.\r\n *\r\n * If you need a Sprite to be able to play both local and global animations, make sure they don't\r\n * have conflicting keys.\r\n *\r\n * See the documentation for the `PlayAnimationConfig` config object for more details about this.\r\n *\r\n * Also, see the documentation in the Animation Manager for further details on creating animations.\r\n *\r\n * @method Phaser.Animations.AnimationState#playReverse\r\n * @fires Phaser.Animations.Events#ANIMATION_START\r\n * @since 3.12.0\r\n *\r\n * @param {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig)} key - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.\r\n * @param {boolean} [ignoreIfPlaying=false] - If an animation is already playing then ignore this call.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 894, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Start playing the given animation on this Sprite, in reverse.\r\rAnimations in Phaser can either belong to the global Animation Manager, or specifically to this Sprite.\r\rThe benefit of a global animation is that multiple Sprites can all play the same animation, without\rhaving to duplicate the data. You can just create it once and then play it on any Sprite.\r\rThe following code shows how to create a global repeating animation. The animation will be created\rfrom all of the frames within the sprite sheet that was loaded with the key 'muybridge':\r\r```javascript\rvar config = {\r key: 'run',\r frames: 'muybridge',\r frameRate: 15,\r repeat: -1\r};\r\r// This code should be run from within a Scene:\rthis.anims.create(config);\r```\r\rHowever, if you wish to create an animation that is unique to this Sprite, and this Sprite alone,\ryou can call the `Animation.create` method instead. It accepts the exact same parameters as when\rcreating a global animation, however the resulting data is kept locally in this Sprite.\r\rWith the animation created, either globally or locally, you can now play it on this Sprite:\r\r```javascript\rthis.add.sprite(x, y).playReverse('run');\r```\r\rAlternatively, if you wish to run it at a different frame rate, for example, you can pass a config\robject instead:\r\r```javascript\rthis.add.sprite(x, y).playReverse({ key: 'run', frameRate: 24 });\r```\r\rWhen playing an animation on a Sprite it will first check to see if it can find a matching key\rlocally within the Sprite. If it can, it will play the local animation. If not, it will then\rsearch the global Animation Manager and look for it there.\r\rIf you need a Sprite to be able to play both local and global animations, make sure they don't\rhave conflicting keys.\r\rSee the documentation for the `PlayAnimationConfig` config object for more details about this.\r\rAlso, see the documentation in the Animation Manager for further details on creating animations.", "kind": "function", "name": "playReverse", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.12.0", "params": [ { "type": { "names": [ "string", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ] } }, "description": "The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If an animation is already playing then ignore this call.", "name": "ignoreIfPlaying" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#playReverse", "scope": "instance", "___id": "T000002R001195", "___s": true }, { "comment": "/**\r\n * Load the animation based on the key and set-up all of the internal values\r\n * needed for playback to start. If there is no delay, it will also fire the start events.\r\n *\r\n * @method Phaser.Animations.AnimationState#startAnimation\r\n * @fires Phaser.Animations.Events#ANIMATION_START\r\n * @since 3.50.0\r\n *\r\n * @param {(string|Phaser.Types.Animations.PlayAnimationConfig)} key - The string-based key of the animation to play, or a `PlayAnimationConfig` object.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 975, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Load the animation based on the key and set-up all of the internal values\rneeded for playback to start. If there is no delay, it will also fire the start events.", "kind": "function", "name": "startAnimation", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ] } }, "description": "The string-based key of the animation to play, or a `PlayAnimationConfig` object.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#startAnimation", "scope": "instance", "___id": "T000002R001203", "___s": true }, { "comment": "/**\r\n * Reverse the Animation that is already playing on the Game Object.\r\n *\r\n * @method Phaser.Animations.AnimationState#reverse\r\n * @since 3.12.0\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#reverse", "scope": "instance", "___id": "T000002R001235", "___s": true }, { "comment": "/**\r\n * Returns a value between 0 and 1 indicating how far this animation is through, ignoring repeats and yoyos.\r\n *\r\n * The value is based on the current frame and how far that is in the animation, it is not based on\r\n * the duration of the animation.\r\n *\r\n * @method Phaser.Animations.AnimationState#getProgress\r\n * @since 3.4.0\r\n *\r\n * @return {number} The progress of the current animation in frames, between 0 and 1.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Returns a value between 0 and 1 indicating how far this animation is through, ignoring repeats and yoyos.\r\rThe value is based on the current frame and how far that is in the animation, it is not based on\rthe duration of the animation.", "kind": "function", "name": "getProgress", "since": "3.4.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The progress of the current animation in frames, between 0 and 1." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#getProgress", "scope": "instance", "___id": "T000002R001239", "___s": true }, { "comment": "/**\r\n * Takes a value between 0 and 1 and uses it to set how far this animation is through playback.\r\n *\r\n * Does not factor in repeats or yoyos, but does handle playing forwards or backwards.\r\n *\r\n * The value is based on the current frame and how far that is in the animation, it is not based on\r\n * the duration of the animation.\r\n *\r\n * @method Phaser.Animations.AnimationState#setProgress\r\n * @since 3.4.0\r\n *\r\n * @param {number} [value=0] - The progress value, between 0 and 1.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Takes a value between 0 and 1 and uses it to set how far this animation is through playback.\r\rDoes not factor in repeats or yoyos, but does handle playing forwards or backwards.\r\rThe value is based on the current frame and how far that is in the animation, it is not based on\rthe duration of the animation.", "kind": "function", "name": "setProgress", "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The progress value, between 0 and 1.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#setProgress", "scope": "instance", "___id": "T000002R001244", "___s": true }, { "comment": "/**\r\n * Sets the number of times that the animation should repeat after its first play through.\r\n * For example, if repeat is 1, the animation will play a total of twice: the initial play plus 1 repeat.\r\n *\r\n * To repeat indefinitely, use -1.\r\n * The value should always be an integer.\r\n *\r\n * Calling this method only works if the animation is already running. Otherwise, any\r\n * value specified here will be overwritten when the next animation loads in. To avoid this,\r\n * use the `repeat` property of the `PlayAnimationConfig` object instead.\r\n *\r\n * @method Phaser.Animations.AnimationState#setRepeat\r\n * @since 3.4.0\r\n *\r\n * @param {number} value - The number of times that the animation should repeat.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1207, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Sets the number of times that the animation should repeat after its first play through.\rFor example, if repeat is 1, the animation will play a total of twice: the initial play plus 1 repeat.\r\rTo repeat indefinitely, use -1.\rThe value should always be an integer.\r\rCalling this method only works if the animation is already running. Otherwise, any\rvalue specified here will be overwritten when the next animation loads in. To avoid this,\ruse the `repeat` property of the `PlayAnimationConfig` object instead.", "kind": "function", "name": "setRepeat", "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of times that the animation should repeat.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#setRepeat", "scope": "instance", "___id": "T000002R001247", "___s": true }, { "comment": "/**\r\n * Handle the removal of an animation from the Animation Manager.\r\n *\r\n * @method Phaser.Animations.AnimationState#globalRemove\r\n * @since 3.50.0\r\n *\r\n * @param {string} [key] - The key of the removed Animation.\r\n * @param {Phaser.Animations.Animation} [animation] - The removed Animation.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1232, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Handle the removal of an animation from the Animation Manager.", "kind": "function", "name": "globalRemove", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The key of the removed Animation.", "name": "key" }, { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation" } }, "optional": true, "description": "The removed Animation.", "name": "animation" } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#globalRemove", "scope": "instance", "___id": "T000002R001250", "___s": true }, { "comment": "/**\r\n * Restarts the current animation from its beginning.\r\n *\r\n * You can optionally reset the delay and repeat counters as well.\r\n *\r\n * Calling this will fire the `ANIMATION_RESTART` event immediately.\r\n *\r\n * If you `includeDelay` then it will also fire the `ANIMATION_START` event once\r\n * the delay has expired, otherwise, playback will just begin immediately.\r\n *\r\n * @method Phaser.Animations.AnimationState#restart\r\n * @fires Phaser.Animations.Events#ANIMATION_RESTART\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [includeDelay=false] - Whether to include the delay value of the animation when restarting.\r\n * @param {boolean} [resetRepeats=false] - Whether to reset the repeat counter or not?\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1253, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Restarts the current animation from its beginning.\r\rYou can optionally reset the delay and repeat counters as well.\r\rCalling this will fire the `ANIMATION_RESTART` event immediately.\r\rIf you `includeDelay` then it will also fire the `ANIMATION_START` event once\rthe delay has expired, otherwise, playback will just begin immediately.", "kind": "function", "name": "restart", "fires": [ "Phaser.Animations.Events#event:ANIMATION_RESTART" ], "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to include the delay value of the animation when restarting.", "name": "includeDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to reset the repeat counter or not?", "name": "resetRepeats" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#restart", "scope": "instance", "___id": "T000002R001253", "___s": true }, { "comment": "/**\r\n * The current animation has completed. This dispatches the `ANIMATION_COMPLETE` event.\r\n *\r\n * This method is called by the Animation instance and should not usually be invoked directly.\r\n *\r\n * If no animation is loaded, no events will be dispatched.\r\n *\r\n * If another animation has been queued for playback, it will be started after the events fire.\r\n *\r\n * @method Phaser.Animations.AnimationState#complete\r\n * @fires Phaser.Animations.Events#ANIMATION_COMPLETE\r\n * @since 3.50.0\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1309, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The current animation has completed. This dispatches the `ANIMATION_COMPLETE` event.\r\rThis method is called by the Animation instance and should not usually be invoked directly.\r\rIf no animation is loaded, no events will be dispatched.\r\rIf another animation has been queued for playback, it will be started after the events fire.", "kind": "function", "name": "complete", "fires": [ "Phaser.Animations.Events#event:ANIMATION_COMPLETE" ], "since": "3.50.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#complete", "scope": "instance", "___id": "T000002R001266", "___s": true }, { "comment": "/**\r\n * Immediately stops the current animation from playing and dispatches the `ANIMATION_STOP` event.\r\n *\r\n * If no animation is running, no events will be dispatched.\r\n *\r\n * If there is another animation in the queue (set via the `chain` method) then it will start playing.\r\n *\r\n * @method Phaser.Animations.AnimationState#stop\r\n * @fires Phaser.Animations.Events#ANIMATION_STOP\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1347, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Immediately stops the current animation from playing and dispatches the `ANIMATION_STOP` event.\r\rIf no animation is running, no events will be dispatched.\r\rIf there is another animation in the queue (set via the `chain` method) then it will start playing.", "kind": "function", "name": "stop", "fires": [ "Phaser.Animations.Events#event:ANIMATION_STOP" ], "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#stop", "scope": "instance", "___id": "T000002R001272", "___s": true }, { "comment": "/**\r\n * Stops the current animation from playing after the specified time delay, given in milliseconds.\r\n *\r\n * It then dispatches the `ANIMATION_STOP` event.\r\n *\r\n * If no animation is running, no events will be dispatched.\r\n *\r\n * If there is another animation in the queue (set via the `chain` method) then it will start playing,\r\n * when the current one stops.\r\n *\r\n * @method Phaser.Animations.AnimationState#stopAfterDelay\r\n * @fires Phaser.Animations.Events#ANIMATION_STOP\r\n * @since 3.4.0\r\n *\r\n * @param {number} delay - The number of milliseconds to wait before stopping this animation.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1385, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Stops the current animation from playing after the specified time delay, given in milliseconds.\r\rIt then dispatches the `ANIMATION_STOP` event.\r\rIf no animation is running, no events will be dispatched.\r\rIf there is another animation in the queue (set via the `chain` method) then it will start playing,\rwhen the current one stops.", "kind": "function", "name": "stopAfterDelay", "fires": [ "Phaser.Animations.Events#event:ANIMATION_STOP" ], "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of milliseconds to wait before stopping this animation.", "name": "delay" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#stopAfterDelay", "scope": "instance", "___id": "T000002R001279", "___s": true }, { "comment": "/**\r\n * Stops the current animation from playing when it next repeats.\r\n *\r\n * It then dispatches the `ANIMATION_STOP` event.\r\n *\r\n * If no animation is running, no events will be dispatched.\r\n *\r\n * If there is another animation in the queue (set via the `chain` method) then it will start playing,\r\n * when the current one stops.\r\n *\r\n * Prior to Phaser 3.50 this method was called `stopOnRepeat` and had no parameters.\r\n *\r\n * @method Phaser.Animations.AnimationState#stopAfterRepeat\r\n * @fires Phaser.Animations.Events#ANIMATION_STOP\r\n * @since 3.50.0\r\n *\r\n * @param {number} [repeatCount=1] - How many times should the animation repeat before stopping?\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1411, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Stops the current animation from playing when it next repeats.\r\rIt then dispatches the `ANIMATION_STOP` event.\r\rIf no animation is running, no events will be dispatched.\r\rIf there is another animation in the queue (set via the `chain` method) then it will start playing,\rwhen the current one stops.\r\rPrior to Phaser 3.50 this method was called `stopOnRepeat` and had no parameters.", "kind": "function", "name": "stopAfterRepeat", "fires": [ "Phaser.Animations.Events#event:ANIMATION_STOP" ], "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How many times should the animation repeat before stopping?", "name": "repeatCount" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#stopAfterRepeat", "scope": "instance", "___id": "T000002R001283", "___s": true }, { "comment": "/**\r\n * Stops the current animation from playing when it next sets the given frame.\r\n * If this frame doesn't exist within the animation it will not stop it from playing.\r\n *\r\n * It then dispatches the `ANIMATION_STOP` event.\r\n *\r\n * If no animation is running, no events will be dispatched.\r\n *\r\n * If there is another animation in the queue (set via the `chain` method) then it will start playing,\r\n * when the current one stops.\r\n *\r\n * @method Phaser.Animations.AnimationState#stopOnFrame\r\n * @fires Phaser.Animations.Events#ANIMATION_STOP\r\n * @since 3.4.0\r\n *\r\n * @param {Phaser.Animations.AnimationFrame} frame - The frame to check before stopping this animation.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that owns this Animation Component.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Stops the current animation from playing when it next sets the given frame.\rIf this frame doesn't exist within the animation it will not stop it from playing.\r\rIt then dispatches the `ANIMATION_STOP` event.\r\rIf no animation is running, no events will be dispatched.\r\rIf there is another animation in the queue (set via the `chain` method) then it will start playing,\rwhen the current one stops.", "kind": "function", "name": "stopOnFrame", "fires": [ "Phaser.Animations.Events#event:ANIMATION_STOP" ], "since": "3.4.0", "params": [ { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The frame to check before stopping this animation.", "name": "frame" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that owns this Animation Component." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#stopOnFrame", "scope": "instance", "___id": "T000002R001289", "___s": true }, { "comment": "/**\r\n * Returns the total number of frames in this animation, or returns zero if no\r\n * animation has been loaded.\r\n *\r\n * @method Phaser.Animations.AnimationState#getTotalFrames\r\n * @since 3.4.0\r\n *\r\n * @return {number} The total number of frames in the current animation, or zero if no animation has been loaded.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1473, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Returns the total number of frames in this animation, or returns zero if no\ranimation has been loaded.", "kind": "function", "name": "getTotalFrames", "since": "3.4.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of frames in the current animation, or zero if no animation has been loaded." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#getTotalFrames", "scope": "instance", "___id": "T000002R001293", "___s": true }, { "comment": "/**\r\n * The internal update loop for the AnimationState Component.\r\n *\r\n * This is called automatically by the `Sprite.preUpdate` method.\r\n *\r\n * @method Phaser.Animations.AnimationState#update\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current timestamp.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1487, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "The internal update loop for the AnimationState Component.\r\rThis is called automatically by the `Sprite.preUpdate` method.", "kind": "function", "name": "update", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time, in ms, elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#update", "scope": "instance", "___id": "T000002R001295", "___s": true }, { "comment": "/**\r\n * Sets the given Animation Frame as being the current frame\r\n * and applies it to the parent Game Object, adjusting size and origin as needed.\r\n *\r\n * @method Phaser.Animations.AnimationState#setCurrentFrame\r\n * @fires Phaser.Animations.Events#ANIMATION_UPDATE\r\n * @fires Phaser.Animations.Events#ANIMATION_STOP\r\n * @since 3.4.0\r\n *\r\n * @param {Phaser.Animations.AnimationFrame} animationFrame - The animation frame to change to.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object this Animation Component belongs to.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Sets the given Animation Frame as being the current frame\rand applies it to the parent Game Object, adjusting size and origin as needed.", "kind": "function", "name": "setCurrentFrame", "fires": [ "Phaser.Animations.Events#event:ANIMATION_UPDATE", "Phaser.Animations.Events#event:ANIMATION_STOP" ], "since": "3.4.0", "params": [ { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The animation frame to change to.", "name": "animationFrame" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object this Animation Component belongs to." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#setCurrentFrame", "scope": "instance", "___id": "T000002R001302", "___s": true }, { "comment": "/**\r\n * Advances the animation to the next frame, regardless of the time or animation state.\r\n * If the animation is set to repeat, or yoyo, this will still take effect.\r\n *\r\n * Calling this does not change the direction of the animation. I.e. if it was currently\r\n * playing in reverse, calling this method doesn't then change the direction to forwards.\r\n *\r\n * @method Phaser.Animations.AnimationState#nextFrame\r\n * @since 3.16.0\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object this Animation Component belongs to.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1623, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Advances the animation to the next frame, regardless of the time or animation state.\rIf the animation is set to repeat, or yoyo, this will still take effect.\r\rCalling this does not change the direction of the animation. I.e. if it was currently\rplaying 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object this Animation Component belongs to." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#nextFrame", "scope": "instance", "___id": "T000002R001309", "___s": true }, { "comment": "/**\r\n * Advances the animation to the previous frame, regardless of the time or animation state.\r\n * If the animation is set to repeat, or yoyo, this will still take effect.\r\n *\r\n * Calling this does not change the direction of the animation. I.e. if it was currently\r\n * playing in forwards, calling this method doesn't then change the direction to backwards.\r\n *\r\n * @method Phaser.Animations.AnimationState#previousFrame\r\n * @since 3.16.0\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object this Animation Component belongs to.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1645, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Advances the animation to the previous frame, regardless of the time or animation state.\rIf the animation is set to repeat, or yoyo, this will still take effect.\r\rCalling this does not change the direction of the animation. I.e. if it was currently\rplaying 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object this Animation Component belongs to." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#previousFrame", "scope": "instance", "___id": "T000002R001311", "___s": true }, { "comment": "/**\r\n * Get an Animation instance that has been created locally on this Sprite.\r\n *\r\n * See the `create` method for more details.\r\n *\r\n * @method Phaser.Animations.AnimationState#get\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the Animation to retrieve.\r\n *\r\n * @return {Phaser.Animations.Animation} The Animation, or `null` if the key is invalid.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1667, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Get an Animation instance that has been created locally on this Sprite.\r\rSee the `create` method for more details.", "kind": "function", "name": "get", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Animation to retrieve.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation" } }, "description": "The Animation, or `null` if the key is invalid." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#get", "scope": "instance", "___id": "T000002R001313", "___s": true }, { "comment": "/**\r\n * Checks to see if the given key is already used locally within the animations stored on this Sprite.\r\n *\r\n * @method Phaser.Animations.AnimationState#exists\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the Animation to check.\r\n *\r\n * @return {boolean} `true` if the Animation exists locally, or `false` if the key is available, or there are no local animations.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1684, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Checks to see if the given key is already used locally within the animations stored on this Sprite.", "kind": "function", "name": "exists", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Animation to check.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Animation exists locally, or `false` if the key is available, or there are no local animations." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#exists", "scope": "instance", "___id": "T000002R001315", "___s": true }, { "comment": "/**\r\n * Creates a new Animation that is local specifically to this Sprite.\r\n *\r\n * When a Sprite owns an animation, it is kept out of the global Animation Manager, which means\r\n * you're free to use keys that may be already defined there. Unless you specifically need a Sprite\r\n * to have a unique animation, you should favor using global animations instead, as they allow for\r\n * the same animation to be used across multiple Sprites, saving on memory. However, if this Sprite\r\n * is the only one to use this animation, it's sensible to create it here.\r\n *\r\n * If an invalid key is given this method will return `false`.\r\n *\r\n * If you pass the key of an animation that already exists locally, that animation will be returned.\r\n *\r\n * A brand new animation is only created if the key is valid and not already in use by this Sprite.\r\n *\r\n * If you wish to re-use an existing key, call the `remove` method first, then this method.\r\n *\r\n * @method Phaser.Animations.AnimationState#create\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.Animations.Animation} config - The configuration settings for the Animation.\r\n *\r\n * @return {(Phaser.Animations.Animation|false)} The Animation that was created, or `false` if the key is already in use.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1699, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Creates a new Animation that is local specifically to this Sprite.\r\rWhen a Sprite owns an animation, it is kept out of the global Animation Manager, which means\ryou're free to use keys that may be already defined there. Unless you specifically need a Sprite\rto have a unique animation, you should favor using global animations instead, as they allow for\rthe same animation to be used across multiple Sprites, saving on memory. However, if this Sprite\ris the only one to use this animation, it's sensible to create it here.\r\rIf an invalid key is given this method will return `false`.\r\rIf you pass the key of an animation that already exists locally, that animation will be returned.\r\rA brand new animation is only created if the key is valid and not already in use by this Sprite.\r\rIf you wish to re-use an existing key, call the `remove` method first, then this method.", "kind": "function", "name": "create", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Types.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Animations.Animation" } }, "description": "The configuration settings for the Animation.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Animations.Animation", "false" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "false", "reservedWord": true } ] } }, "description": "The Animation that was created, or `false` if the key is already in use." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#create", "scope": "instance", "___id": "T000002R001317", "___s": true }, { "comment": "/**\r\n * Create one, or more animations from a loaded Aseprite JSON file.\r\n *\r\n * Aseprite is a powerful animated sprite editor and pixel art tool.\r\n *\r\n * You can find more details at https://www.aseprite.org/\r\n *\r\n * To export a compatible JSON file in Aseprite, please do the following:\r\n *\r\n * 1. Go to \"File - Export Sprite Sheet\"\r\n *\r\n * 2. On the **Layout** tab:\r\n * 2a. Set the \"Sheet type\" to \"Packed\"\r\n * 2b. Set the \"Constraints\" to \"None\"\r\n * 2c. Check the \"Merge Duplicates\" checkbox\r\n *\r\n * 3. On the **Sprite** tab:\r\n * 3a. Set \"Layers\" to \"Visible layers\"\r\n * 3b. Set \"Frames\" to \"All frames\", unless you only wish to export a sub-set of tags\r\n *\r\n * 4. On the **Borders** tab:\r\n * 4a. Check the \"Trim Sprite\" and \"Trim Cells\" options\r\n * 4b. Ensure \"Border Padding\", \"Spacing\" and \"Inner Padding\" are all > 0 (1 is usually enough)\r\n *\r\n * 5. On the **Output** tab:\r\n * 5a. Check \"Output File\", give your image a name and make sure you choose \"png files\" as the file type\r\n * 5b. Check \"JSON Data\" and give your json file a name\r\n * 5c. The JSON Data type can be either a Hash or Array, Phaser doesn't mind.\r\n * 5d. Make sure \"Tags\" is checked in the Meta options\r\n * 5e. In the \"Item Filename\" input box, make sure it says just \"{frame}\" and nothing more.\r\n *\r\n * 6. Click export\r\n *\r\n * This was tested with Aseprite 1.2.25.\r\n *\r\n * This will export a png and json file which you can load using the Aseprite Loader, i.e.:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.path = 'assets/animations/aseprite/';\r\n * this.load.aseprite('paladin', 'paladin.png', 'paladin.json');\r\n * }\r\n * ```\r\n *\r\n * Once loaded, you can call this method on a Sprite with the 'atlas' key:\r\n *\r\n * ```javascript\r\n * const sprite = this.add.sprite(400, 300);\r\n *\r\n * sprite.anims.createFromAseprite('paladin');\r\n * ```\r\n *\r\n * Any animations defined in the JSON will now be available to use on this Sprite and you play them\r\n * via their Tag name. For example, if you have an animation called 'War Cry' on your Aseprite timeline,\r\n * you can play it on the Sprite using that Tag name:\r\n *\r\n * ```javascript\r\n * const sprite = this.add.sprite(400, 300);\r\n *\r\n * sprite.anims.createFromAseprite('paladin');\r\n *\r\n * sprite.play('War Cry');\r\n * ```\r\n *\r\n * When calling this method you can optionally provide an array of tag names, and only those animations\r\n * will be created. For example:\r\n *\r\n * ```javascript\r\n * sprite.anims.createFromAseprite('paladin', [ 'step', 'War Cry', 'Magnum Break' ]);\r\n * ```\r\n *\r\n * This will only create the 3 animations defined. Note that the tag names are case-sensitive.\r\n *\r\n * @method Phaser.Animations.AnimationState#createFromAseprite\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the loaded Aseprite atlas. It must have been loaded prior to calling this method.\r\n * @param {string[]} [tags] - An array of Tag names. If provided, only animations found in this array will be created.\r\n *\r\n * @return {Phaser.Animations.Animation[]} An array of Animation instances that were successfully created.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1753, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Create one, or more animations from a loaded Aseprite JSON file.\r\rAseprite is a powerful animated sprite editor and pixel art tool.\r\rYou can find more details at https://www.aseprite.org/\r\rTo export a compatible JSON file in Aseprite, please do the following:\r\r1. Go to \"File - Export Sprite Sheet\"\r\r2. On the **Layout** tab:\r2a. Set the \"Sheet type\" to \"Packed\"\r2b. Set the \"Constraints\" to \"None\"\r2c. Check the \"Merge Duplicates\" checkbox\r\r3. On the **Sprite** tab:\r3a. Set \"Layers\" to \"Visible layers\"\r3b. Set \"Frames\" to \"All frames\", unless you only wish to export a sub-set of tags\r\r4. On the **Borders** tab:\r4a. Check the \"Trim Sprite\" and \"Trim Cells\" options\r4b. Ensure \"Border Padding\", \"Spacing\" and \"Inner Padding\" are all > 0 (1 is usually enough)\r\r5. On the **Output** tab:\r5a. Check \"Output File\", give your image a name and make sure you choose \"png files\" as the file type\r5b. Check \"JSON Data\" and give your json file a name\r5c. The JSON Data type can be either a Hash or Array, Phaser doesn't mind.\r5d. Make sure \"Tags\" is checked in the Meta options\r5e. In the \"Item Filename\" input box, make sure it says just \"{frame}\" and nothing more.\r\r6. Click export\r\rThis was tested with Aseprite 1.2.25.\r\rThis will export a png and json file which you can load using the Aseprite Loader, i.e.:\r\r```javascript\rfunction preload ()\r{\r this.load.path = 'assets/animations/aseprite/';\r this.load.aseprite('paladin', 'paladin.png', 'paladin.json');\r}\r```\r\rOnce loaded, you can call this method on a Sprite with the 'atlas' key:\r\r```javascript\rconst sprite = this.add.sprite(400, 300);\r\rsprite.anims.createFromAseprite('paladin');\r```\r\rAny animations defined in the JSON will now be available to use on this Sprite and you play them\rvia their Tag name. For example, if you have an animation called 'War Cry' on your Aseprite timeline,\ryou can play it on the Sprite using that Tag name:\r\r```javascript\rconst sprite = this.add.sprite(400, 300);\r\rsprite.anims.createFromAseprite('paladin');\r\rsprite.play('War Cry');\r```\r\rWhen calling this method you can optionally provide an array of tag names, and only those animations\rwill be created. For example:\r\r```javascript\rsprite.anims.createFromAseprite('paladin', [ 'step', 'War Cry', 'Magnum Break' ]);\r```\r\rThis will only create the 3 animations defined. Note that the tag names are case-sensitive.", "kind": "function", "name": "createFromAseprite", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the loaded Aseprite atlas. It must have been loaded prior to calling this method.", "name": "key" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of Tag names. If provided, only animations found in this array will be created.", "name": "tags" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Animations.Animation", "type": "NameExpression" } ] } }, "description": "An array of Animation instances that were successfully created." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#createFromAseprite", "scope": "instance", "___id": "T000002R001324", "___s": true }, { "comment": "/**\r\n * Generate an array of {@link Phaser.Types.Animations.AnimationFrame} objects from a texture key and configuration object.\r\n *\r\n * Generates objects with string based frame names, as configured by the given {@link Phaser.Types.Animations.GenerateFrameNames}.\r\n *\r\n * It's a helper method, designed to make it easier for you to extract all of the frame names from texture atlases.\r\n * If you're working with a sprite sheet, see the `generateFrameNumbers` method instead.\r\n *\r\n * Example:\r\n *\r\n * If you have a texture atlases loaded called `gems` and it contains 6 frames called `ruby_0001`, `ruby_0002`, and so on,\r\n * then you can call this method using: `this.anims.generateFrameNames('gems', { prefix: 'ruby_', end: 6, zeroPad: 4 })`.\r\n *\r\n * The `end` value tells it to look for 6 frames, incrementally numbered, all starting with the prefix `ruby_`. The `zeroPad`\r\n * value tells it how many zeroes pad out the numbers. To create an animation using this method, you can do:\r\n *\r\n * ```javascript\r\n * this.anims.create({\r\n * key: 'ruby',\r\n * repeat: -1,\r\n * frames: this.anims.generateFrameNames('gems', {\r\n * prefix: 'ruby_',\r\n * end: 6,\r\n * zeroPad: 4\r\n * })\r\n * });\r\n * ```\r\n *\r\n * Please see the animation examples for further details.\r\n *\r\n * @method Phaser.Animations.AnimationState#generateFrameNames\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key for the texture containing the animation frames.\r\n * @param {Phaser.Types.Animations.GenerateFrameNames} [config] - The configuration object for the animation frame names.\r\n *\r\n * @return {Phaser.Types.Animations.AnimationFrame[]} The array of {@link Phaser.Types.Animations.AnimationFrame} objects.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1840, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Generate an array of {@link Phaser.Types.Animations.AnimationFrame} objects from a texture key and configuration object.\r\rGenerates objects with string based frame names, as configured by the given {@link Phaser.Types.Animations.GenerateFrameNames}.\r\rIt's a helper method, designed to make it easier for you to extract all of the frame names from texture atlases.\rIf you're working with a sprite sheet, see the `generateFrameNumbers` method instead.\r\rExample:\r\rIf you have a texture atlases loaded called `gems` and it contains 6 frames called `ruby_0001`, `ruby_0002`, and so on,\rthen you can call this method using: `this.anims.generateFrameNames('gems', { prefix: 'ruby_', end: 6, zeroPad: 4 })`.\r\rThe `end` value tells it to look for 6 frames, incrementally numbered, all starting with the prefix `ruby_`. The `zeroPad`\rvalue tells it how many zeroes pad out the numbers. To create an animation using this method, you can do:\r\r```javascript\rthis.anims.create({\r key: 'ruby',\r repeat: -1,\r frames: this.anims.generateFrameNames('gems', {\r prefix: 'ruby_',\r end: 6,\r zeroPad: 4\r })\r});\r```\r\rPlease see the animation examples for further details.", "kind": "function", "name": "generateFrameNames", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key for the texture containing the animation frames.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Animations.GenerateFrameNames" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Animations.GenerateFrameNames" } }, "optional": true, "description": "The configuration object for the animation frame names.", "name": "config" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.AnimationFrame", "type": "NameExpression" } ] } }, "description": "The array of {@link Phaser.Types.Animations.AnimationFrame} objects." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#generateFrameNames", "scope": "instance", "___id": "T000002R001326", "___s": true }, { "comment": "/**\r\n * Generate an array of {@link Phaser.Types.Animations.AnimationFrame} objects from a texture key and configuration object.\r\n *\r\n * Generates objects with numbered frame names, as configured by the given {@link Phaser.Types.Animations.GenerateFrameNumbers}.\r\n *\r\n * If you're working with a texture atlas, see the `generateFrameNames` method instead.\r\n *\r\n * It's a helper method, designed to make it easier for you to extract frames from sprite sheets.\r\n *\r\n * Example:\r\n *\r\n * If you have a sprite sheet loaded called `explosion` and it contains 12 frames, then you can call this method using:\r\n * `this.anims.generateFrameNumbers('explosion', { start: 0, end: 11 })`.\r\n *\r\n * The `end` value tells it to stop after 12 frames. To create an animation using this method, you can do:\r\n *\r\n * ```javascript\r\n * this.anims.create({\r\n * key: 'boom',\r\n * frames: this.anims.generateFrameNumbers('explosion', {\r\n * start: 0,\r\n * end: 11\r\n * })\r\n * });\r\n * ```\r\n *\r\n * Note that `start` is optional and you don't need to include it if the animation starts from frame 0.\r\n *\r\n * To specify an animation in reverse, swap the `start` and `end` values.\r\n *\r\n * If the frames are not sequential, you may pass an array of frame numbers instead, for example:\r\n *\r\n * `this.anims.generateFrameNumbers('explosion', { frames: [ 0, 1, 2, 1, 2, 3, 4, 0, 1, 2 ] })`\r\n *\r\n * Please see the animation examples and `GenerateFrameNumbers` config docs for further details.\r\n *\r\n * @method Phaser.Animations.AnimationState#generateFrameNumbers\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key for the texture containing the animation frames.\r\n * @param {Phaser.Types.Animations.GenerateFrameNumbers} [config] - The configuration object for the animation frames.\r\n *\r\n * @return {Phaser.Types.Animations.AnimationFrame[]} The array of {@link Phaser.Types.Animations.AnimationFrame} objects.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1883, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Generate an array of {@link Phaser.Types.Animations.AnimationFrame} objects from a texture key and configuration object.\r\rGenerates objects with numbered frame names, as configured by the given {@link Phaser.Types.Animations.GenerateFrameNumbers}.\r\rIf you're working with a texture atlas, see the `generateFrameNames` method instead.\r\rIt's a helper method, designed to make it easier for you to extract frames from sprite sheets.\r\rExample:\r\rIf you have a sprite sheet loaded called `explosion` and it contains 12 frames, then you can call this method using:\r`this.anims.generateFrameNumbers('explosion', { start: 0, end: 11 })`.\r\rThe `end` value tells it to stop after 12 frames. To create an animation using this method, you can do:\r\r```javascript\rthis.anims.create({\r key: 'boom',\r frames: this.anims.generateFrameNumbers('explosion', {\r start: 0,\r end: 11\r })\r});\r```\r\rNote that `start` is optional and you don't need to include it if the animation starts from frame 0.\r\rTo specify an animation in reverse, swap the `start` and `end` values.\r\rIf the frames are not sequential, you may pass an array of frame numbers instead, for example:\r\r`this.anims.generateFrameNumbers('explosion', { frames: [ 0, 1, 2, 1, 2, 3, 4, 0, 1, 2 ] })`\r\rPlease see the animation examples and `GenerateFrameNumbers` config docs for further details.", "kind": "function", "name": "generateFrameNumbers", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key for the texture containing the animation frames.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Animations.GenerateFrameNumbers" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Animations.GenerateFrameNumbers" } }, "optional": true, "description": "The configuration object for the animation frames.", "name": "config" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.AnimationFrame", "type": "NameExpression" } ] } }, "description": "The array of {@link Phaser.Types.Animations.AnimationFrame} objects." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#generateFrameNumbers", "scope": "instance", "___id": "T000002R001328", "___s": true }, { "comment": "/**\r\n * Removes a locally created Animation from this Sprite, based on the given key.\r\n *\r\n * Once an Animation has been removed, this Sprite cannot play it again without re-creating it.\r\n *\r\n * @method Phaser.Animations.AnimationState#remove\r\n * @since 3.50.0\r\n *\r\n * @param {string} key - The key of the animation to remove.\r\n *\r\n * @return {Phaser.Animations.Animation} The Animation instance that was removed from this Sprite, if the key was valid.\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1932, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Removes a locally created Animation from this Sprite, based on the given key.\r\rOnce an Animation has been removed, this Sprite cannot play it again without re-creating it.", "kind": "function", "name": "remove", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the animation to remove.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation" } }, "description": "The Animation instance that was removed from this Sprite, if the key was valid." } ], "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#remove", "scope": "instance", "___id": "T000002R001330", "___s": true }, { "comment": "/**\r\n * Destroy this Animation component.\r\n *\r\n * Unregisters event listeners and cleans up its references.\r\n *\r\n * @method Phaser.Animations.AnimationState#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1961, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "Destroy this Animation component.\r\rUnregisters event listeners and cleans up its references.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#destroy", "scope": "instance", "___id": "T000002R001333", "___s": true }, { "comment": "/**\r\n * `true` if the current animation is paused, otherwise `false`.\r\n *\r\n * @name Phaser.Animations.AnimationState#isPaused\r\n * @readonly\r\n * @type {boolean}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "AnimationState.js", "lineno": 1987, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "description": "`true` if the current animation is paused, otherwise `false`.", "name": "isPaused", "readonly": true, "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.4.0", "memberof": "Phaser.Animations.AnimationState", "longname": "Phaser.Animations.AnimationState#isPaused", "scope": "instance", "kind": "member", "___id": "T000002R001341", "___s": true }, { "comment": "/**\r\n * The Add Animation Event.\r\n *\r\n * This event is dispatched when a new animation is added to the global Animation Manager.\r\n *\r\n * This can happen either as a result of an animation instance being added to the Animation Manager,\r\n * or the Animation Manager creating a new animation directly.\r\n *\r\n * @event Phaser.Animations.Events#ADD_ANIMATION\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key of the Animation that was added to the global Animation Manager.\r\n * @param {Phaser.Animations.Animation} animation - An instance of the newly created Animation.\r\n */", "meta": { "filename": "ADD_ANIMATION_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\events", "code": {} }, "description": "The Add Animation Event.\r\rThis event is dispatched when a new animation is added to the global Animation Manager.\r\rThis can happen either as a result of an animation instance being added to the Animation Manager,\ror the Animation Manager creating a new animation directly.", "kind": "event", "name": "ADD_ANIMATION", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Animation that was added to the global Animation Manager.", "name": "key" }, { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R001345", "___s": true }, { "comment": "/**\r\n * The Animation Complete Event.\r\n *\r\n * This event is dispatched by a Sprite when an animation playing on it completes playback.\r\n * This happens when the animation gets to the end of its sequence, factoring in any delays\r\n * or repeats it may have to process.\r\n *\r\n * An animation that is set to loop, or repeat forever, will never fire this event, because\r\n * it never actually completes. If you need to handle this, listen for the `ANIMATION_STOP`\r\n * event instead, as this is emitted when the animation is stopped directly.\r\n *\r\n * Listen for it on the Sprite using `sprite.on('animationcomplete', listener)`\r\n *\r\n * The animation event flow is as follows:\r\n *\r\n * 1. `ANIMATION_START`\r\n * 2. `ANIMATION_UPDATE` (repeated for however many frames the animation has)\r\n * 3. `ANIMATION_REPEAT` (only if the animation is set to repeat, it then emits more update events after this)\r\n * 4. `ANIMATION_COMPLETE` (only if there is a finite, or zero, repeat count)\r\n * 5. `ANIMATION_COMPLETE_KEY` (only if there is a finite, or zero, repeat count)\r\n *\r\n * If the animation is stopped directly, the `ANIMATION_STOP` event is dispatched instead of `ANIMATION_COMPLETE`.\r\n *\r\n * If the animation is restarted while it is already playing, `ANIMATION_RESTART` is emitted.\r\n *\r\n * @event Phaser.Animations.Events#ANIMATION_COMPLETE\r\n * @type {string}\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Animations.Animation} animation - A reference to the Animation that completed.\r\n * @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame of the Animation.\r\n * @param {Phaser.GameObjects.Sprite} gameObject - A reference to the Game Object on which the animation updated.\r\n * @param {string} frameKey - The unique key of the Animation Frame within the Animation.\r\n */", "meta": { "filename": "ANIMATION_COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\events", "code": {} }, "description": "The Animation Complete Event.\r\rThis event is dispatched by a Sprite when an animation playing on it completes playback.\rThis happens when the animation gets to the end of its sequence, factoring in any delays\ror repeats it may have to process.\r\rAn animation that is set to loop, or repeat forever, will never fire this event, because\rit never actually completes. If you need to handle this, listen for the `ANIMATION_STOP`\revent instead, as this is emitted when the animation is stopped directly.\r\rListen for it on the Sprite using `sprite.on('animationcomplete', listener)`\r\rThe animation event flow is as follows:\r\r1. `ANIMATION_START`\r2. `ANIMATION_UPDATE` (repeated for however many frames the animation has)\r3. `ANIMATION_REPEAT` (only if the animation is set to repeat, it then emits more update events after this)\r4. `ANIMATION_COMPLETE` (only if there is a finite, or zero, repeat count)\r5. `ANIMATION_COMPLETE_KEY` (only if there is a finite, or zero, repeat count)\r\rIf the animation is stopped directly, the `ANIMATION_STOP` event is dispatched instead of `ANIMATION_COMPLETE`.\r\rIf the animation is restarted while it is already playing, `ANIMATION_RESTART` is emitted.", "kind": "event", "name": "ANIMATION_COMPLETE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation" } }, "description": "A reference to the Animation that completed.", "name": "animation" }, { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The current Animation Frame of the Animation.", "name": "frame" }, { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "A reference to the Game Object on which the animation updated.", "name": "gameObject" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the Animation Frame within the Animation.", "name": "frameKey" } ], "memberof": "Phaser.Animations.Events", "longname": "Phaser.Animations.Events#event:ANIMATION_COMPLETE", "scope": "instance", "___id": "T000002R001347", "___s": true }, { "comment": "/**\r\n * The Animation Complete Dynamic Key Event.\r\n *\r\n * This event is dispatched by a Sprite when an animation playing on it completes playback.\r\n * This happens when the animation gets to the end of its sequence, factoring in any delays\r\n * or repeats it may have to process.\r\n *\r\n * An animation that is set to loop, or repeat forever, will never fire this event, because\r\n * it never actually completes. If you need to handle this, listen for the `ANIMATION_STOP`\r\n * event instead, as this is emitted when the animation is stopped directly.\r\n *\r\n * The difference between this and the `ANIMATION_COMPLETE` event is that this one has a\r\n * dynamic event name that contains the name of the animation within it. For example,\r\n * if you had an animation called `explode` you could listen for the completion of that\r\n * specific animation by using: `sprite.on('animationcomplete-explode', listener)`. Or, if you\r\n * wish to use types: `sprite.on(Phaser.Animations.Events.ANIMATION_COMPLETE_KEY + 'explode', listener)`.\r\n *\r\n * The animation event flow is as follows:\r\n *\r\n * 1. `ANIMATION_START`\r\n * 2. `ANIMATION_UPDATE` (repeated for however many frames the animation has)\r\n * 3. `ANIMATION_REPEAT` (only if the animation is set to repeat, it then emits more update events after this)\r\n * 4. `ANIMATION_COMPLETE` (only if there is a finite, or zero, repeat count)\r\n * 5. `ANIMATION_COMPLETE_KEY` (only if there is a finite, or zero, repeat count)\r\n *\r\n * If the animation is stopped directly, the `ANIMATION_STOP` event is dispatched instead of `ANIMATION_COMPLETE`.\r\n *\r\n * If the animation is restarted while it is already playing, `ANIMATION_RESTART` is emitted.\r\n *\r\n * @event Phaser.Animations.Events#ANIMATION_COMPLETE_KEY\r\n * @type {string}\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Animations.Animation} animation - A reference to the Animation that completed.\r\n * @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame of the Animation.\r\n * @param {Phaser.GameObjects.Sprite} gameObject - A reference to the Game Object on which the animation updated.\r\n * @param {string} frameKey - The unique key of the Animation Frame within the Animation.\r\n */", "meta": { "filename": "ANIMATION_COMPLETE_KEY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\events", "code": {} }, "description": "The Animation Complete Dynamic Key Event.\r\rThis event is dispatched by a Sprite when an animation playing on it completes playback.\rThis happens when the animation gets to the end of its sequence, factoring in any delays\ror repeats it may have to process.\r\rAn animation that is set to loop, or repeat forever, will never fire this event, because\rit never actually completes. If you need to handle this, listen for the `ANIMATION_STOP`\revent instead, as this is emitted when the animation is stopped directly.\r\rThe difference between this and the `ANIMATION_COMPLETE` event is that this one has a\rdynamic event name that contains the name of the animation within it. For example,\rif you had an animation called `explode` you could listen for the completion of that\rspecific animation by using: `sprite.on('animationcomplete-explode', listener)`. Or, if you\rwish to use types: `sprite.on(Phaser.Animations.Events.ANIMATION_COMPLETE_KEY + 'explode', listener)`.\r\rThe animation event flow is as follows:\r\r1. `ANIMATION_START`\r2. `ANIMATION_UPDATE` (repeated for however many frames the animation has)\r3. `ANIMATION_REPEAT` (only if the animation is set to repeat, it then emits more update events after this)\r4. `ANIMATION_COMPLETE` (only if there is a finite, or zero, repeat count)\r5. `ANIMATION_COMPLETE_KEY` (only if there is a finite, or zero, repeat count)\r\rIf the animation is stopped directly, the `ANIMATION_STOP` event is dispatched instead of `ANIMATION_COMPLETE`.\r\rIf the animation is restarted while it is already playing, `ANIMATION_RESTART` is emitted.", "kind": "event", "name": "ANIMATION_COMPLETE_KEY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation" } }, "description": "A reference to the Animation that completed.", "name": "animation" }, { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The current Animation Frame of the Animation.", "name": "frame" }, { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "A reference to the Game Object on which the animation updated.", "name": "gameObject" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the Animation Frame within the Animation.", "name": "frameKey" } ], "memberof": "Phaser.Animations.Events", "longname": "Phaser.Animations.Events#event:ANIMATION_COMPLETE_KEY", "scope": "instance", "___id": "T000002R001349", "___s": true }, { "comment": "/**\r\n * The Animation Repeat Event.\r\n *\r\n * This event is dispatched by a Sprite when an animation repeats playing on it.\r\n * This happens if the animation was created, or played, with a `repeat` value specified.\r\n *\r\n * An animation will repeat when it reaches the end of its sequence.\r\n *\r\n * Listen for it on the Sprite using `sprite.on('animationrepeat', listener)`\r\n *\r\n * The animation event flow is as follows:\r\n *\r\n * 1. `ANIMATION_START`\r\n * 2. `ANIMATION_UPDATE` (repeated for however many frames the animation has)\r\n * 3. `ANIMATION_REPEAT` (only if the animation is set to repeat, it then emits more update events after this)\r\n * 4. `ANIMATION_COMPLETE` (only if there is a finite, or zero, repeat count)\r\n * 5. `ANIMATION_COMPLETE_KEY` (only if there is a finite, or zero, repeat count)\r\n *\r\n * If the animation is stopped directly, the `ANIMATION_STOP` event is dispatched instead of `ANIMATION_COMPLETE`.\r\n *\r\n * If the animation is restarted while it is already playing, `ANIMATION_RESTART` is emitted.\r\n *\r\n * @event Phaser.Animations.Events#ANIMATION_REPEAT\r\n * @type {string}\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Animations.Animation} animation - A reference to the Animation that has repeated.\r\n * @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame of the Animation.\r\n * @param {Phaser.GameObjects.Sprite} gameObject - A reference to the Game Object on which the animation repeated.\r\n * @param {string} frameKey - The unique key of the Animation Frame within the Animation.\r\n */", "meta": { "filename": "ANIMATION_REPEAT_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\events", "code": {} }, "description": "The Animation Repeat Event.\r\rThis event is dispatched by a Sprite when an animation repeats playing on it.\rThis happens if the animation was created, or played, with a `repeat` value specified.\r\rAn animation will repeat when it reaches the end of its sequence.\r\rListen for it on the Sprite using `sprite.on('animationrepeat', listener)`\r\rThe animation event flow is as follows:\r\r1. `ANIMATION_START`\r2. `ANIMATION_UPDATE` (repeated for however many frames the animation has)\r3. `ANIMATION_REPEAT` (only if the animation is set to repeat, it then emits more update events after this)\r4. `ANIMATION_COMPLETE` (only if there is a finite, or zero, repeat count)\r5. `ANIMATION_COMPLETE_KEY` (only if there is a finite, or zero, repeat count)\r\rIf the animation is stopped directly, the `ANIMATION_STOP` event is dispatched instead of `ANIMATION_COMPLETE`.\r\rIf the animation is restarted while it is already playing, `ANIMATION_RESTART` is emitted.", "kind": "event", "name": "ANIMATION_REPEAT", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation" } }, "description": "A reference to the Animation that has repeated.", "name": "animation" }, { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The current Animation Frame of the Animation.", "name": "frame" }, { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "A reference to the Game Object on which the animation repeated.", "name": "gameObject" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the Animation Frame within the Animation.", "name": "frameKey" } ], "memberof": "Phaser.Animations.Events", "longname": "Phaser.Animations.Events#event:ANIMATION_REPEAT", "scope": "instance", "___id": "T000002R001351", "___s": true }, { "comment": "/**\r\n * The Animation Restart Event.\r\n *\r\n * This event is dispatched by a Sprite when an animation restarts playing on it.\r\n * This only happens when the `Sprite.anims.restart` method is called.\r\n *\r\n * Listen for it on the Sprite using `sprite.on('animationrestart', listener)`\r\n *\r\n * The animation event flow is as follows:\r\n *\r\n * 1. `ANIMATION_START`\r\n * 2. `ANIMATION_UPDATE` (repeated for however many frames the animation has)\r\n * 3. `ANIMATION_REPEAT` (only if the animation is set to repeat, it then emits more update events after this)\r\n * 4. `ANIMATION_COMPLETE` (only if there is a finite, or zero, repeat count)\r\n * 5. `ANIMATION_COMPLETE_KEY` (only if there is a finite, or zero, repeat count)\r\n *\r\n * If the animation is stopped directly, the `ANIMATION_STOP` event is dispatched instead of `ANIMATION_COMPLETE`.\r\n *\r\n * If the animation is restarted while it is already playing, `ANIMATION_RESTART` is emitted.\r\n *\r\n * @event Phaser.Animations.Events#ANIMATION_RESTART\r\n * @type {string}\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Animations.Animation} animation - A reference to the Animation that has restarted.\r\n * @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame of the Animation.\r\n * @param {Phaser.GameObjects.Sprite} gameObject - A reference to the Game Object on which the animation restarted.\r\n * @param {string} frameKey - The unique key of the Animation Frame within the Animation.\r\n */", "meta": { "filename": "ANIMATION_RESTART_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\events", "code": {} }, "description": "The Animation Restart Event.\r\rThis event is dispatched by a Sprite when an animation restarts playing on it.\rThis only happens when the `Sprite.anims.restart` method is called.\r\rListen for it on the Sprite using `sprite.on('animationrestart', listener)`\r\rThe animation event flow is as follows:\r\r1. `ANIMATION_START`\r2. `ANIMATION_UPDATE` (repeated for however many frames the animation has)\r3. `ANIMATION_REPEAT` (only if the animation is set to repeat, it then emits more update events after this)\r4. `ANIMATION_COMPLETE` (only if there is a finite, or zero, repeat count)\r5. `ANIMATION_COMPLETE_KEY` (only if there is a finite, or zero, repeat count)\r\rIf the animation is stopped directly, the `ANIMATION_STOP` event is dispatched instead of `ANIMATION_COMPLETE`.\r\rIf the animation is restarted while it is already playing, `ANIMATION_RESTART` is emitted.", "kind": "event", "name": "ANIMATION_RESTART", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation" } }, "description": "A reference to the Animation that has restarted.", "name": "animation" }, { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The current Animation Frame of the Animation.", "name": "frame" }, { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "A reference to the Game Object on which the animation restarted.", "name": "gameObject" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the Animation Frame within the Animation.", "name": "frameKey" } ], "memberof": "Phaser.Animations.Events", "longname": "Phaser.Animations.Events#event:ANIMATION_RESTART", "scope": "instance", "___id": "T000002R001353", "___s": true }, { "comment": "/**\r\n * The Animation Start Event.\r\n *\r\n * This event is dispatched by a Sprite when an animation starts playing on it.\r\n * This happens when the animation is played, factoring in any delay that may have been specified.\r\n * This event happens after the delay has expired and prior to the first update event.\r\n *\r\n * Listen for it on the Sprite using `sprite.on('animationstart', listener)`\r\n *\r\n * The animation event flow is as follows:\r\n *\r\n * 1. `ANIMATION_START`\r\n * 2. `ANIMATION_UPDATE` (repeated for however many frames the animation has)\r\n * 3. `ANIMATION_REPEAT` (only if the animation is set to repeat, it then emits more update events after this)\r\n * 4. `ANIMATION_COMPLETE` (only if there is a finite, or zero, repeat count)\r\n * 5. `ANIMATION_COMPLETE_KEY` (only if there is a finite, or zero, repeat count)\r\n *\r\n * If the animation is stopped directly, the `ANIMATION_STOP` event is dispatched instead of `ANIMATION_COMPLETE`.\r\n *\r\n * If the animation is restarted while it is already playing, `ANIMATION_RESTART` is emitted.\r\n *\r\n * @event Phaser.Animations.Events#ANIMATION_START\r\n * @type {string}\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Animations.Animation} animation - A reference to the Animation that has started.\r\n * @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame of the Animation.\r\n * @param {Phaser.GameObjects.Sprite} gameObject - A reference to the Game Object on which the animation started.\r\n * @param {string} frameKey - The unique key of the Animation Frame within the Animation.\r\n */", "meta": { "filename": "ANIMATION_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\events", "code": {} }, "description": "The Animation Start Event.\r\rThis event is dispatched by a Sprite when an animation starts playing on it.\rThis happens when the animation is played, factoring in any delay that may have been specified.\rThis event happens after the delay has expired and prior to the first update event.\r\rListen for it on the Sprite using `sprite.on('animationstart', listener)`\r\rThe animation event flow is as follows:\r\r1. `ANIMATION_START`\r2. `ANIMATION_UPDATE` (repeated for however many frames the animation has)\r3. `ANIMATION_REPEAT` (only if the animation is set to repeat, it then emits more update events after this)\r4. `ANIMATION_COMPLETE` (only if there is a finite, or zero, repeat count)\r5. `ANIMATION_COMPLETE_KEY` (only if there is a finite, or zero, repeat count)\r\rIf the animation is stopped directly, the `ANIMATION_STOP` event is dispatched instead of `ANIMATION_COMPLETE`.\r\rIf the animation is restarted while it is already playing, `ANIMATION_RESTART` is emitted.", "kind": "event", "name": "ANIMATION_START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation" } }, "description": "A reference to the Animation that has started.", "name": "animation" }, { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The current Animation Frame of the Animation.", "name": "frame" }, { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "A reference to the Game Object on which the animation started.", "name": "gameObject" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the Animation Frame within the Animation.", "name": "frameKey" } ], "memberof": "Phaser.Animations.Events", "longname": "Phaser.Animations.Events#event:ANIMATION_START", "scope": "instance", "___id": "T000002R001355", "___s": true }, { "comment": "/**\r\n * The Animation Stop Event.\r\n *\r\n * This event is dispatched by a Sprite when an animation is stopped on it. An animation\r\n * will only be stopped if a method such as `Sprite.stop` or `Sprite.anims.stopAfterDelay`\r\n * is called. It can also be emitted if a new animation is started before the current one completes.\r\n *\r\n * Listen for it on the Sprite using `sprite.on('animationstop', listener)`\r\n *\r\n * The animation event flow is as follows:\r\n *\r\n * 1. `ANIMATION_START`\r\n * 2. `ANIMATION_UPDATE` (repeated for however many frames the animation has)\r\n * 3. `ANIMATION_REPEAT` (only if the animation is set to repeat, it then emits more update events after this)\r\n * 4. `ANIMATION_COMPLETE` (only if there is a finite, or zero, repeat count)\r\n * 5. `ANIMATION_COMPLETE_KEY` (only if there is a finite, or zero, repeat count)\r\n *\r\n * If the animation is stopped directly, the `ANIMATION_STOP` event is dispatched instead of `ANIMATION_COMPLETE`.\r\n *\r\n * If the animation is restarted while it is already playing, `ANIMATION_RESTART` is emitted.\r\n *\r\n * @event Phaser.Animations.Events#ANIMATION_STOP\r\n * @type {string}\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Animations.Animation} animation - A reference to the Animation that has stopped.\r\n * @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame of the Animation.\r\n * @param {Phaser.GameObjects.Sprite} gameObject - A reference to the Game Object on which the animation stopped.\r\n * @param {string} frameKey - The unique key of the Animation Frame within the Animation.\r\n */", "meta": { "filename": "ANIMATION_STOP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\events", "code": {} }, "description": "The Animation Stop Event.\r\rThis event is dispatched by a Sprite when an animation is stopped on it. An animation\rwill only be stopped if a method such as `Sprite.stop` or `Sprite.anims.stopAfterDelay`\ris called. It can also be emitted if a new animation is started before the current one completes.\r\rListen for it on the Sprite using `sprite.on('animationstop', listener)`\r\rThe animation event flow is as follows:\r\r1. `ANIMATION_START`\r2. `ANIMATION_UPDATE` (repeated for however many frames the animation has)\r3. `ANIMATION_REPEAT` (only if the animation is set to repeat, it then emits more update events after this)\r4. `ANIMATION_COMPLETE` (only if there is a finite, or zero, repeat count)\r5. `ANIMATION_COMPLETE_KEY` (only if there is a finite, or zero, repeat count)\r\rIf the animation is stopped directly, the `ANIMATION_STOP` event is dispatched instead of `ANIMATION_COMPLETE`.\r\rIf the animation is restarted while it is already playing, `ANIMATION_RESTART` is emitted.", "kind": "event", "name": "ANIMATION_STOP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation" } }, "description": "A reference to the Animation that has stopped.", "name": "animation" }, { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The current Animation Frame of the Animation.", "name": "frame" }, { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "A reference to the Game Object on which the animation stopped.", "name": "gameObject" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the Animation Frame within the Animation.", "name": "frameKey" } ], "memberof": "Phaser.Animations.Events", "longname": "Phaser.Animations.Events#event:ANIMATION_STOP", "scope": "instance", "___id": "T000002R001357", "___s": true }, { "comment": "/**\r\n * The Animation Update Event.\r\n *\r\n * This event is dispatched by a Sprite when an animation playing on it updates. This happens when the animation changes frame.\r\n * An animation will change frame based on the frame rate and other factors like `timeScale` and `delay`. It can also change\r\n * frame when stopped or restarted.\r\n *\r\n * Listen for it on the Sprite using `sprite.on('animationupdate', listener)`\r\n *\r\n * If an animation is playing faster than the game frame-rate can handle, it's entirely possible for it to emit several\r\n * update events in a single game frame, so please be aware of this in your code. The **final** event received that frame\r\n * is the one that is rendered to the game.\r\n *\r\n * The animation event flow is as follows:\r\n *\r\n * 1. `ANIMATION_START`\r\n * 2. `ANIMATION_UPDATE` (repeated for however many frames the animation has)\r\n * 3. `ANIMATION_REPEAT` (only if the animation is set to repeat, it then emits more update events after this)\r\n * 4. `ANIMATION_COMPLETE` (only if there is a finite, or zero, repeat count)\r\n * 5. `ANIMATION_COMPLETE_KEY` (only if there is a finite, or zero, repeat count)\r\n *\r\n * If the animation is stopped directly, the `ANIMATION_STOP` event is dispatched instead of `ANIMATION_COMPLETE`.\r\n *\r\n * If the animation is restarted while it is already playing, `ANIMATION_RESTART` is emitted.\r\n *\r\n * @event Phaser.Animations.Events#ANIMATION_UPDATE\r\n * @type {string}\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Animations.Animation} animation - A reference to the Animation that has updated.\r\n * @param {Phaser.Animations.AnimationFrame} frame - The current Animation Frame of the Animation.\r\n * @param {Phaser.GameObjects.Sprite} gameObject - A reference to the Game Object on which the animation updated.\r\n * @param {string} frameKey - The unique key of the Animation Frame within the Animation.\r\n */", "meta": { "filename": "ANIMATION_UPDATE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\events", "code": {} }, "description": "The Animation Update Event.\r\rThis event is dispatched by a Sprite when an animation playing on it updates. This happens when the animation changes frame.\rAn animation will change frame based on the frame rate and other factors like `timeScale` and `delay`. It can also change\rframe when stopped or restarted.\r\rListen for it on the Sprite using `sprite.on('animationupdate', listener)`\r\rIf an animation is playing faster than the game frame-rate can handle, it's entirely possible for it to emit several\rupdate events in a single game frame, so please be aware of this in your code. The **final** event received that frame\ris the one that is rendered to the game.\r\rThe animation event flow is as follows:\r\r1. `ANIMATION_START`\r2. `ANIMATION_UPDATE` (repeated for however many frames the animation has)\r3. `ANIMATION_REPEAT` (only if the animation is set to repeat, it then emits more update events after this)\r4. `ANIMATION_COMPLETE` (only if there is a finite, or zero, repeat count)\r5. `ANIMATION_COMPLETE_KEY` (only if there is a finite, or zero, repeat count)\r\rIf the animation is stopped directly, the `ANIMATION_STOP` event is dispatched instead of `ANIMATION_COMPLETE`.\r\rIf the animation is restarted while it is already playing, `ANIMATION_RESTART` is emitted.", "kind": "event", "name": "ANIMATION_UPDATE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.Animation" } }, "description": "A reference to the Animation that has updated.", "name": "animation" }, { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The current Animation Frame of the Animation.", "name": "frame" }, { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "A reference to the Game Object on which the animation updated.", "name": "gameObject" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the Animation Frame within the Animation.", "name": "frameKey" } ], "memberof": "Phaser.Animations.Events", "longname": "Phaser.Animations.Events#event:ANIMATION_UPDATE", "scope": "instance", "___id": "T000002R001359", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Animations.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Animations", "longname": "Phaser.Animations.Events", "scope": "static", "___id": "T000002R001361", "___s": true }, { "comment": "/**\r\n * The Pause All Animations Event.\r\n *\r\n * This event is dispatched when the global Animation Manager is told to pause.\r\n *\r\n * When this happens all current animations will stop updating, although it doesn't necessarily mean\r\n * that the game has paused as well.\r\n *\r\n * @event Phaser.Animations.Events#PAUSE_ALL\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PAUSE_ALL_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\events", "code": {} }, "description": "The Pause All Animations Event.\r\rThis event is dispatched when the global Animation Manager is told to pause.\r\rWhen this happens all current animations will stop updating, although it doesn't necessarily mean\rthat the game has paused as well.", "kind": "event", "name": "PAUSE_ALL", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Animations.Events", "longname": "Phaser.Animations.Events#event:PAUSE_ALL", "scope": "instance", "___id": "T000002R001374", "___s": true }, { "comment": "/**\r\n * The Remove Animation Event.\r\n *\r\n * This event is dispatched when an animation is removed from the global Animation Manager.\r\n *\r\n * @event Phaser.Animations.Events#REMOVE_ANIMATION\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key of the Animation that was removed from the global Animation Manager.\r\n * @param {Phaser.Animations.Animation} animation - An instance of the removed Animation.\r\n */", "meta": { "filename": "REMOVE_ANIMATION_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\events", "code": {} }, "description": "The Remove Animation Event.\r\rThis event is dispatched when an animation is removed from the global Animation Manager.", "kind": "event", "name": "REMOVE_ANIMATION", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Animation that was removed from the global Animation Manager.", "name": "key" }, { "type": { "names": [ "Phaser.Animations.Animation" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R001376", "___s": true }, { "comment": "/**\r\n * The Resume All Animations Event.\r\n *\r\n * This event is dispatched when the global Animation Manager resumes, having been previously paused.\r\n *\r\n * When this happens all current animations will continue updating again.\r\n *\r\n * @event Phaser.Animations.Events#RESUME_ALL\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "RESUME_ALL_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\events", "code": {} }, "description": "The Resume All Animations Event.\r\rThis event is dispatched when the global Animation Manager resumes, having been previously paused.\r\rWhen this happens all current animations will continue updating again.", "kind": "event", "name": "RESUME_ALL", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Animations.Events", "longname": "Phaser.Animations.Events#event:RESUME_ALL", "scope": "instance", "___id": "T000002R001378", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Animations\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations", "code": {} }, "kind": "namespace", "name": "Animations", "memberof": "Phaser", "longname": "Phaser.Animations", "scope": "static", "___id": "T000002R001380", "___s": true }, { "comment": "/**\n * @typedef {object} Phaser.Types.Animations.Animation\n * @since 3.0.0\n *\n * @property {string} [key] - The key that the animation will be associated with. i.e. sprite.animations.play(key)\n * @property {string|Phaser.Types.Animations.AnimationFrame[]} [frames] - Either a string, in which case it will use all frames from a texture with the matching key, or an array of Animation Frame configuration objects.\n * @property {boolean} [sortFrames=true] - If you provide a string for `frames` you can optionally have the frame names numerically sorted.\n * @property {string} [defaultTextureKey=null] - The key of the texture all frames of the animation will use. Can be overridden on a per frame basis.\n * @property {number} [frameRate] - The frame rate of playback in frames per second (default 24 if duration is null)\n * @property {number} [duration] - How long the animation should play for in milliseconds. If not given its derived from frameRate.\n * @property {boolean} [skipMissedFrames=true] - Skip frames if the time lags, or always advanced anyway?\n * @property {number} [delay=0] - Delay before starting playback. Value given in milliseconds.\n * @property {number} [repeat=0] - Number of times to repeat the animation (-1 for infinity)\n * @property {number} [repeatDelay=0] - Delay before the animation repeats. Value given in milliseconds.\n * @property {boolean} [yoyo=false] - Should the animation yoyo? (reverse back down to the start) before repeating?\n * @property {boolean} [showBeforeDelay=false] - If this animation has a delay, should it show the first frame immediately (true), or only after the delay (false)\n * @property {boolean} [showOnStart=false] - Should sprite.visible = true when the animation starts to play? This happens _after_ any delay, if set.\n * @property {boolean} [hideOnComplete=false] - Should sprite.visible = false when the animation finishes?\n * @property {boolean} [randomFrame=false] - Start playback of this animation from a randomly selected frame?\n */", "meta": { "filename": "Animation.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\typedefs", "code": {} }, "kind": "typedef", "name": "Animation", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The key that the animation will be associated with. i.e. sprite.animations.play(key)", "name": "key" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.AnimationFrame", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Either a string, in which case it will use all frames from a texture with the matching key, or an array of Animation Frame configuration objects.", "name": "frames" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If you provide a string for `frames` you can optionally have the frame names numerically sorted.", "name": "sortFrames" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The frame rate of playback in frames per second (default 24 if duration is null)", "name": "frameRate" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How long the animation should play for in milliseconds. If not given its derived from frameRate.", "name": "duration" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Skip frames if the time lags, or always advanced anyway?", "name": "skipMissedFrames" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Delay before starting playback. Value given in milliseconds.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Number of times to repeat the animation (-1 for infinity)", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Delay before the animation repeats. Value given in milliseconds.", "name": "repeatDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the animation yoyo? (reverse back down to the start) before repeating?", "name": "yoyo" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If this animation has a delay, should it show the first frame immediately (true), or only after the delay (false)", "name": "showBeforeDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should sprite.visible = true when the animation starts to play? This happens _after_ any delay, if set.", "name": "showOnStart" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should sprite.visible = false when the animation finishes?", "name": "hideOnComplete" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Start playback of this animation from a randomly selected frame?", "name": "randomFrame" } ], "memberof": "Phaser.Types.Animations", "longname": "Phaser.Types.Animations.Animation", "scope": "static", "___id": "T000002R001387", "___s": true }, { "comment": "/**\n * @typedef {object} Phaser.Types.Animations.AnimationFrame\n * @since 3.0.0\n *\n * @property {string} [key] - The key of the texture within the Texture Manager to use for this Animation Frame.\n * @property {(string|number)} [frame] - The key, or index number, of the frame within the texture to use for this Animation Frame.\n * @property {number} [duration=0] - The duration, in ms, of this frame of the animation.\n * @property {boolean} [visible] - Should the parent Game Object be visible during this frame of the animation?\n */", "meta": { "filename": "AnimationFrame.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\typedefs", "code": {} }, "kind": "typedef", "name": "AnimationFrame", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The key of the texture within the Texture Manager to use for this Animation Frame.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The key, or index number, of the frame within the texture to use for this Animation Frame.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The duration, in ms, of this frame of the animation.", "name": "duration" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Should the parent Game Object be visible during this frame of the animation?", "name": "visible" } ], "memberof": "Phaser.Types.Animations", "longname": "Phaser.Types.Animations.AnimationFrame", "scope": "static", "___id": "T000002R001388", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Animations.GenerateFrameNames\r\n * @since 3.0.0\r\n *\r\n * @property {string} [prefix=''] - The string to append to every resulting frame name if using a range or an array of `frames`.\r\n * @property {number} [start=0] - If `frames` is not provided, the number of the first frame to return.\r\n * @property {number} [end=0] - If `frames` is not provided, the number of the last frame to return.\r\n * @property {string} [suffix=''] - The string to append to every resulting frame name if using a range or an array of `frames`.\r\n * @property {number} [zeroPad=0] - 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.\r\n * @property {Phaser.Types.Animations.AnimationFrame[]} [outputArray=[]] - The array to append the created configuration objects to.\r\n * @property {(boolean|number[])} [frames=false] - If provided as an array, the range defined by `start` and `end` will be ignored and these frame numbers will be used.\r\n */", "meta": { "filename": "GenerateFrameNames.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\typedefs", "code": {} }, "kind": "typedef", "name": "GenerateFrameNames", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "If `frames` is not provided, the number of the first frame to return.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "If `frames` is not provided, the number of the last frame to return.", "name": "end" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.AnimationFrame", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[]", "description": "The array to append the created configuration objects to.", "name": "outputArray" }, { "type": { "names": [ "boolean", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "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", "___id": "T000002R001389", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Animations.GenerateFrameNumbers\r\n * @since 3.0.0\r\n *\r\n * @property {number} [start=0] - The starting frame of the animation.\r\n * @property {number} [end=-1] - The ending frame of the animation.\r\n * @property {(boolean|number)} [first=false] - A frame to put at the beginning of the animation, before `start` or `outputArray` or `frames`.\r\n * @property {Phaser.Types.Animations.AnimationFrame[]} [outputArray=[]] - An array to concatenate the output onto.\r\n * @property {(boolean|number[])} [frames=false] - A custom sequence of frames.\r\n */", "meta": { "filename": "GenerateFrameNumbers.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\typedefs", "code": {} }, "kind": "typedef", "name": "GenerateFrameNumbers", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The starting frame of the animation.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": -1, "description": "The ending frame of the animation.", "name": "end" }, { "type": { "names": [ "boolean", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "number" } ] } }, "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.AnimationFrame", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[]", "description": "An array to concatenate the output onto.", "name": "outputArray" }, { "type": { "names": [ "boolean", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "defaultvalue": false, "description": "A custom sequence of frames.", "name": "frames" } ], "memberof": "Phaser.Types.Animations", "longname": "Phaser.Types.Animations.GenerateFrameNumbers", "scope": "static", "___id": "T000002R001390", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Animations\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\typedefs", "code": {} }, "kind": "namespace", "name": "Animations", "memberof": "Phaser.Types", "longname": "Phaser.Types.Animations", "scope": "static", "___id": "T000002R001391", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Animations.JSONAnimation\r\n * @since 3.0.0\r\n *\r\n * @property {string} key - The key that the animation will be associated with. i.e. sprite.animations.play(key)\r\n * @property {string} type - A frame based animation (as opposed to a bone based animation)\r\n * @property {Phaser.Types.Animations.JSONAnimationFrame[]} frames - An array of the AnimationFrame objects inside this Animation.\r\n * @property {number} frameRate - The frame rate of playback in frames per second (default 24 if duration is null)\r\n * @property {number} duration - How long the animation should play for in milliseconds. If not given its derived from frameRate.\r\n * @property {boolean} skipMissedFrames - Skip frames if the time lags, or always advanced anyway?\r\n * @property {number} delay - Delay before starting playback. Value given in milliseconds.\r\n * @property {number} repeat - Number of times to repeat the animation (-1 for infinity)\r\n * @property {number} repeatDelay - Delay before the animation repeats. Value given in milliseconds.\r\n * @property {boolean} yoyo - Should the animation yoyo? (reverse back down to the start) before repeating?\r\n * @property {boolean} showBeforeDelay - If this animation has a delay, should it show the first frame immediately (true), or only after the delay (false)\r\n * @property {boolean} showOnStart - Should sprite.visible = true when the animation starts to play?\r\n * @property {boolean} hideOnComplete - Should sprite.visible = false when the animation finishes?\r\n * @property {boolean} [randomFrame] - Start playback of this animation from a randomly selected frame?\r\n */", "meta": { "filename": "JSONAnimation.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\typedefs", "code": {} }, "kind": "typedef", "name": "JSONAnimation", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key that the animation will be associated with. i.e. sprite.animations.play(key)", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A frame based animation (as opposed to a bone based animation)", "name": "type" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.JSONAnimationFrame", "type": "NameExpression" } ] } }, "description": "An array of the AnimationFrame objects inside this Animation.", "name": "frames" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The frame rate of playback in frames per second (default 24 if duration is null)", "name": "frameRate" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How long the animation should play for in milliseconds. If not given its derived from frameRate.", "name": "duration" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Skip frames if the time lags, or always advanced anyway?", "name": "skipMissedFrames" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Delay before starting playback. Value given in milliseconds.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Number of times to repeat the animation (-1 for infinity)", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Delay before the animation repeats. Value given in milliseconds.", "name": "repeatDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should the animation yoyo? (reverse back down to the start) before repeating?", "name": "yoyo" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If this animation has a delay, should it show the first frame immediately (true), or only after the delay (false)", "name": "showBeforeDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should sprite.visible = true when the animation starts to play?", "name": "showOnStart" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should sprite.visible = false when the animation finishes?", "name": "hideOnComplete" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Start playback of this animation from a randomly selected frame?", "name": "randomFrame" } ], "memberof": "Phaser.Types.Animations", "longname": "Phaser.Types.Animations.JSONAnimation", "scope": "static", "___id": "T000002R001392", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Animations.JSONAnimationFrame\r\n * @since 3.0.0\r\n *\r\n * @property {string} key - The key of the Texture this AnimationFrame uses.\r\n * @property {(string|number)} frame - The key of the Frame within the Texture that this AnimationFrame uses.\r\n * @property {number} duration - Additional time (in ms) that this frame should appear for during playback.\r\n */", "meta": { "filename": "JSONAnimationFrame.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\typedefs", "code": {} }, "kind": "typedef", "name": "JSONAnimationFrame", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Texture this AnimationFrame uses.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The key of the Frame within the Texture that this AnimationFrame uses.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R001393", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Animations.JSONAnimations\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Types.Animations.JSONAnimation[]} anims - An array of all Animations added to the Animation Manager.\r\n * @property {number} globalTimeScale - The global time scale of the Animation Manager.\r\n */", "meta": { "filename": "JSONAnimations.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\typedefs", "code": {} }, "kind": "typedef", "name": "JSONAnimations", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.JSONAnimation", "type": "NameExpression" } ] } }, "description": "An array of all Animations added to the Animation Manager.", "name": "anims" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The global time scale of the Animation Manager.", "name": "globalTimeScale" } ], "memberof": "Phaser.Types.Animations", "longname": "Phaser.Types.Animations.JSONAnimations", "scope": "static", "___id": "T000002R001394", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Animations.PlayAnimationConfig\r\n * @since 3.50.0\r\n *\r\n * @property {(string|Phaser.Animations.Animation)} key - The string-based key of the animation to play, or an Animation instance.\r\n * @property {number} [frameRate] - The frame rate of playback in frames per second (default 24 if duration is null)\r\n * @property {number} [duration] - How long the animation should play for in milliseconds. If not given its derived from frameRate.\r\n * @property {number} [delay] - Delay before starting playback. Value given in milliseconds.\r\n * @property {number} [repeat] - Number of times to repeat the animation (-1 for infinity)\r\n * @property {number} [repeatDelay] - Delay before the animation repeats. Value given in milliseconds.\r\n * @property {boolean} [yoyo] - Should the animation yoyo? (reverse back down to the start) before repeating?\r\n * @property {boolean} [showBeforeDelay] - If this animation has a delay, should it show the first frame immediately (true), or only after the delay (false)\r\n * @property {boolean} [showOnStart] - Should sprite.visible = true when the animation starts to play?\r\n * @property {boolean} [hideOnComplete] - Should sprite.visible = false when the animation finishes?\r\n * @property {boolean} [skipMissedFrames] - Skip frames if the time lags, or always advanced anyway?\r\n * @property {number} [startFrame] - The frame of the animation to start playback from.\r\n * @property {number} [timeScale] - The time scale to be applied to playback of this animation.\r\n * @property {boolean} [randomFrame] - Start playback of this animation from a randomly selected frame?\r\n */", "meta": { "filename": "PlayAnimationConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\animations\\typedefs", "code": {} }, "kind": "typedef", "name": "PlayAnimationConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "string", "Phaser.Animations.Animation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" } ] } }, "description": "The string-based key of the animation to play, or an Animation instance.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The frame rate of playback in frames per second (default 24 if duration is null)", "name": "frameRate" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "How long the animation should play for in milliseconds. If not given its derived from frameRate.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Delay before starting playback. Value given in milliseconds.", "name": "delay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Number of times to repeat the animation (-1 for infinity)", "name": "repeat" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Delay before the animation repeats. Value given in milliseconds.", "name": "repeatDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Should the animation yoyo? (reverse back down to the start) before repeating?", "name": "yoyo" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If this animation has a delay, should it show the first frame immediately (true), or only after the delay (false)", "name": "showBeforeDelay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Should sprite.visible = true when the animation starts to play?", "name": "showOnStart" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Should sprite.visible = false when the animation finishes?", "name": "hideOnComplete" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Skip frames if the time lags, or always advanced anyway?", "name": "skipMissedFrames" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The frame of the animation to start playback from.", "name": "startFrame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The time scale to be applied to playback of this animation.", "name": "timeScale" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Start playback of this animation from a randomly selected frame?", "name": "randomFrame" } ], "memberof": "Phaser.Types.Animations", "longname": "Phaser.Types.Animations.PlayAnimationConfig", "scope": "static", "___id": "T000002R001395", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A key-value store used by the Phaser framework to cache loaded assets and other data.\r\n * Items are stored and retrieved using string-based keys. The BaseCache emits events when\r\n * items are added or removed, allowing other systems to react to cache changes. Multiple\r\n * BaseCache instances are owned by the CacheManager, one per asset type (JSON, binary,\r\n * audio, etc.), and you can also create custom caches via `CacheManager.addCustom()`.\r\n *\r\n * @class BaseCache\r\n * @memberof Phaser.Cache\r\n * @constructor\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCache.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "classdesc": "A key-value store used by the Phaser framework to cache loaded assets and other data.\rItems are stored and retrieved using string-based keys. The BaseCache emits events when\ritems are added or removed, allowing other systems to react to cache changes. Multiple\rBaseCache instances are owned by the CacheManager, one per asset type (JSON, binary,\raudio, etc.), and you can also create custom caches via `CacheManager.addCustom()`.", "kind": "class", "name": "BaseCache", "memberof": "Phaser.Cache", "since": "3.0.0", "scope": "static", "longname": "Phaser.Cache.BaseCache", "___id": "T000002R001400", "___s": true }, { "comment": "/**\r\n * The Map in which the cache objects are stored.\r\n *\r\n * You can query the Map directly or use the BaseCache methods.\r\n *\r\n * @name Phaser.Cache.BaseCache#entries\r\n * @type {Phaser.Structs.Map.}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCache.js", "lineno": 31, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "The Map in which the cache objects are stored.\r\rYou can query the Map directly or use the BaseCache methods.", "name": "entries", "type": { "names": [ "Phaser.Structs.Map." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.Map" }, "applications": [ { "type": "NameExpression", "name": "String" }, { "type": "AllLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Cache.BaseCache", "longname": "Phaser.Cache.BaseCache#entries", "scope": "instance", "kind": "member", "___id": "T000002R001403", "___s": true }, { "comment": "/**\r\n * An instance of EventEmitter used by the cache to emit related events.\r\n *\r\n * @name Phaser.Cache.BaseCache#events\r\n * @type {Phaser.Events.EventEmitter}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCache.js", "lineno": 42, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "An instance of EventEmitter used by the cache to emit related events.", "name": "events", "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "since": "3.0.0", "memberof": "Phaser.Cache.BaseCache", "longname": "Phaser.Cache.BaseCache#events", "scope": "instance", "kind": "member", "___id": "T000002R001405", "___s": true }, { "comment": "/**\r\n * Adds an item to this cache. The item is referenced by a unique string, which you are responsible\r\n * for setting and keeping track of. The item can only be retrieved by using this string.\r\n *\r\n * @method Phaser.Cache.BaseCache#add\r\n * @fires Phaser.Cache.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique key by which the data added to the cache will be referenced.\r\n * @param {*} data - The data to be stored in the cache.\r\n *\r\n * @return {this} This BaseCache object.\r\n */", "meta": { "filename": "BaseCache.js", "lineno": 52, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "Adds an item to this cache. The item is referenced by a unique string, which you are responsible\rfor 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key by which the data added to the cache will be referenced.", "name": "key" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The data to be stored in the cache.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BaseCache object." } ], "memberof": "Phaser.Cache.BaseCache", "longname": "Phaser.Cache.BaseCache#add", "scope": "instance", "___id": "T000002R001407", "___s": true }, { "comment": "/**\r\n * Checks if this cache contains an item matching the given key.\r\n * This performs the same action as `BaseCache.exists`.\r\n *\r\n * @method Phaser.Cache.BaseCache#has\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique key of the item to be checked in this cache.\r\n *\r\n * @return {boolean} Returns `true` if the cache contains an item matching the given key, otherwise `false`.\r\n */", "meta": { "filename": "BaseCache.js", "lineno": 74, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "Checks if this cache contains an item matching the given key.\rThis performs the same action as `BaseCache.exists`.", "kind": "function", "name": "has", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the item to be checked in this cache.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R001409", "___s": true }, { "comment": "/**\r\n * Checks if this cache contains an item matching the given key.\r\n * This performs the same action as `BaseCache.has` and is called directly by the Loader.\r\n *\r\n * @method Phaser.Cache.BaseCache#exists\r\n * @since 3.7.0\r\n *\r\n * @param {string} key - The unique key of the item to be checked in this cache.\r\n *\r\n * @return {boolean} Returns `true` if the cache contains an item matching the given key, otherwise `false`.\r\n */", "meta": { "filename": "BaseCache.js", "lineno": 90, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "Checks if this cache contains an item matching the given key.\rThis 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the item to be checked in this cache.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R001411", "___s": true }, { "comment": "/**\r\n * Gets an item from this cache based on the given key.\r\n *\r\n * @method Phaser.Cache.BaseCache#get\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique key of the item to be retrieved from this cache.\r\n *\r\n * @return {*} The item in the cache, or `null` if no item matching the given key was found.\r\n */", "meta": { "filename": "BaseCache.js", "lineno": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "Gets an item from this cache based on the given key.", "kind": "function", "name": "get", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the item to be retrieved from this cache.", "name": "key" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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", "___id": "T000002R001413", "___s": true }, { "comment": "/**\r\n * Removes an item from this cache based on the given key.\r\n *\r\n * If an entry matching the key is found it is removed from the cache and a `remove` event emitted.\r\n * No additional checks are done on the item removed. If other systems or parts of your game code\r\n * are relying on this item, it is up to you to sever those relationships prior to removing the item.\r\n *\r\n * @method Phaser.Cache.BaseCache#remove\r\n * @fires Phaser.Cache.Events#REMOVE\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique key of the item to remove from the cache.\r\n *\r\n * @return {this} This BaseCache object.\r\n */", "meta": { "filename": "BaseCache.js", "lineno": 121, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "Removes an item from this cache based on the given key.\r\rIf an entry matching the key is found it is removed from the cache and a `remove` event emitted.\rNo additional checks are done on the item removed. If other systems or parts of your game code\rare 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the item to remove from the cache.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BaseCache object." } ], "memberof": "Phaser.Cache.BaseCache", "longname": "Phaser.Cache.BaseCache#remove", "scope": "instance", "___id": "T000002R001415", "___s": true }, { "comment": "/**\r\n * Returns all keys in use in this cache.\r\n *\r\n * @method Phaser.Cache.BaseCache#getKeys\r\n * @since 3.17.0\r\n *\r\n * @return {string[]} An array of strings containing all keys currently stored in this cache.\r\n */", "meta": { "filename": "BaseCache.js", "lineno": 150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "Returns all keys in use in this cache.", "kind": "function", "name": "getKeys", "since": "3.17.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "An array of strings containing all keys currently stored in this cache." } ], "memberof": "Phaser.Cache.BaseCache", "longname": "Phaser.Cache.BaseCache#getKeys", "scope": "instance", "___id": "T000002R001418", "___s": true }, { "comment": "/**\r\n * Destroys this cache and all items within it. Clears the entries Map, removes all\r\n * event listeners from the EventEmitter, and nulls the internal references.\r\n *\r\n * @method Phaser.Cache.BaseCache#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCache.js", "lineno": 163, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "Destroys this cache and all items within it. Clears the entries Map, removes all\revent listeners from the EventEmitter, and nulls the internal references.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Cache.BaseCache", "longname": "Phaser.Cache.BaseCache#destroy", "scope": "instance", "___id": "T000002R001420", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Cache Manager is the global cache owned and maintained by the Game instance.\r\n *\r\n * Various systems, such as the file Loader, rely on this cache in order to store the files\r\n * they have loaded. The manager itself doesn't store any files, but instead owns multiple BaseCache\r\n * instances, one per type of file. Built-in caches are provided for binary files, bitmap fonts,\r\n * JSON, physics data, shaders, audio, video, text, HTML, WaveFront OBJ, tilemaps, and XML.\r\n * You can also add your own custom caches via the `addCustom` method.\r\n *\r\n * The Cache Manager is available in any Scene via `this.cache` and is shared across all Scenes.\r\n *\r\n * @class CacheManager\r\n * @memberof Phaser.Cache\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser.Game instance that owns this CacheManager.\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "classdesc": "The Cache Manager is the global cache owned and maintained by the Game instance.\r\rVarious systems, such as the file Loader, rely on this cache in order to store the files\rthey have loaded. The manager itself doesn't store any files, but instead owns multiple BaseCache\rinstances, one per type of file. Built-in caches are provided for binary files, bitmap fonts,\rJSON, physics data, shaders, audio, video, text, HTML, WaveFront OBJ, tilemaps, and XML.\rYou can also add your own custom caches via the `addCustom` method.\r\rThe Cache Manager is available in any Scene via `this.cache` and is shared across all Scenes.", "kind": "class", "name": "CacheManager", "memberof": "Phaser.Cache", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "A reference to the Phaser.Game instance that owns this CacheManager.", "name": "game" } ], "scope": "static", "longname": "Phaser.Cache.CacheManager", "___id": "T000002R001428", "___s": true }, { "comment": "/**\r\n * A reference to the Phaser.Game instance that owns this CacheManager.\r\n *\r\n * @name Phaser.Cache.CacheManager#game\r\n * @type {Phaser.Game}\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 36, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "A reference to the Phaser.Game instance that owns this CacheManager.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "access": "protected", "since": "3.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#game", "scope": "instance", "kind": "member", "___id": "T000002R001431", "___s": true }, { "comment": "/**\r\n * A Cache storing all binary files, typically added via the Loader.\r\n *\r\n * @name Phaser.Cache.CacheManager#binary\r\n * @type {Phaser.Cache.BaseCache}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 46, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "A Cache storing all binary files, typically added via the Loader.", "name": "binary", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "since": "3.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#binary", "scope": "instance", "kind": "member", "___id": "T000002R001433", "___s": true }, { "comment": "/**\r\n * A Cache storing all bitmap font data files, typically added via the Loader.\r\n * Only the font data is stored in this cache, the textures are part of the Texture Manager.\r\n *\r\n * @name Phaser.Cache.CacheManager#bitmapFont\r\n * @type {Phaser.Cache.BaseCache}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 55, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "A Cache storing all bitmap font data files, typically added via the Loader.\rOnly the font data is stored in this cache, the textures are part of the Texture Manager.", "name": "bitmapFont", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "since": "3.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#bitmapFont", "scope": "instance", "kind": "member", "___id": "T000002R001435", "___s": true }, { "comment": "/**\r\n * A Cache storing all JSON data files, typically added via the Loader.\r\n *\r\n * @name Phaser.Cache.CacheManager#json\r\n * @type {Phaser.Cache.BaseCache}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "A Cache storing all JSON data files, typically added via the Loader.", "name": "json", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "since": "3.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#json", "scope": "instance", "kind": "member", "___id": "T000002R001437", "___s": true }, { "comment": "/**\r\n * A Cache storing all physics data files, typically added via the Loader.\r\n *\r\n * @name Phaser.Cache.CacheManager#physics\r\n * @type {Phaser.Cache.BaseCache}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "A Cache storing all physics data files, typically added via the Loader.", "name": "physics", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "since": "3.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#physics", "scope": "instance", "kind": "member", "___id": "T000002R001439", "___s": true }, { "comment": "/**\r\n * A Cache storing all shader source files, typically added via the Loader.\r\n *\r\n * @name Phaser.Cache.CacheManager#shader\r\n * @type {Phaser.Cache.BaseCache}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "A Cache storing all shader source files, typically added via the Loader.", "name": "shader", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "since": "3.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#shader", "scope": "instance", "kind": "member", "___id": "T000002R001441", "___s": true }, { "comment": "/**\r\n * A Cache storing all non-streaming audio files, typically added via the Loader.\r\n *\r\n * @name Phaser.Cache.CacheManager#audio\r\n * @type {Phaser.Cache.BaseCache}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "A Cache storing all non-streaming audio files, typically added via the Loader.", "name": "audio", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "since": "3.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#audio", "scope": "instance", "kind": "member", "___id": "T000002R001443", "___s": true }, { "comment": "/**\r\n * A Cache storing all non-streaming video files, typically added via the Loader.\r\n *\r\n * @name Phaser.Cache.CacheManager#video\r\n * @type {Phaser.Cache.BaseCache}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 101, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "A Cache storing all non-streaming video files, typically added via the Loader.", "name": "video", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "since": "3.20.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#video", "scope": "instance", "kind": "member", "___id": "T000002R001445", "___s": true }, { "comment": "/**\r\n * A Cache storing all text files, typically added via the Loader.\r\n *\r\n * @name Phaser.Cache.CacheManager#text\r\n * @type {Phaser.Cache.BaseCache}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "A Cache storing all text files, typically added via the Loader.", "name": "text", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "since": "3.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#text", "scope": "instance", "kind": "member", "___id": "T000002R001447", "___s": true }, { "comment": "/**\r\n * A Cache storing all html files, typically added via the Loader.\r\n *\r\n * @name Phaser.Cache.CacheManager#html\r\n * @type {Phaser.Cache.BaseCache}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 119, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "A Cache storing all html files, typically added via the Loader.", "name": "html", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "since": "3.12.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#html", "scope": "instance", "kind": "member", "___id": "T000002R001449", "___s": true }, { "comment": "/**\r\n * A Cache storing all tilemap data files, typically added via the Loader.\r\n * Only the data is stored in this cache, the textures are part of the Texture Manager.\r\n *\r\n * @name Phaser.Cache.CacheManager#tilemap\r\n * @type {Phaser.Cache.BaseCache}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 128, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "A Cache storing all tilemap data files, typically added via the Loader.\rOnly the data is stored in this cache, the textures are part of the Texture Manager.", "name": "tilemap", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "since": "3.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#tilemap", "scope": "instance", "kind": "member", "___id": "T000002R001451", "___s": true }, { "comment": "/**\r\n * A Cache storing all xml data files, typically added via the Loader.\r\n *\r\n * @name Phaser.Cache.CacheManager#xml\r\n * @type {Phaser.Cache.BaseCache}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 138, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "A Cache storing all xml data files, typically added via the Loader.", "name": "xml", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "since": "3.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#xml", "scope": "instance", "kind": "member", "___id": "T000002R001453", "___s": true }, { "comment": "/**\r\n * A Cache storing all Phaser Compact Texture Atlas data files, typically added via the Loader.\r\n *\r\n * @name Phaser.Cache.CacheManager#atlas\r\n * @type {Phaser.Cache.BaseCache}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 147, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "A Cache storing all Phaser Compact Texture Atlas data files, typically added via the Loader.", "name": "atlas", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "since": "4.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#atlas", "scope": "instance", "kind": "member", "___id": "T000002R001455", "___s": true }, { "comment": "/**\r\n * An object that contains your own custom BaseCache entries.\r\n * Add to this via the `addCustom` method.\r\n *\r\n * @name Phaser.Cache.CacheManager#custom\r\n * @type {Object.}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 156, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "An object that contains your own custom BaseCache entries.\rAdd to this via the `addCustom` method.", "name": "custom", "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } ] } }, "since": "3.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#custom", "scope": "instance", "kind": "member", "___id": "T000002R001457", "___s": true }, { "comment": "/**\r\n * Add your own custom Cache for storing your own files.\r\n * The cache will be available under `Cache.custom.key`.\r\n * The cache will only be created if the key is not already in use.\r\n *\r\n * @method Phaser.Cache.CacheManager#addCustom\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique key of your custom cache.\r\n *\r\n * @return {Phaser.Cache.BaseCache} A reference to the BaseCache that was created. If the key was already in use, a reference to the existing cache is returned instead.\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 169, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "Add your own custom Cache for storing your own files.\rThe cache will be available under `Cache.custom.key`.\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of your custom cache.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R001459", "___s": true }, { "comment": "/**\r\n * Destroys all built-in BaseCaches and all custom caches, then nulls their references. Called automatically when the Game instance is destroyed.\r\n *\r\n * @method Phaser.Cache.CacheManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CacheManager.js", "lineno": 191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "description": "Destroys all built-in BaseCaches and all custom caches, then nulls their references. Called automatically when the Game instance is destroyed.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Cache.CacheManager", "longname": "Phaser.Cache.CacheManager#destroy", "scope": "instance", "___id": "T000002R001462", "___s": true }, { "comment": "/**\r\n * The Cache Add Event.\r\n *\r\n * This event is dispatched by any Cache that extends the BaseCache each time a new object is added to it.\r\n *\r\n * @event Phaser.Cache.Events#ADD\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cache.BaseCache} cache - The cache to which the object was added.\r\n * @param {string} key - The key of the object added to the cache.\r\n * @param {*} object - A reference to the object that was added to the cache.\r\n */", "meta": { "filename": "ADD_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cache\\events", "code": {} }, "description": "The Cache Add Event.\r\rThis event is dispatched by any Cache that extends the BaseCache each time a new object is added to it.", "kind": "event", "name": "ADD", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "description": "The cache to which the object was added.", "name": "cache" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the object added to the cache.", "name": "key" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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", "___id": "T000002R001471", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Cache.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cache\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Cache", "longname": "Phaser.Cache.Events", "scope": "static", "___id": "T000002R001473", "___s": true }, { "comment": "/**\r\n * The Cache Remove Event.\r\n *\r\n * This event is dispatched by any Cache that extends the BaseCache each time an object is removed from it.\r\n *\r\n * @event Phaser.Cache.Events#REMOVE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cache.BaseCache} cache - The cache from which the object was removed.\r\n * @param {string} key - The key of the object removed from the cache.\r\n * @param {*} object - A reference to the object that was removed from the cache.\r\n */", "meta": { "filename": "REMOVE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cache\\events", "code": {} }, "description": "The Cache Remove Event.\r\rThis event is dispatched by any Cache that extends the BaseCache each time an object is removed from it.", "kind": "event", "name": "REMOVE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "description": "The cache from which the object was removed.", "name": "cache" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the object removed from the cache.", "name": "key" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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", "___id": "T000002R001477", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Cache\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cache", "code": {} }, "kind": "namespace", "name": "Cache", "memberof": "Phaser", "longname": "Phaser.Cache", "scope": "static", "___id": "T000002R001479", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Base Camera class.\r\n *\r\n * The Camera is the way in which all games are rendered in Phaser. They provide a view into your game world,\r\n * and can be positioned, rotated, zoomed and scrolled accordingly.\r\n *\r\n * A Camera consists of two elements: The viewport and the scroll values.\r\n *\r\n * The viewport is the physical position and size of the Camera within your game. Cameras, by default, are\r\n * created the same size as your game, but their position and size can be set to anything. This means if you\r\n * wanted to create a camera that was 320x200 in size, positioned in the bottom-right corner of your game,\r\n * you'd adjust the viewport to do that (using methods like `setViewport` and `setSize`).\r\n *\r\n * If you wish to change where the Camera is looking in your game, then you scroll it. You can do this\r\n * via the properties `scrollX` and `scrollY` or the method `setScroll`. Scrolling has no impact on the\r\n * viewport, and changing the viewport has no impact on the scrolling.\r\n *\r\n * By default a Camera will render all Game Objects it can see. You can change this using the `ignore` method,\r\n * allowing you to filter Game Objects out on a per-Camera basis.\r\n *\r\n * The Base Camera is extended by the Camera class, which adds in special effects including Fade,\r\n * Flash and Camera Shake, as well as the ability to follow Game Objects.\r\n *\r\n * The Base Camera was introduced in Phaser 3.12. It was split off from the Camera class, to allow\r\n * you to isolate special effects as needed. Therefore the 'since' values for properties of this class relate\r\n * to when they were added to the Camera class.\r\n *\r\n * @class BaseCamera\r\n * @memberof Phaser.Cameras.Scene2D\r\n * @constructor\r\n * @since 3.12.0\r\n *\r\n * @extends Phaser.Events.EventEmitter\r\n * @extends Phaser.GameObjects.Components.AlphaSingle\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {number} x - The x position of the Camera, relative to the top-left of the game canvas.\r\n * @param {number} y - The y position of the Camera, relative to the top-left of the game canvas.\r\n * @param {number} width - The width of the Camera, in pixels.\r\n * @param {number} height - The height of the Camera, in pixels.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 18, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "classdesc": "A Base Camera class.\r\rThe Camera is the way in which all games are rendered in Phaser. They provide a view into your game world,\rand can be positioned, rotated, zoomed and scrolled accordingly.\r\rA Camera consists of two elements: The viewport and the scroll values.\r\rThe viewport is the physical position and size of the Camera within your game. Cameras, by default, are\rcreated the same size as your game, but their position and size can be set to anything. This means if you\rwanted to create a camera that was 320x200 in size, positioned in the bottom-right corner of your game,\ryou'd adjust the viewport to do that (using methods like `setViewport` and `setSize`).\r\rIf you wish to change where the Camera is looking in your game, then you scroll it. You can do this\rvia the properties `scrollX` and `scrollY` or the method `setScroll`. Scrolling has no impact on the\rviewport, and changing the viewport has no impact on the scrolling.\r\rBy default a Camera will render all Game Objects it can see. You can change this using the `ignore` method,\rallowing you to filter Game Objects out on a per-Camera basis.\r\rThe Base Camera is extended by the Camera class, which adds in special effects including Fade,\rFlash and Camera Shake, as well as the ability to follow Game Objects.\r\rThe Base Camera was introduced in Phaser 3.12. It was split off from the Camera class, to allow\ryou to isolate special effects as needed. Therefore the 'since' values for properties of this class relate\rto 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.AlphaSingle", "Phaser.GameObjects.Components.Visible" ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the Camera, relative to the top-left of the game canvas.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the Camera, relative to the top-left of the game canvas.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the Camera, in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the Camera, in pixels.", "name": "height" } ], "scope": "static", "longname": "Phaser.Cameras.Scene2D.BaseCamera", "___id": "T000002R001494", "___s": true }, { "comment": "/**\r\n * A reference to the Scene this camera belongs to.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "A reference to the Scene this camera belongs to.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#scene", "scope": "instance", "kind": "member", "___id": "T000002R001503", "___s": true }, { "comment": "/**\r\n * A reference to the Game Scene Manager.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#sceneManager\r\n * @type {Phaser.Scenes.SceneManager}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 89, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "A reference to the Game Scene Manager.", "name": "sceneManager", "type": { "names": [ "Phaser.Scenes.SceneManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.SceneManager" } }, "since": "3.12.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#sceneManager", "scope": "instance", "kind": "member", "___id": "T000002R001505", "___s": true }, { "comment": "/**\r\n * A reference to the Game Scale Manager.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#scaleManager\r\n * @type {Phaser.Scale.ScaleManager}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "A reference to the Game Scale Manager.", "name": "scaleManager", "type": { "names": [ "Phaser.Scale.ScaleManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.ScaleManager" } }, "since": "3.16.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#scaleManager", "scope": "instance", "kind": "member", "___id": "T000002R001507", "___s": true }, { "comment": "/**\r\n * A reference to the Scene's Camera Manager to which this Camera belongs.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#cameraManager\r\n * @type {Phaser.Cameras.Scene2D.CameraManager}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "A reference to the Scene's Camera Manager to which this Camera belongs.", "name": "cameraManager", "type": { "names": [ "Phaser.Cameras.Scene2D.CameraManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.CameraManager" } }, "since": "3.17.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#cameraManager", "scope": "instance", "kind": "member", "___id": "T000002R001509", "___s": true }, { "comment": "/**\r\n * The Camera ID. Assigned by the Camera Manager and used to handle camera exclusion.\r\n * This value is a bitmask.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#id\r\n * @type {number}\r\n * @readonly\r\n * @since 3.11.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Camera ID. Assigned by the Camera Manager and used to handle camera exclusion.\rThis value is a bitmask.", "name": "id", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#id", "scope": "instance", "kind": "member", "___id": "T000002R001511", "___s": true }, { "comment": "/**\r\n * The name of the Camera. This is left empty for your own use.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#name\r\n * @type {string}\r\n * @default ''\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 127, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The name of the Camera. This is left empty for your own use.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#name", "scope": "instance", "kind": "member", "___id": "T000002R001513", "___s": true }, { "comment": "/**\r\n * Should this camera round its pixel values to integers?\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#roundPixels\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 137, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Should this camera round its pixel values to integers?", "name": "roundPixels", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#roundPixels", "scope": "instance", "kind": "member", "___id": "T000002R001515", "___s": true }, { "comment": "/**\r\n * Is this Camera visible or not?\r\n *\r\n * A visible camera will render and perform input tests.\r\n * An invisible camera will not render anything and will skip input tests.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#visible\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.10.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 147, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Is this Camera visible or not?\r\rA visible camera will render and perform input tests.\rAn invisible camera will not render anything and will skip input tests.", "name": "visible", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R001517", "___s": true }, { "comment": "/**\r\n * Is this Camera using a bounds to restrict scrolling movement?\r\n *\r\n * Set this property along with the bounds via `Camera.setBounds`.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#useBounds\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Is this Camera using a bounds to restrict scrolling movement?\r\rSet this property along with the bounds via `Camera.setBounds`.", "name": "useBounds", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#useBounds", "scope": "instance", "kind": "member", "___id": "T000002R001518", "___s": true }, { "comment": "/**\r\n * The World View is a Rectangle that defines the area of the 'world' the Camera is currently looking at.\r\n * This factors in the Camera viewport size, zoom and scroll position and is updated in the Camera preRender step.\r\n * If you have enabled Camera bounds the worldview will be clamped to those bounds accordingly.\r\n * You can use it for culling or intersection checks.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#worldView\r\n * @type {Phaser.Geom.Rectangle}\r\n * @readonly\r\n * @since 3.11.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 171, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The World View is a Rectangle that defines the area of the 'world' the Camera is currently looking at.\rThis factors in the Camera viewport size, zoom and scroll position and is updated in the Camera preRender step.\rIf you have enabled Camera bounds the worldview will be clamped to those bounds accordingly.\rYou can use it for culling or intersection checks.", "name": "worldView", "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "readonly": true, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#worldView", "scope": "instance", "kind": "member", "___id": "T000002R001520", "___s": true }, { "comment": "/**\r\n * Is this Camera dirty?\r\n *\r\n * A dirty Camera has had either its viewport size, bounds, scroll, rotation or zoom levels changed since the last frame.\r\n *\r\n * This flag is cleared during rendering with the new values.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#dirty\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.11.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 184, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Is this Camera dirty?\r\rA dirty Camera has had either its viewport size, bounds, scroll, rotation or zoom levels changed since the last frame.\r\rThis flag is cleared during rendering with the new values.", "name": "dirty", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#dirty", "scope": "instance", "kind": "member", "___id": "T000002R001522", "___s": true }, { "comment": "/**\r\n * A local transform matrix combining `matrix` and `matrixExternal`.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#matrixCombined\r\n * @type {Phaser.GameObjects.Components.TransformMatrix}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 367, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "A local transform matrix combining `matrix` and `matrixExternal`.", "name": "matrixCombined", "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "since": "4.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#matrixCombined", "scope": "instance", "kind": "member", "___id": "T000002R001546", "___s": true }, { "comment": "/**\r\n * A local transform matrix used to compute the camera location.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#matrixExternal\r\n * @type {Phaser.GameObjects.Components.TransformMatrix}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 376, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "A local transform matrix used to compute the camera location.", "name": "matrixExternal", "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "since": "4.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#matrixExternal", "scope": "instance", "kind": "member", "___id": "T000002R001548", "___s": true }, { "comment": "/**\r\n * Does this Camera have a transparent background?\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#transparent\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 385, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Does this Camera have a transparent background?", "name": "transparent", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#transparent", "scope": "instance", "kind": "member", "___id": "T000002R001550", "___s": true }, { "comment": "/**\r\n * The background color of this Camera. Only used if `transparent` is `false`.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#backgroundColor\r\n * @type {Phaser.Display.Color}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 395, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The background color of this Camera. Only used if `transparent` is `false`.", "name": "backgroundColor", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#backgroundColor", "scope": "instance", "kind": "member", "___id": "T000002R001552", "___s": true }, { "comment": "/**\r\n * The Camera alpha value. Setting this property impacts every single object that this Camera\r\n * renders. You can either set the property directly, i.e. via a Tween, to fade a Camera in or out,\r\n * or via the chainable `setAlpha` method instead.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#alpha\r\n * @type {number}\r\n * @default 1\r\n * @since 3.11.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 404, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Camera alpha value. Setting this property impacts every single object that this Camera\rrenders. You can either set the property directly, i.e. via a Tween, to fade a Camera in or out,\ror via the chainable `setAlpha` method instead.", "name": "alpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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.AlphaSingle#alpha", "___id": "T000002R001554", "___s": true }, { "comment": "/**\r\n * Should the camera cull Game Objects before checking them for input hit tests?\r\n * In some special cases it may be beneficial to disable this.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#disableCull\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 415, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Should the camera cull Game Objects before checking them for input hit tests?\rIn some special cases it may be beneficial to disable this.", "name": "disableCull", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#disableCull", "scope": "instance", "kind": "member", "___id": "T000002R001555", "___s": true }, { "comment": "/**\r\n * The mid-point of the Camera in 'world' coordinates.\r\n *\r\n * Use it to obtain exactly where in the world the center of the camera is currently looking.\r\n *\r\n * This value is updated in the preRender method, after the scroll values and follower\r\n * have been processed.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#midPoint\r\n * @type {Phaser.Math.Vector2}\r\n * @readonly\r\n * @since 3.11.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 437, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The mid-point of the Camera in 'world' coordinates.\r\rUse it to obtain exactly where in the world the center of the camera is currently looking.\r\rThis value is updated in the preRender method, after the scroll values and follower\rhave been processed.", "name": "midPoint", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#midPoint", "scope": "instance", "kind": "member", "___id": "T000002R001559", "___s": true }, { "comment": "/**\r\n * The horizontal origin of rotation for this Camera.\r\n *\r\n * By default the camera rotates around the center of the viewport.\r\n *\r\n * Changing the origin allows you to adjust the point in the viewport from which rotation happens.\r\n * A value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.\r\n *\r\n * See `setOrigin` to set both origins in a single, chainable call.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#originX\r\n * @type {number}\r\n * @default 0.5\r\n * @since 3.11.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 452, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The horizontal origin of rotation for this Camera.\r\rBy default the camera rotates around the center of the viewport.\r\rChanging the origin allows you to adjust the point in the viewport from which rotation happens.\rA value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.\r\rSee `setOrigin` to set both origins in a single, chainable call.", "name": "originX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.5", "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#originX", "scope": "instance", "kind": "member", "___id": "T000002R001561", "___s": true }, { "comment": "/**\r\n * The vertical origin of rotation for this Camera.\r\n *\r\n * By default the camera rotates around the center of the viewport.\r\n *\r\n * Changing the origin allows you to adjust the point in the viewport from which rotation happens.\r\n * A value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.\r\n *\r\n * See `setOrigin` to set both origins in a single, chainable call.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#originY\r\n * @type {number}\r\n * @default 0.5\r\n * @since 3.11.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 469, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The vertical origin of rotation for this Camera.\r\rBy default the camera rotates around the center of the viewport.\r\rChanging the origin allows you to adjust the point in the viewport from which rotation happens.\rA value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.\r\rSee `setOrigin` to set both origins in a single, chainable call.", "name": "originY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.5", "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#originY", "scope": "instance", "kind": "member", "___id": "T000002R001563", "___s": true }, { "comment": "/**\r\n * The Mask this Camera is using during render.\r\n * Set the mask using the `setMask` method. Remove the mask using the `clearMask` method.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#mask\r\n * @type {?Phaser.Display.Masks.GeometryMask}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 497, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Mask this Camera is using during render.\rSet the mask using the `setMask` method. Remove the mask using the `clearMask` method.", "name": "mask", "type": { "names": [ "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask", "nullable": true } }, "nullable": true, "since": "3.17.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#mask", "scope": "instance", "kind": "member", "___id": "T000002R001567", "___s": true }, { "comment": "/**\r\n * This array is populated with all of the Game Objects that this Camera has rendered\r\n * in the previous (or current, depending on when you inspect it) frame.\r\n *\r\n * It is cleared at the start of `Camera.preUpdate`, or if the Camera is destroyed.\r\n *\r\n * You should not modify this array as it is used internally by the input system,\r\n * however you can read it as required. Note that Game Objects may appear in this\r\n * list multiple times if they belong to multiple non-exclusive Containers.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#renderList\r\n * @type {Phaser.GameObjects.GameObject[]}\r\n * @since 3.52.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 521, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "This array is populated with all of the Game Objects that this Camera has rendered\rin the previous (or current, depending on when you inspect it) frame.\r\rIt is cleared at the start of `Camera.preUpdate`, or if the Camera is destroyed.\r\rYou should not modify this array as it is used internally by the input system,\rhowever you can read it as required. Note that Game Objects may appear in this\rlist multiple times if they belong to multiple non-exclusive Containers.", "name": "renderList", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "since": "3.52.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#renderList", "scope": "instance", "kind": "member", "___id": "T000002R001571", "___s": true }, { "comment": "/**\r\n * Is this Camera a Scene Camera? (which is the default), or a Camera\r\n * belonging to a Texture?\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#isSceneCamera\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 537, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Is this Camera a Scene Camera? (which is the default), or a Camera\rbelonging to a Texture?", "name": "isSceneCamera", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#isSceneCamera", "scope": "instance", "kind": "member", "___id": "T000002R001573", "___s": true }, { "comment": "/**\r\n * Whether to force the camera to render via a framebuffer.\r\n * This only applies when using the WebGL renderer.\r\n * This makes the camera contents available to other WebGL processes,\r\n * such as `CaptureFrame`.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#forceComposite\r\n * @type {boolean}\r\n * @default false\r\n * @since 4.0.0\r\n * @webglOnly\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 548, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Whether to force the camera to render via a framebuffer.\rThis only applies when using the WebGL renderer.\rThis makes the camera contents available to other WebGL processes,\rsuch as `CaptureFrame`.", "name": "forceComposite", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "4.0.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#forceComposite", "scope": "instance", "kind": "member", "___id": "T000002R001575", "___s": true }, { "comment": "/**\r\n * Can this Camera render rounded pixel values?\r\n *\r\n * This property is updated during the `preRender` method and should not be\r\n * set directly. It is set based on the `roundPixels` property of the Camera\r\n * combined with the zoom level. If the zoom is an integer then the WebGL\r\n * Renderer can apply rounding during rendering.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#renderRoundPixels\r\n * @type {boolean}\r\n * @readonly\r\n * @default true\r\n * @since 3.86.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 562, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Can this Camera render rounded pixel values?\r\rThis property is updated during the `preRender` method and should not be\rset directly. It is set based on the `roundPixels` property of the Camera\rcombined with the zoom level. If the zoom is an integer then the WebGL\rRenderer can apply rounding during rendering.", "name": "renderRoundPixels", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.86.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#renderRoundPixels", "scope": "instance", "kind": "member", "___id": "T000002R001577", "___s": true }, { "comment": "/**\r\n * Adds the given Game Object to this camera's render list.\r\n *\r\n * This is invoked during the rendering stage. Only objects that are actually rendered\r\n * will appear in the render list.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#addToRenderList\r\n * @since 3.52.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The Game Object to add to the render list.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Adds the given Game Object to this camera's render list.\r\rThis is invoked during the rendering stage. Only objects that are actually rendered\rwill appear in the render list.", "kind": "function", "name": "addToRenderList", "since": "3.52.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to add to the render list.", "name": "child" } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#addToRenderList", "scope": "instance", "___id": "T000002R001579", "___s": true }, { "comment": "/**\r\n * Set the Alpha level of this Camera. The alpha controls the opacity of the Camera as it renders.\r\n * Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setAlpha\r\n * @since 3.11.0\r\n *\r\n * @param {number} [value=1] - The Camera alpha value.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 595, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Set the Alpha level of this Camera. The alpha controls the opacity of the Camera as it renders.\rAlpha 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The Camera alpha value.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setAlpha", "scope": "instance", "overrides": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "___id": "T000002R001581", "___s": true }, { "comment": "/**\r\n * Sets the rotation origin of this Camera.\r\n *\r\n * The values are given in the range 0 to 1 and are only used when calculating Camera rotation.\r\n *\r\n * By default the camera rotates around the center of the viewport.\r\n *\r\n * Changing the origin allows you to adjust the point in the viewport from which rotation happens.\r\n * A value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setOrigin\r\n * @since 3.11.0\r\n *\r\n * @param {number} [x=0.5] - The horizontal origin value.\r\n * @param {number} [y=x] - The vertical origin value. If not defined it will be set to the value of `x`.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 607, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Sets the rotation origin of this Camera.\r\rThe values are given in the range 0 to 1 and are only used when calculating Camera rotation.\r\rBy default the camera rotates around the center of the viewport.\r\rChanging the origin allows you to adjust the point in the viewport from which rotation happens.\rA 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The horizontal origin value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setOrigin", "scope": "instance", "___id": "T000002R001582", "___s": true }, { "comment": "/**\r\n * Calculates what the Camera.scrollX and scrollY values would need to be in order to move\r\n * the Camera so it is centered on the given x and y coordinates, without actually moving\r\n * the Camera there. The results are clamped based on the Camera bounds, if set.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#getScroll\r\n * @since 3.11.0\r\n *\r\n * @param {number} x - The horizontal coordinate to center on.\r\n * @param {number} y - The vertical coordinate to center on.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 to store the values in. If not given a new Vector2 is created.\r\n *\r\n * @return {Phaser.Math.Vector2} The scroll coordinates stored in the `x` and `y` properties.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 636, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Calculates what the Camera.scrollX and scrollY values would need to be in order to move\rthe Camera so it is centered on the given x and y coordinates, without actually moving\rthe 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate to center on.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate to center on.", "name": "y" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R001588", "___s": true }, { "comment": "/**\r\n * Moves the Camera horizontally so that it is centered on the given x coordinate, bounds allowing.\r\n * Calling this does not change the scrollY value.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#centerOnX\r\n * @since 3.16.0\r\n *\r\n * @param {number} x - The horizontal coordinate to center on.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 669, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Moves the Camera horizontally so that it is centered on the given x coordinate, bounds allowing.\rCalling this does not change the scrollY value.", "kind": "function", "name": "centerOnX", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate to center on.", "name": "x" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#centerOnX", "scope": "instance", "___id": "T000002R001597", "___s": true }, { "comment": "/**\r\n * Moves the Camera vertically so that it is centered on the given y coordinate, bounds allowing.\r\n * Calling this does not change the scrollX value.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#centerOnY\r\n * @since 3.16.0\r\n *\r\n * @param {number} y - The vertical coordinate to center on.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 696, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Moves the Camera vertically so that it is centered on the given y coordinate, bounds allowing.\rCalling this does not change the scrollX value.", "kind": "function", "name": "centerOnY", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate to center on.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#centerOnY", "scope": "instance", "___id": "T000002R001603", "___s": true }, { "comment": "/**\r\n * Moves the Camera so that it is centered on the given coordinates, bounds allowing.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#centerOn\r\n * @since 3.11.0\r\n *\r\n * @param {number} x - The horizontal coordinate to center on.\r\n * @param {number} y - The vertical coordinate to center on.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 723, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate to center on.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate to center on.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#centerOn", "scope": "instance", "___id": "T000002R001609", "___s": true }, { "comment": "/**\r\n * Moves the Camera so that it is looking at the center of the Camera Bounds, if enabled.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#centerToBounds\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 742, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#centerToBounds", "scope": "instance", "___id": "T000002R001611", "___s": true }, { "comment": "/**\r\n * Moves the Camera so that it is re-centered based on its viewport size.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#centerToSize\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 767, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#centerToSize", "scope": "instance", "___id": "T000002R001618", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and returns a new array featuring only those objects\r\n * visible by this camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#cull\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject[]} G - [renderableObjects,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject[]} renderableObjects - An array of Game Objects to cull.\r\n *\r\n * @return {Phaser.GameObjects.GameObject[]} An array of Game Objects visible to this Camera.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 783, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Takes an array of Game Objects and returns a new array featuring only those objects\rvisible by this camera.", "kind": "function", "name": "cull", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject[]} G - [renderableObjects,$return]", "value": "{Phaser.GameObjects.GameObject[]} G - [renderableObjects,$return]" } ], "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "An array of Game Objects to cull.", "name": "renderableObjects" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "An array of Game Objects visible to this Camera." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#cull", "scope": "instance", "___id": "T000002R001622", "___s": true }, { "comment": "/**\r\n * Converts the given `x` and `y` coordinates into World space, based on this Cameras transform.\r\n * You can optionally provide a Vector2, or similar object, to store the results in.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#getWorldPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [output,$return]\r\n *\r\n * @param {number} x - The x position to convert to world space.\r\n * @param {number} y - The y position to convert to world space.\r\n * @param {(object|Phaser.Math.Vector2)} [output] - An optional object to store the results in. If not provided a new Vector2 will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} An object holding the converted values in its `x` and `y` properties.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 861, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Converts the given `x` and `y` coordinates into World space, based on this Cameras transform.\rYou can optionally provide a Vector2, or similar object, to store the results in.", "kind": "function", "name": "getWorldPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [output,$return]", "value": "{Phaser.Math.Vector2} O - [output,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position to convert to world space.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position to convert to world space.", "name": "y" }, { "type": { "names": [ "object", "Phaser.Math.Vector2" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R001652", "___s": true }, { "comment": "/**\r\n * Given a Game Object, or an array of Game Objects, it will update all of their camera filter settings\r\n * so that they are ignored by this Camera. This means they will not be rendered by this Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#ignore\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]|Phaser.GameObjects.Group)} entries - The Game Object, or array of Game Objects, to be ignored by this Camera.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 916, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Given a Game Object, or an array of Game Objects, it will update all of their camera filter settings\rso 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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.GameObjects.Group" } ] } }, "description": "The Game Object, or array of Game Objects, to be ignored by this Camera.", "name": "entries" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#ignore", "scope": "instance", "___id": "T000002R001674", "___s": true }, { "comment": "/**\r\n * Takes an x value and checks it's within the range of the Camera bounds, adjusting if required.\r\n * Do not call this method if you are not using camera bounds.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#clampX\r\n * @since 3.11.0\r\n *\r\n * @param {number} x - The value to horizontally scroll clamp.\r\n *\r\n * @return {number} The adjusted value to use as scrollX.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 957, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Takes an x value and checks it's within the range of the Camera bounds, adjusting if required.\rDo not call this method if you are not using camera bounds.", "kind": "function", "name": "clampX", "since": "3.11.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to horizontally scroll clamp.", "name": "x" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The adjusted value to use as scrollX." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#clampX", "scope": "instance", "___id": "T000002R001681", "___s": true }, { "comment": "/**\r\n * Takes a y value and checks it's within the range of the Camera bounds, adjusting if required.\r\n * Do not call this method if you are not using camera bounds.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#clampY\r\n * @since 3.11.0\r\n *\r\n * @param {number} y - The value to vertically scroll clamp.\r\n *\r\n * @return {number} The adjusted value to use as scrollY.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 989, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Takes a y value and checks it's within the range of the Camera bounds, adjusting if required.\rDo not call this method if you are not using camera bounds.", "kind": "function", "name": "clampY", "since": "3.11.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to vertically scroll clamp.", "name": "y" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The adjusted value to use as scrollY." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#clampY", "scope": "instance", "___id": "T000002R001689", "___s": true }, { "comment": "/**\r\n * If this Camera has previously had movement bounds set on it, this will remove them.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#removeBounds\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1026, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#removeBounds", "scope": "instance", "___id": "T000002R001697", "___s": true }, { "comment": "/**\r\n * Set the rotation of this Camera. This causes everything it renders to appear rotated.\r\n *\r\n * Rotating a camera does not rotate the viewport itself, it is applied during rendering.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setAngle\r\n * @since 3.0.0\r\n *\r\n * @param {number} [value=0] - The camera's angle of rotation, given in degrees.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1045, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Set the rotation of this Camera. This causes everything it renders to appear rotated.\r\rRotating 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The camera's angle of rotation, given in degrees.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setAngle", "scope": "instance", "___id": "T000002R001701", "___s": true }, { "comment": "/**\r\n * Sets the background color for this Camera.\r\n *\r\n * By default a Camera has a transparent background but it can be given a solid color, with any level\r\n * of transparency, via this method.\r\n *\r\n * The color value can be specified using CSS color notation, hex or numbers.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setBackgroundColor\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number|Phaser.Types.Display.InputColorObject)} [color='rgba(0,0,0,0)'] - The color value. In CSS, hex or numeric color notation.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1066, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Sets the background color for this Camera.\r\rBy default a Camera has a transparent background but it can be given a solid color, with any level\rof transparency, via this method.\r\rThe 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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setBackgroundColor", "scope": "instance", "___id": "T000002R001705", "___s": true }, { "comment": "/**\r\n * Set the bounds of the Camera. The bounds are an axis-aligned rectangle.\r\n *\r\n * The Camera bounds controls where the Camera can scroll to, stopping it from scrolling off the\r\n * edges and into blank space. It does not limit the placement of Game Objects, or where\r\n * the Camera viewport can be positioned.\r\n *\r\n * Temporarily disable the bounds by changing the boolean `Camera.useBounds`.\r\n *\r\n * Clear the bounds entirely by calling `Camera.removeBounds`.\r\n *\r\n * If you set bounds that are smaller than the viewport it will stop the Camera from being\r\n * able to scroll. The bounds can be positioned where-ever you wish. By default they are from\r\n * 0x0 to the canvas width x height. This means that the coordinate 0x0 is the top left of\r\n * the Camera bounds. However, you can position them anywhere. So if you wanted a game world\r\n * that was 2048x2048 in size, with 0x0 being the center of it, you can set the bounds x/y\r\n * to be -1024, -1024, with a width and height of 2048. Depending on your game you may find\r\n * it easier for 0x0 to be the top-left of the bounds, or you may wish 0x0 to be the middle.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setBounds\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The top-left x coordinate of the bounds.\r\n * @param {number} y - The top-left y coordinate of the bounds.\r\n * @param {number} width - The width of the bounds, in pixels.\r\n * @param {number} height - The height of the bounds, in pixels.\r\n * @param {boolean} [centerOn=false] - If `true` the Camera will automatically be centered on the new bounds.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1092, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Set the bounds of the Camera. The bounds are an axis-aligned rectangle.\r\rThe Camera bounds controls where the Camera can scroll to, stopping it from scrolling off the\redges and into blank space. It does not limit the placement of Game Objects, or where\rthe Camera viewport can be positioned.\r\rTemporarily disable the bounds by changing the boolean `Camera.useBounds`.\r\rClear the bounds entirely by calling `Camera.removeBounds`.\r\rIf you set bounds that are smaller than the viewport it will stop the Camera from being\rable to scroll. The bounds can be positioned where-ever you wish. By default they are from\r0x0 to the canvas width x height. This means that the coordinate 0x0 is the top left of\rthe Camera bounds. However, you can position them anywhere. So if you wanted a game world\rthat was 2048x2048 in size, with 0x0 being the center of it, you can set the bounds x/y\rto be -1024, -1024, with a width and height of 2048. Depending on your game you may find\rit 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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x coordinate of the bounds.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y coordinate of the bounds.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the bounds, in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the bounds, in pixels.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true` the Camera will automatically be centered on the new bounds.", "name": "centerOn" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setBounds", "scope": "instance", "___id": "T000002R001710", "___s": true }, { "comment": "/**\r\n * Sets the `forceComposite` property of this Camera.\r\n * This property is only used by the WebGL Renderer.\r\n * If `true` the camera will render via a framebuffer,\r\n * making it available to other WebGL systems.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setForceComposite\r\n * @since 4.0.0\r\n * @webglOnly\r\n *\r\n * @param {boolean} value - The value to set the property to.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Sets the `forceComposite` property of this Camera.\rThis property is only used by the WebGL Renderer.\rIf `true` the camera will render via a framebuffer,\rmaking it available to other WebGL systems.", "kind": "function", "name": "setForceComposite", "since": "4.0.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The value to set the property to.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setForceComposite", "scope": "instance", "___id": "T000002R001717", "___s": true }, { "comment": "/**\r\n * Returns a rectangle containing the bounds of the Camera.\r\n *\r\n * If the Camera does not have any bounds the rectangle will be empty.\r\n *\r\n * The rectangle is a copy of the bounds, so is safe to modify.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#getBounds\r\n * @since 3.16.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} [out] - An optional Rectangle to store the bounds in. If not given, a new Rectangle will be created.\r\n *\r\n * @return {Phaser.Geom.Rectangle} A rectangle containing the bounds of this Camera.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1165, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Returns a rectangle containing the bounds of the Camera.\r\rIf the Camera does not have any bounds the rectangle will be empty.\r\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R001720", "___s": true }, { "comment": "/**\r\n * Sets the name of this Camera.\r\n * This value is for your own use and isn't used internally.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setName\r\n * @since 3.0.0\r\n *\r\n * @param {string} [value=''] - The name of the Camera.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1190, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Sets the name of this Camera.\rThis value is for your own use and isn't used internally.", "kind": "function", "name": "setName", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "''", "description": "The name of the Camera.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setName", "scope": "instance", "___id": "T000002R001724", "___s": true }, { "comment": "/**\r\n * Set the position of the Camera viewport within the game.\r\n *\r\n * This does not change where the camera is 'looking'. See `setScroll` to control that.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setPosition\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The top-left x coordinate of the Camera viewport.\r\n * @param {number} [y=x] - The top-left y coordinate of the Camera viewport.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Set the position of the Camera viewport within the game.\r\rThis 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x coordinate of the Camera viewport.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The top-left y coordinate of the Camera viewport.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setPosition", "scope": "instance", "___id": "T000002R001728", "___s": true }, { "comment": "/**\r\n * Set the rotation of this Camera. This causes everything it renders to appear rotated.\r\n *\r\n * Rotating a camera does not rotate the viewport itself, it is applied during rendering.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setRotation\r\n * @since 3.0.0\r\n *\r\n * @param {number} [value=0] - The rotation of the Camera, in radians.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1233, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Set the rotation of this Camera. This causes everything it renders to appear rotated.\r\rRotating 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of the Camera, in radians.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setRotation", "scope": "instance", "___id": "T000002R001733", "___s": true }, { "comment": "/**\r\n * Should the Camera round pixel values to whole integers when rendering Game Objects?\r\n *\r\n * In some types of game, especially with pixel art, this is required to prevent sub-pixel aliasing.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setRoundPixels\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to round Camera pixels, `false` to not.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1254, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Should the Camera round pixel values to whole integers when rendering Game Objects?\r\rIn 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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to round Camera pixels, `false` to not.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setRoundPixels", "scope": "instance", "___id": "T000002R001737", "___s": true }, { "comment": "/**\r\n * Sets the Scene the Camera is bound to.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setScene\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene the camera is bound to.\r\n * @param {boolean} [isSceneCamera=true] - Is this Camera being used for a Scene (true) or a Texture? (false)\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1273, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Sets the Scene the Camera is bound to.", "kind": "function", "name": "setScene", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene the camera is bound to.", "name": "scene" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Is this Camera being used for a Scene (true) or a Texture? (false)", "name": "isSceneCamera" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setScene", "scope": "instance", "___id": "T000002R001740", "___s": true }, { "comment": "/**\r\n * Set the position of where the Camera is looking within the game.\r\n * You can also modify the properties `Camera.scrollX` and `Camera.scrollY` directly.\r\n * Use this method, or the scroll properties, to move your camera around the game world.\r\n *\r\n * This does not change where the camera viewport is placed. See `setPosition` to control that.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setScroll\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate of the Camera in the game world.\r\n * @param {number} [y=x] - The y coordinate of the Camera in the game world.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Set the position of where the Camera is looking within the game.\rYou can also modify the properties `Camera.scrollX` and `Camera.scrollY` directly.\rUse this method, or the scroll properties, to move your camera around the game world.\r\rThis 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the Camera in the game world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The y coordinate of the Camera in the game world.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setScroll", "scope": "instance", "___id": "T000002R001749", "___s": true }, { "comment": "/**\r\n * Set the size of the Camera viewport.\r\n *\r\n * By default a Camera is the same size as the game, but can be made smaller via this method,\r\n * allowing you to create mini-cam style effects by creating and positioning a smaller Camera\r\n * viewport within your game.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width of the Camera viewport.\r\n * @param {number} [height=width] - The height of the Camera viewport.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Set the size of the Camera viewport.\r\rBy default a Camera is the same size as the game, but can be made smaller via this method,\rallowing you to create mini-cam style effects by creating and positioning a smaller Camera\rviewport within your game.", "kind": "function", "name": "setSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the Camera viewport.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "width", "description": "The height of the Camera viewport.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setSize", "scope": "instance", "___id": "T000002R001754", "___s": true }, { "comment": "/**\r\n * This method sets the position and size of the Camera viewport in a single call.\r\n *\r\n * If you're trying to change where the Camera is looking at in your game, then see\r\n * the method `Camera.setScroll` instead. This method is for changing the viewport\r\n * itself, not what the camera can see.\r\n *\r\n * By default a Camera is the same size as the game, but can be made smaller via this method,\r\n * allowing you to create mini-cam style effects by creating and positioning a smaller Camera\r\n * viewport within your game.\r\n *\r\n * Note that this is a limited method, and comes with several caveats:\r\n *\r\n * - The viewport is an axis-aligned rectangle, and cannot be rotated.\r\n * - Filters and masks may appear in the wrong place if the viewport changes.\r\n *\r\n * It is more powerful and reliable to use a\r\n * `RenderTexture` or `DynamicTexture` instead.\r\n * Point its camera where you want the viewport,\r\n * set its size, and then draw your game objects to it.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setViewport\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The top-left x coordinate of the Camera viewport.\r\n * @param {number} y - The top-left y coordinate of the Camera viewport.\r\n * @param {number} width - The width of the Camera viewport.\r\n * @param {number} [height=width] - The height of the Camera viewport.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "This method sets the position and size of the Camera viewport in a single call.\r\rIf you're trying to change where the Camera is looking at in your game, then see\rthe method `Camera.setScroll` instead. This method is for changing the viewport\ritself, not what the camera can see.\r\rBy default a Camera is the same size as the game, but can be made smaller via this method,\rallowing you to create mini-cam style effects by creating and positioning a smaller Camera\rviewport within your game.\r\rNote that this is a limited method, and comes with several caveats:\r\r- The viewport is an axis-aligned rectangle, and cannot be rotated.\r- Filters and masks may appear in the wrong place if the viewport changes.\r\rIt is more powerful and reliable to use a\r`RenderTexture` or `DynamicTexture` instead.\rPoint its camera where you want the viewport,\rset its size, and then draw your game objects to it.", "kind": "function", "name": "setViewport", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left x coordinate of the Camera viewport.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left y coordinate of the Camera viewport.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the Camera viewport.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "width", "description": "The height of the Camera viewport.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setViewport", "scope": "instance", "___id": "T000002R001759", "___s": true }, { "comment": "/**\r\n * Set the zoom value of the Camera.\r\n *\r\n * Changing to a smaller value, such as 0.5, will cause the camera to 'zoom out'.\r\n * Changing to a larger value, such as 2, will cause the camera to 'zoom in'.\r\n *\r\n * A value of 1 means 'no zoom' and is the default.\r\n *\r\n * Changing the zoom does not impact the Camera viewport in any way, it is only applied during rendering.\r\n *\r\n * As of Phaser 3.50 you can now set the horizontal and vertical zoom values independently.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setZoom\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=1] - The horizontal zoom value of the Camera. The minimum it can be is 0.001.\r\n * @param {number} [y=x] - The vertical zoom value of the Camera. The minimum it can be is 0.001.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1398, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Set the zoom value of the Camera.\r\rChanging to a smaller value, such as 0.5, will cause the camera to 'zoom out'.\rChanging to a larger value, such as 2, will cause the camera to 'zoom in'.\r\rA value of 1 means 'no zoom' and is the default.\r\rChanging the zoom does not impact the Camera viewport in any way, it is only applied during rendering.\r\rAs of Phaser 3.50 you can now set the horizontal and vertical zoom values independently.", "kind": "function", "name": "setZoom", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The horizontal zoom value of the Camera. The minimum it can be is 0.001.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical zoom value of the Camera. The minimum it can be is 0.001.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setZoom", "scope": "instance", "___id": "T000002R001765", "___s": true }, { "comment": "/**\r\n * Sets the mask to be applied to this Camera during rendering.\r\n *\r\n * The mask must have been previously created and must be a GeometryMask.\r\n * This only works in the Canvas Renderer.\r\n * In WebGL, use a Mask filter instead (see {@link Phaser.GameObjects.Components.FilterList#addMask}).\r\n *\r\n * If a mask is already set on this Camera it will be immediately replaced.\r\n *\r\n * Masks have no impact on physics or input detection. They are purely a rendering component\r\n * that allows you to limit what is visible during the render pass.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setMask\r\n * @since 3.17.0\r\n *\r\n * @param {Phaser.Display.Masks.GeometryMask} mask - The mask this Camera will use when rendering.\r\n * @param {boolean} [fixedPosition=true] - Should the mask translate along with the Camera, or be fixed in place and not impacted by the Cameras transform?\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1439, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Sets the mask to be applied to this Camera during rendering.\r\rThe mask must have been previously created and must be a GeometryMask.\rThis only works in the Canvas Renderer.\rIn WebGL, use a Mask filter instead (see {@link Phaser.GameObjects.Components.FilterList#addMask}).\r\rIf a mask is already set on this Camera it will be immediately replaced.\r\rMasks have no impact on physics or input detection. They are purely a rendering component\rthat allows you to limit what is visible during the render pass.", "kind": "function", "name": "setMask", "since": "3.17.0", "params": [ { "type": { "names": [ "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } }, "description": "The mask this Camera will use when rendering.", "name": "mask" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setMask", "scope": "instance", "___id": "T000002R001773", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Camera was using.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#clearMask\r\n * @since 3.17.0\r\n *\r\n * @param {boolean} [destroyMask=false] - Destroy the mask before clearing it?\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1470, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Clears the mask that this Camera was using.", "kind": "function", "name": "clearMask", "since": "3.17.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#clearMask", "scope": "instance", "___id": "T000002R001778", "___s": true }, { "comment": "/**\r\n * Sets the visibility of this Camera.\r\n *\r\n * An invisible Camera will skip rendering and input tests of everything it can see.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setVisible\r\n * @since 3.10.0\r\n *\r\n * @param {boolean} value - The visible state of the Camera.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Sets the visibility of this Camera.\r\rAn 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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Camera.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setVisible", "scope": "instance", "overrides": "Phaser.GameObjects.Components.Visible#setVisible", "___id": "T000002R001782", "___s": true }, { "comment": "/**\r\n * Returns an Object suitable for JSON storage containing all of the Camera viewport and rendering properties.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.Cameras.Scene2D.JSONCamera} A well-formed object suitable for conversion to JSON.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1507, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R001783", "___s": true }, { "comment": "/**\r\n * Internal method called automatically by the Camera Manager.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#update\r\n * @protected\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1544, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Internal method called automatically by the Camera Manager.", "kind": "function", "name": "update", "access": "protected", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp as generated by the Request Animation Frame or SetTimeout.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time, in ms, elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#update", "scope": "instance", "___id": "T000002R001802", "___s": true }, { "comment": "/**\r\n * Sets whether this Camera is being used as a Scene Camera (the default),\r\n * or a Texture Camera used to render to a texture.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#setIsSceneCamera\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} value - Is this being used as a Scene Camera, or a Texture camera?\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1559, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Sets whether this Camera is being used as a Scene Camera (the default),\ror a Texture Camera used to render to a texture.", "kind": "function", "name": "setIsSceneCamera", "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this being used as a Scene Camera, or a Texture camera?", "name": "value" } ], "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#setIsSceneCamera", "scope": "instance", "___id": "T000002R001804", "___s": true }, { "comment": "/**\r\n * Destroys this Camera instance and its internal properties and references.\r\n * Once destroyed you cannot use this Camera again, even if re-added to a Camera Manager.\r\n *\r\n * This method is called automatically by `CameraManager.remove` if that methods `runDestroy` argument is `true`, which is the default.\r\n *\r\n * Unless you have a specific reason otherwise, always use `CameraManager.remove` and allow it to handle the camera destruction,\r\n * rather than calling this method directly.\r\n *\r\n * @method Phaser.Cameras.Scene2D.BaseCamera#destroy\r\n * @fires Phaser.Cameras.Scene2D.Events#DESTROY\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1608, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Destroys this Camera instance and its internal properties and references.\rOnce destroyed you cannot use this Camera again, even if re-added to a Camera Manager.\r\rThis method is called automatically by `CameraManager.remove` if that methods `runDestroy` argument is `true`, which is the default.\r\rUnless you have a specific reason otherwise, always use `CameraManager.remove` and allow it to handle the camera destruction,\rrather 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", "___id": "T000002R001813", "___s": true }, { "comment": "/**\r\n * The x position of the Camera viewport, relative to the top-left of the game canvas.\r\n * The viewport is the area into which the camera renders.\r\n * To adjust the position the camera is looking at in the game world, see the `scrollX` value.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#x\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1649, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The x position of the Camera viewport, relative to the top-left of the game canvas.\rThe viewport is the area into which the camera renders.\rTo adjust the position the camera is looking at in the game world, see the `scrollX` value.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#x", "scope": "instance", "kind": "member", "___id": "T000002R001822", "___s": true }, { "comment": "/**\r\n * The y position of the Camera viewport, relative to the top-left of the game canvas.\r\n * The viewport is the area into which the camera renders.\r\n * To adjust the position the camera is looking at in the game world, see the `scrollY` value.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#y\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The y position of the Camera viewport, relative to the top-left of the game canvas.\rThe viewport is the area into which the camera renders.\rTo adjust the position the camera is looking at in the game world, see the `scrollY` value.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#y", "scope": "instance", "kind": "member", "___id": "T000002R001827", "___s": true }, { "comment": "/**\r\n * The width of the Camera viewport, in pixels.\r\n *\r\n * The viewport is the area into which the Camera renders. Setting the viewport does\r\n * not restrict where the Camera can scroll to.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1697, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The width of the Camera viewport, in pixels.\r\rThe viewport is the area into which the Camera renders. Setting the viewport does\rnot restrict where the Camera can scroll to.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#width", "scope": "instance", "kind": "member", "___id": "T000002R001832", "___s": true }, { "comment": "/**\r\n * The height of the Camera viewport, in pixels.\r\n *\r\n * The viewport is the area into which the Camera renders. Setting the viewport does\r\n * not restrict where the Camera can scroll to.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1722, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The height of the Camera viewport, in pixels.\r\rThe viewport is the area into which the Camera renders. Setting the viewport does\rnot restrict where the Camera can scroll to.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#height", "scope": "instance", "kind": "member", "___id": "T000002R001837", "___s": true }, { "comment": "/**\r\n * The horizontal scroll position of this Camera.\r\n *\r\n * Change this value to cause the Camera to scroll around your Scene.\r\n *\r\n * Alternatively, setting the Camera to follow a Game Object, via the `startFollow` method,\r\n * will automatically adjust the Camera scroll values accordingly.\r\n *\r\n * You can set the bounds within which the Camera can scroll via the `setBounds` method.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#scrollX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The horizontal scroll position of this Camera.\r\rChange this value to cause the Camera to scroll around your Scene.\r\rAlternatively, setting the Camera to follow a Game Object, via the `startFollow` method,\rwill automatically adjust the Camera scroll values accordingly.\r\rYou can set the bounds within which the Camera can scroll via the `setBounds` method.", "name": "scrollX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#scrollX", "scope": "instance", "kind": "member", "___id": "T000002R001842", "___s": true }, { "comment": "/**\r\n * The vertical scroll position of this Camera.\r\n *\r\n * Change this value to cause the Camera to scroll around your Scene.\r\n *\r\n * Alternatively, setting the Camera to follow a Game Object, via the `startFollow` method,\r\n * will automatically adjust the Camera scroll values accordingly.\r\n *\r\n * You can set the bounds within which the Camera can scroll via the `setBounds` method.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#scrollY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1780, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The vertical scroll position of this Camera.\r\rChange this value to cause the Camera to scroll around your Scene.\r\rAlternatively, setting the Camera to follow a Game Object, via the `startFollow` method,\rwill automatically adjust the Camera scroll values accordingly.\r\rYou can set the bounds within which the Camera can scroll via the `setBounds` method.", "name": "scrollY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#scrollY", "scope": "instance", "kind": "member", "___id": "T000002R001848", "___s": true }, { "comment": "/**\r\n * The Camera zoom value. Change this value to zoom in, or out of, a Scene.\r\n *\r\n * A value of 0.5 would zoom the Camera out, so you can now see twice as much\r\n * of the Scene as before. A value of 2 would zoom the Camera in, so every pixel\r\n * now takes up 2 pixels when rendered.\r\n *\r\n * Set to 1 to return to the default zoom level.\r\n *\r\n * Be careful to never set this value to zero.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#zoom\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1813, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Camera zoom value. Change this value to zoom in, or out of, a Scene.\r\rA value of 0.5 would zoom the Camera out, so you can now see twice as much\rof the Scene as before. A value of 2 would zoom the Camera in, so every pixel\rnow takes up 2 pixels when rendered.\r\rSet to 1 to return to the default zoom level.\r\rBe careful to never set this value to zero.", "name": "zoom", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#zoom", "scope": "instance", "kind": "member", "___id": "T000002R001854", "___s": true }, { "comment": "/**\r\n * The Camera horizontal zoom value. Change this value to zoom in, or out of, a Scene.\r\n *\r\n * A value of 0.5 would zoom the Camera out, so you can now see twice as much\r\n * of the Scene as before. A value of 2 would zoom the Camera in, so every pixel\r\n * now takes up 2 pixels when rendered.\r\n *\r\n * Set to 1 to return to the default zoom level.\r\n *\r\n * Be careful to never set this value to zero.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#zoomX\r\n * @type {number}\r\n * @default 1\r\n * @since 3.50.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1846, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Camera horizontal zoom value. Change this value to zoom in, or out of, a Scene.\r\rA value of 0.5 would zoom the Camera out, so you can now see twice as much\rof the Scene as before. A value of 2 would zoom the Camera in, so every pixel\rnow takes up 2 pixels when rendered.\r\rSet to 1 to return to the default zoom level.\r\rBe careful to never set this value to zero.", "name": "zoomX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.50.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#zoomX", "scope": "instance", "kind": "member", "___id": "T000002R001861", "___s": true }, { "comment": "/**\r\n * The Camera vertical zoom value. Change this value to zoom in, or out of, a Scene.\r\n *\r\n * A value of 0.5 would zoom the Camera out, so you can now see twice as much\r\n * of the Scene as before. A value of 2 would zoom the Camera in, so every pixel\r\n * now takes up 2 pixels when rendered.\r\n *\r\n * Set to 1 to return to the default zoom level.\r\n *\r\n * Be careful to never set this value to zero.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#zoomY\r\n * @type {number}\r\n * @default 1\r\n * @since 3.50.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1877, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Camera vertical zoom value. Change this value to zoom in, or out of, a Scene.\r\rA value of 0.5 would zoom the Camera out, so you can now see twice as much\rof the Scene as before. A value of 2 would zoom the Camera in, so every pixel\rnow takes up 2 pixels when rendered.\r\rSet to 1 to return to the default zoom level.\r\rBe careful to never set this value to zero.", "name": "zoomY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.50.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#zoomY", "scope": "instance", "kind": "member", "___id": "T000002R001867", "___s": true }, { "comment": "/**\r\n * The horizontal position of the center of the Camera's viewport, relative to the left of the game canvas.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#centerX\r\n * @type {number}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1938, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#centerX", "scope": "instance", "kind": "member", "___id": "T000002R001879", "___s": true }, { "comment": "/**\r\n * The vertical position of the center of the Camera's viewport, relative to the top of the game canvas.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#centerY\r\n * @type {number}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1955, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#centerY", "scope": "instance", "kind": "member", "___id": "T000002R001882", "___s": true }, { "comment": "/**\r\n * The displayed width of the camera viewport, factoring in the camera zoom level.\r\n *\r\n * If a camera has a viewport width of 800 and a zoom of 0.5 then its display width\r\n * would be 1600, as it's displaying twice as many pixels as zoom level 1.\r\n *\r\n * Equally, a camera with a width of 800 and zoom of 2 would have a display width\r\n * of 400 pixels.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#displayWidth\r\n * @type {number}\r\n * @readonly\r\n * @since 3.11.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1972, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The displayed width of the camera viewport, factoring in the camera zoom level.\r\rIf a camera has a viewport width of 800 and a zoom of 0.5 then its display width\rwould be 1600, as it's displaying twice as many pixels as zoom level 1.\r\rEqually, a camera with a width of 800 and zoom of 2 would have a display width\rof 400 pixels.", "name": "displayWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#displayWidth", "scope": "instance", "kind": "member", "___id": "T000002R001885", "___s": true }, { "comment": "/**\r\n * The displayed height of the camera viewport, factoring in the camera zoom level.\r\n *\r\n * If a camera has a viewport height of 600 and a zoom of 0.5 then its display height\r\n * would be 1200, as it's displaying twice as many pixels as zoom level 1.\r\n *\r\n * Equally, a camera with a height of 600 and zoom of 2 would have a display height\r\n * of 300 pixels.\r\n *\r\n * @name Phaser.Cameras.Scene2D.BaseCamera#displayHeight\r\n * @type {number}\r\n * @readonly\r\n * @since 3.11.0\r\n */", "meta": { "filename": "BaseCamera.js", "lineno": 1995, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The displayed height of the camera viewport, factoring in the camera zoom level.\r\rIf a camera has a viewport height of 600 and a zoom of 0.5 then its display height\rwould be 1200, as it's displaying twice as many pixels as zoom level 1.\r\rEqually, a camera with a height of 600 and zoom of 2 would have a display height\rof 300 pixels.", "name": "displayHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.BaseCamera", "longname": "Phaser.Cameras.Scene2D.BaseCamera#displayHeight", "scope": "instance", "kind": "member", "___id": "T000002R001888", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Camera provides a view into your game world and is the primary way scenes are rendered in Phaser.\r\n * Every Scene has at least one Camera (the main camera), and you can add additional cameras via the\r\n * Camera Manager. Cameras can be scrolled, zoomed, rotated, and fitted with special effects such as\r\n * fade, flash, shake, pan, and zoom transitions.\r\n *\r\n * The Camera is the way in which all games are rendered in Phaser. They provide a view into your game world,\r\n * and can be positioned, rotated, zoomed and scrolled accordingly.\r\n *\r\n * A Camera consists of two elements: The viewport and the scroll values.\r\n *\r\n * The viewport is the physical position and size of the Camera within your game. Cameras, by default, are\r\n * created the same size as your game, but their position and size can be set to anything. This means if you\r\n * wanted to create a camera that was 320x200 in size, positioned in the bottom-right corner of your game,\r\n * you'd adjust the viewport to do that (using methods like `setViewport` and `setSize`).\r\n * However, the viewport is limited to being an axis-aligned rectangle, and cannot be rotated.\r\n * It is more powerful and reliable to use a\r\n * `RenderTexture` or `DynamicTexture` instead.\r\n * Point its camera where you want the viewport,\r\n * set its size, and then draw your game objects to it.\r\n *\r\n * If you wish to change where the Camera is looking in your game, then you scroll it. You can do this\r\n * via the properties `scrollX` and `scrollY` or the method `setScroll`. Scrolling has no impact on the\r\n * viewport, and changing the viewport has no impact on the scrolling.\r\n *\r\n * By default a Camera will render all Game Objects it can see. You can change this using the `ignore` method,\r\n * allowing you to filter Game Objects out on a per-Camera basis.\r\n *\r\n * A Camera also has built-in special effects including Fade, Flash and Camera Shake.\r\n *\r\n * You can apply full-camera filters.\r\n * Some filters need off-screen data, such as Blur;\r\n * use `camera.getPaddingWrapper()` to get a proxy for working with\r\n * cameras with padding applied.\r\n *\r\n * @class Camera\r\n * @memberof Phaser.Cameras.Scene2D\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.Cameras.Scene2D.BaseCamera\r\n *\r\n * @param {number} x - The x position of the Camera, relative to the top-left of the game canvas.\r\n * @param {number} y - The y position of the Camera, relative to the top-left of the game canvas.\r\n * @param {number} width - The width of the Camera, in pixels.\r\n * @param {number} height - The height of the Camera, in pixels.\r\n */", "meta": { "filename": "Camera.js", "lineno": 18, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "classdesc": "A Camera provides a view into your game world and is the primary way scenes are rendered in Phaser.\rEvery Scene has at least one Camera (the main camera), and you can add additional cameras via the\rCamera Manager. Cameras can be scrolled, zoomed, rotated, and fitted with special effects such as\rfade, flash, shake, pan, and zoom transitions.\r\rThe Camera is the way in which all games are rendered in Phaser. They provide a view into your game world,\rand can be positioned, rotated, zoomed and scrolled accordingly.\r\rA Camera consists of two elements: The viewport and the scroll values.\r\rThe viewport is the physical position and size of the Camera within your game. Cameras, by default, are\rcreated the same size as your game, but their position and size can be set to anything. This means if you\rwanted to create a camera that was 320x200 in size, positioned in the bottom-right corner of your game,\ryou'd adjust the viewport to do that (using methods like `setViewport` and `setSize`).\rHowever, the viewport is limited to being an axis-aligned rectangle, and cannot be rotated.\rIt is more powerful and reliable to use a\r`RenderTexture` or `DynamicTexture` instead.\rPoint its camera where you want the viewport,\rset its size, and then draw your game objects to it.\r\rIf you wish to change where the Camera is looking in your game, then you scroll it. You can do this\rvia the properties `scrollX` and `scrollY` or the method `setScroll`. Scrolling has no impact on the\rviewport, and changing the viewport has no impact on the scrolling.\r\rBy default a Camera will render all Game Objects it can see. You can change this using the `ignore` method,\rallowing you to filter Game Objects out on a per-Camera basis.\r\rA Camera also has built-in special effects including Fade, Flash and Camera Shake.\r\rYou can apply full-camera filters.\rSome filters need off-screen data, such as Blur;\ruse `camera.getPaddingWrapper()` to get a proxy for working with\rcameras with padding applied.", "kind": "class", "name": "Camera", "memberof": "Phaser.Cameras.Scene2D", "since": "3.0.0", "augments": [ "Phaser.Cameras.Scene2D.BaseCamera" ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the Camera, relative to the top-left of the game canvas.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the Camera, relative to the top-left of the game canvas.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the Camera, in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the Camera, in pixels.", "name": "height" } ], "scope": "static", "longname": "Phaser.Cameras.Scene2D.Camera", "___id": "T000002R001902", "___s": true }, { "comment": "/**\r\n * The filters for this camera.\r\n * Filters control special effects and masks.\r\n *\r\n * This object contains two lists of filters: `internal` and `external`.\r\n * See {@link Phaser.GameObjects.Components.FilterList} for more information.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Camera#filters\r\n * @type {Phaser.Types.GameObjects.FiltersInternalExternal}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The filters for this camera.\rFilters control special effects and masks.\r\rThis object contains two lists of filters: `internal` and `external`.\rSee {@link Phaser.GameObjects.Components.FilterList} for more information.", "name": "filters", "type": { "names": [ "Phaser.Types.GameObjects.FiltersInternalExternal" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.FiltersInternalExternal" } }, "since": "4.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#filters", "scope": "instance", "kind": "member", "___id": "T000002R001906", "___s": true }, { "comment": "/**\r\n * Is this Camera for Game Object transform inversion?\r\n * This is used by the `Filters` component to cancel out the transform\r\n * of the Game Object when rendering the object for filtering.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Camera#isObjectInversion\r\n * @type {boolean}\r\n * @default false\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Is this Camera for Game Object transform inversion?\rThis is used by the `Filters` component to cancel out the transform\rof the Game Object when rendering the object for filtering.", "name": "isObjectInversion", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "4.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#isObjectInversion", "scope": "instance", "kind": "member", "___id": "T000002R001910", "___s": true }, { "comment": "/**\r\n * Does this Camera allow the Game Objects it renders to receive input events?\r\n *\r\n * @name Phaser.Cameras.Scene2D.Camera#inputEnabled\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Does this Camera allow the Game Objects it renders to receive input events?", "name": "inputEnabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#inputEnabled", "scope": "instance", "kind": "member", "___id": "T000002R001912", "___s": true }, { "comment": "/**\r\n * The Camera Fade effect handler.\r\n * To fade this camera see the `Camera.fade` methods.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Camera#fadeEffect\r\n * @type {Phaser.Cameras.Scene2D.Effects.Fade}\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Camera Fade effect handler.\rTo fade this camera see the `Camera.fade` methods.", "name": "fadeEffect", "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Fade" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Effects.Fade" } }, "since": "3.5.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#fadeEffect", "scope": "instance", "kind": "member", "___id": "T000002R001914", "___s": true }, { "comment": "/**\r\n * The Camera Flash effect handler.\r\n * To flash this camera see the `Camera.flash` method.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Camera#flashEffect\r\n * @type {Phaser.Cameras.Scene2D.Effects.Flash}\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 124, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Camera Flash effect handler.\rTo flash this camera see the `Camera.flash` method.", "name": "flashEffect", "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Flash" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Effects.Flash" } }, "since": "3.5.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#flashEffect", "scope": "instance", "kind": "member", "___id": "T000002R001916", "___s": true }, { "comment": "/**\r\n * The Camera Shake effect handler.\r\n * To shake this camera see the `Camera.shake` method.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Camera#shakeEffect\r\n * @type {Phaser.Cameras.Scene2D.Effects.Shake}\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 134, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Camera Shake effect handler.\rTo shake this camera see the `Camera.shake` method.", "name": "shakeEffect", "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Shake" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Effects.Shake" } }, "since": "3.5.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#shakeEffect", "scope": "instance", "kind": "member", "___id": "T000002R001918", "___s": true }, { "comment": "/**\r\n * The Camera Pan effect handler.\r\n * To pan this camera see the `Camera.pan` method.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Camera#panEffect\r\n * @type {Phaser.Cameras.Scene2D.Effects.Pan}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 144, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Camera Pan effect handler.\rTo pan this camera see the `Camera.pan` method.", "name": "panEffect", "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Pan" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Effects.Pan" } }, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#panEffect", "scope": "instance", "kind": "member", "___id": "T000002R001920", "___s": true }, { "comment": "/**\r\n * The Camera Rotate To effect handler.\r\n * To rotate this camera see the `Camera.rotateTo` method.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Camera#rotateToEffect\r\n * @type {Phaser.Cameras.Scene2D.Effects.RotateTo}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Camera Rotate To effect handler.\rTo rotate this camera see the `Camera.rotateTo` method.", "name": "rotateToEffect", "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.RotateTo" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Effects.RotateTo" } }, "since": "3.23.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#rotateToEffect", "scope": "instance", "kind": "member", "___id": "T000002R001922", "___s": true }, { "comment": "/**\r\n * The Camera Zoom effect handler.\r\n * To zoom this camera see the `Camera.zoomTo` method.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Camera#zoomEffect\r\n * @type {Phaser.Cameras.Scene2D.Effects.Zoom}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 164, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Camera Zoom effect handler.\rTo zoom this camera see the `Camera.zoomTo` method.", "name": "zoomEffect", "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Zoom" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Effects.Zoom" } }, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#zoomEffect", "scope": "instance", "kind": "member", "___id": "T000002R001924", "___s": true }, { "comment": "/**\r\n * The linear interpolation value to use when following a target.\r\n *\r\n * Can also be set via `setLerp` or as part of the `startFollow` call.\r\n *\r\n * The default value of 1 means the camera will instantly snap to the target coordinates.\r\n * A lower value, such as 0.1 means the camera will more slowly track the target, giving\r\n * a smooth transition. You can set the horizontal and vertical values independently, and also\r\n * adjust this value in real-time during your game.\r\n *\r\n * Be sure to keep the value between 0 and 1. A value of zero will disable tracking on that axis.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Camera#lerp\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.9.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The linear interpolation value to use when following a target.\r\rCan also be set via `setLerp` or as part of the `startFollow` call.\r\rThe default value of 1 means the camera will instantly snap to the target coordinates.\rA lower value, such as 0.1 means the camera will more slowly track the target, giving\ra smooth transition. You can set the horizontal and vertical values independently, and also\radjust this value in real-time during your game.\r\rBe 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.9.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#lerp", "scope": "instance", "kind": "member", "___id": "T000002R001926", "___s": true }, { "comment": "/**\r\n * The values stored in this property are subtracted from the Camera targets position, allowing you to\r\n * offset the camera from the actual target x/y coordinates by this amount.\r\n * Can also be set via `setFollowOffset` or as part of the `startFollow` call.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Camera#followOffset\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.9.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 192, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The values stored in this property are subtracted from the Camera targets position, allowing you to\roffset the camera from the actual target x/y coordinates by this amount.\rCan also be set via `setFollowOffset` or as part of the `startFollow` call.", "name": "followOffset", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.9.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#followOffset", "scope": "instance", "kind": "member", "___id": "T000002R001928", "___s": true }, { "comment": "/**\r\n * The Camera dead zone.\r\n *\r\n * The deadzone is only used when the camera is following a target.\r\n *\r\n * It defines a rectangular region within which if the target is present, the camera will not scroll.\r\n * If the target moves outside of this area, the camera will begin scrolling in order to follow it.\r\n *\r\n * The `lerp` values that you can set for a follower target also apply when using a deadzone.\r\n *\r\n * You can directly set this property to be an instance of a Rectangle. Or, you can use the\r\n * `setDeadzone` method for a chainable approach.\r\n *\r\n * The rectangle you provide can have its dimensions adjusted dynamically, however, please\r\n * note that its position is updated every frame, as it is constantly re-centered on the cameras mid point.\r\n *\r\n * Calling `setDeadzone` with no arguments will reset an active deadzone, as will setting this property\r\n * to `null`.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Camera#deadzone\r\n * @type {?Phaser.Geom.Rectangle}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 203, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Camera dead zone.\r\rThe deadzone is only used when the camera is following a target.\r\rIt defines a rectangular region within which if the target is present, the camera will not scroll.\rIf the target moves outside of this area, the camera will begin scrolling in order to follow it.\r\rThe `lerp` values that you can set for a follower target also apply when using a deadzone.\r\rYou can directly set this property to be an instance of a Rectangle. Or, you can use the\r`setDeadzone` method for a chainable approach.\r\rThe rectangle you provide can have its dimensions adjusted dynamically, however, please\rnote that its position is updated every frame, as it is constantly re-centered on the cameras mid point.\r\rCalling `setDeadzone` with no arguments will reset an active deadzone, as will setting this property\rto `null`.", "name": "deadzone", "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle", "nullable": true } }, "nullable": true, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#deadzone", "scope": "instance", "kind": "member", "___id": "T000002R001930", "___s": true }, { "comment": "/**\r\n * Sets the Camera dead zone.\r\n *\r\n * The deadzone is only used when the camera is following a target.\r\n *\r\n * It defines a rectangular region within which if the target is present, the camera will not scroll.\r\n * If the target moves outside of this area, the camera will begin scrolling in order to follow it.\r\n *\r\n * The deadzone rectangle is re-positioned every frame so that it is centered on the mid-point\r\n * of the camera. This allows you to use the object for additional game related checks, such as\r\n * testing if an object is within it or not via a Rectangle.contains call.\r\n *\r\n * The `lerp` values that you can set for a follower target also apply when using a deadzone.\r\n *\r\n * Calling this method with no arguments will reset an active deadzone.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#setDeadzone\r\n * @since 3.11.0\r\n *\r\n * @param {number} [width] - The width of the deadzone rectangle in pixels. If not specified the deadzone is removed.\r\n * @param {number} [height] - The height of the deadzone rectangle in pixels.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 240, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Sets the Camera dead zone.\r\rThe deadzone is only used when the camera is following a target.\r\rIt defines a rectangular region within which if the target is present, the camera will not scroll.\rIf the target moves outside of this area, the camera will begin scrolling in order to follow it.\r\rThe deadzone rectangle is re-positioned every frame so that it is centered on the mid-point\rof the camera. This allows you to use the object for additional game related checks, such as\rtesting if an object is within it or not via a Rectangle.contains call.\r\rThe `lerp` values that you can set for a follower target also apply when using a deadzone.\r\rCalling this method with no arguments will reset an active deadzone.", "kind": "function", "name": "setDeadzone", "since": "3.11.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the deadzone rectangle in pixels. If not specified the deadzone is removed.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the deadzone rectangle in pixels.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#setDeadzone", "scope": "instance", "___id": "T000002R001934", "___s": true }, { "comment": "/**\r\n * Fades the Camera in from the given color over the duration specified.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#fadeIn\r\n * @fires Phaser.Cameras.Scene2D.Events#FADE_IN_START\r\n * @fires Phaser.Cameras.Scene2D.Events#FADE_IN_COMPLETE\r\n * @since 3.3.0\r\n *\r\n * @param {number} [duration=1000] - The duration of the effect in milliseconds.\r\n * @param {number} [red=0] - The amount to fade the red channel towards. A value between 0 and 255.\r\n * @param {number} [green=0] - The amount to fade the green channel towards. A value between 0 and 255.\r\n * @param {number} [blue=0] - The amount to fade the blue channel towards. A value between 0 and 255.\r\n * @param {function} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 302, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the red channel towards. A value between 0 and 255.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the green channel towards. A value between 0 and 255.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the blue channel towards. A value between 0 and 255.", "name": "blue" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt 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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#fadeIn", "scope": "instance", "___id": "T000002R001946", "___s": true }, { "comment": "/**\r\n * Fades the Camera out to the given color over the duration specified.\r\n * This is an alias for Camera.fade that forces the fade to start, regardless of existing fades.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#fadeOut\r\n * @fires Phaser.Cameras.Scene2D.Events#FADE_OUT_START\r\n * @fires Phaser.Cameras.Scene2D.Events#FADE_OUT_COMPLETE\r\n * @since 3.3.0\r\n *\r\n * @param {number} [duration=1000] - The duration of the effect in milliseconds.\r\n * @param {number} [red=0] - The amount to fade the red channel towards. A value between 0 and 255.\r\n * @param {number} [green=0] - The amount to fade the green channel towards. A value between 0 and 255.\r\n * @param {number} [blue=0] - The amount to fade the blue channel towards. A value between 0 and 255.\r\n * @param {function} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 325, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Fades the Camera out to the given color over the duration specified.\rThis 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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the red channel towards. A value between 0 and 255.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the green channel towards. A value between 0 and 255.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the blue channel towards. A value between 0 and 255.", "name": "blue" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt 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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#fadeOut", "scope": "instance", "___id": "T000002R001948", "___s": true }, { "comment": "/**\r\n * Fades the Camera from the given color to transparent over the duration specified.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#fadeFrom\r\n * @fires Phaser.Cameras.Scene2D.Events#FADE_IN_START\r\n * @fires Phaser.Cameras.Scene2D.Events#FADE_IN_COMPLETE\r\n * @since 3.5.0\r\n *\r\n * @param {number} [duration=1000] - The duration of the effect in milliseconds.\r\n * @param {number} [red=0] - The amount to fade the red channel towards. A value between 0 and 255.\r\n * @param {number} [green=0] - The amount to fade the green channel towards. A value between 0 and 255.\r\n * @param {number} [blue=0] - The amount to fade the blue channel towards. A value between 0 and 255.\r\n * @param {boolean} [force=false] - Force the effect to start immediately, even if already running.\r\n * @param {function} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 349, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the red channel towards. A value between 0 and 255.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the green channel towards. A value between 0 and 255.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the blue channel towards. A value between 0 and 255.", "name": "blue" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Force the effect to start immediately, even if already running.", "name": "force" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt 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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#fadeFrom", "scope": "instance", "___id": "T000002R001950", "___s": true }, { "comment": "/**\r\n * Fades the Camera from transparent to the given color over the duration specified.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#fade\r\n * @fires Phaser.Cameras.Scene2D.Events#FADE_OUT_START\r\n * @fires Phaser.Cameras.Scene2D.Events#FADE_OUT_COMPLETE\r\n * @since 3.0.0\r\n *\r\n * @param {number} [duration=1000] - The duration of the effect in milliseconds.\r\n * @param {number} [red=0] - The amount to fade the red channel towards. A value between 0 and 255.\r\n * @param {number} [green=0] - The amount to fade the green channel towards. A value between 0 and 255.\r\n * @param {number} [blue=0] - The amount to fade the blue channel towards. A value between 0 and 255.\r\n * @param {boolean} [force=false] - Force the effect to start immediately, even if already running.\r\n * @param {function} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the red channel towards. A value between 0 and 255.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the green channel towards. A value between 0 and 255.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the blue channel towards. A value between 0 and 255.", "name": "blue" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Force the effect to start immediately, even if already running.", "name": "force" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt 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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#fade", "scope": "instance", "___id": "T000002R001952", "___s": true }, { "comment": "/**\r\n * Flashes the Camera by setting it to the given color immediately and then fading it away again quickly over the duration specified.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#flash\r\n * @fires Phaser.Cameras.Scene2D.Events#FLASH_START\r\n * @fires Phaser.Cameras.Scene2D.Events#FLASH_COMPLETE\r\n * @since 3.0.0\r\n *\r\n * @param {number} [duration=250] - The duration of the effect in milliseconds.\r\n * @param {number} [red=255] - The amount to fade the red channel towards. A value between 0 and 255.\r\n * @param {number} [green=255] - The amount to fade the green channel towards. A value between 0 and 255.\r\n * @param {number} [blue=255] - The amount to fade the blue channel towards. A value between 0 and 255.\r\n * @param {boolean} [force=false] - Force the effect to start immediately, even if already running.\r\n * @param {function} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 397, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 250, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The amount to fade the red channel towards. A value between 0 and 255.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The amount to fade the green channel towards. A value between 0 and 255.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The amount to fade the blue channel towards. A value between 0 and 255.", "name": "blue" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Force the effect to start immediately, even if already running.", "name": "force" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt 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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#flash", "scope": "instance", "___id": "T000002R001954", "___s": true }, { "comment": "/**\r\n * Shakes the Camera by the given intensity over the duration specified.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#shake\r\n * @fires Phaser.Cameras.Scene2D.Events#SHAKE_START\r\n * @fires Phaser.Cameras.Scene2D.Events#SHAKE_COMPLETE\r\n * @since 3.0.0\r\n *\r\n * @param {number} [duration=100] - The duration of the effect in milliseconds.\r\n * @param {(number|Phaser.Math.Vector2)} [intensity=0.05] - The intensity of the shake.\r\n * @param {boolean} [force=false] - Force the shake effect to start immediately, even if already running.\r\n * @param {function} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 421, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 100, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "number", "Phaser.Math.Vector2" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Math.Vector2" } ] } }, "optional": true, "defaultvalue": 0.05, "description": "The intensity of the shake.", "name": "intensity" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Force the shake effect to start immediately, even if already running.", "name": "force" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt 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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#shake", "scope": "instance", "___id": "T000002R001956", "___s": true }, { "comment": "/**\r\n * This effect will scroll the Camera so that the center of its viewport finishes at the given destination,\r\n * over the duration and with the ease specified.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#pan\r\n * @fires Phaser.Cameras.Scene2D.Events#PAN_START\r\n * @fires Phaser.Cameras.Scene2D.Events#PAN_COMPLETE\r\n * @since 3.11.0\r\n *\r\n * @param {number} x - The destination x coordinate to scroll the center of the Camera viewport to.\r\n * @param {number} y - The destination y coordinate to scroll the center of the Camera viewport to.\r\n * @param {number} [duration=1000] - The duration of the effect in milliseconds.\r\n * @param {(string|function)} [ease='Linear'] - The ease to use for the pan. Can be any of the Phaser Easing constants or a custom function.\r\n * @param {boolean} [force=false] - Force the pan effect to start immediately, even if already running.\r\n * @param {Phaser.Types.Cameras.Scene2D.CameraPanCallback} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\r\n * the current camera scroll x coordinate and the current camera scroll y coordinate.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 443, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "This effect will scroll the Camera so that the center of its viewport finishes at the given destination,\rover 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The destination x coordinate to scroll the center of the Camera viewport to.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The destination y coordinate to scroll the center of the Camera viewport to.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Cameras.Scene2D.CameraPanCallback" } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\rthe current camera scroll x coordinate and the current camera scroll y coordinate.", "name": "callback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#pan", "scope": "instance", "___id": "T000002R001958", "___s": true }, { "comment": "/**\r\n * Rotate the Camera to the given angle over the duration and with the ease specified.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#rotateTo\r\n * @since 3.23.0\r\n *\r\n * @param {number} angle - The destination angle in radians to rotate the Camera view to.\r\n * @param {boolean} [shortestPath=false] - If true, take the shortest distance to the destination. This adjusts the destination angle to be within one half turn of the start angle.\r\n * @param {number} [duration=1000] - The duration of the effect in milliseconds.\r\n * @param {(string|function)} [ease='Linear'] - The ease to use. Can be any of the Phaser Easing constants or a custom function.\r\n * @param {boolean} [force=false] - Force the rotation effect to start immediately, even if already running.\r\n * @param {Phaser.Types.Cameras.Scene2D.CameraRotateCallback} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent three arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\r\n * and the current camera rotation.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {Phaser.Cameras.Scene2D.Camera} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 469, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Rotate the Camera to the given angle over the duration and with the ease specified.", "kind": "function", "name": "rotateTo", "since": "3.23.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The destination angle in radians to rotate the Camera view to.", "name": "angle" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If true, take the shortest distance to the destination. This adjusts the destination angle to be within one half turn of the start angle.", "name": "shortestPath" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "defaultvalue": "'Linear'", "description": "The ease to use. Can be any of the Phaser Easing constants or a custom function.", "name": "ease" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Force the rotation effect to start immediately, even if already running.", "name": "force" }, { "type": { "names": [ "Phaser.Types.Cameras.Scene2D.CameraRotateCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Cameras.Scene2D.CameraRotateCallback" } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt is sent three arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\rand the current camera rotation.", "name": "callback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#rotateTo", "scope": "instance", "___id": "T000002R001960", "___s": true }, { "comment": "/**\r\n * This effect will zoom the Camera to the given scale, over the duration and with the ease specified.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#zoomTo\r\n * @fires Phaser.Cameras.Scene2D.Events#ZOOM_START\r\n * @fires Phaser.Cameras.Scene2D.Events#ZOOM_COMPLETE\r\n * @since 3.11.0\r\n *\r\n * @param {number} zoom - The target Camera zoom value.\r\n * @param {number} [duration=1000] - The duration of the effect in milliseconds.\r\n * @param {(string|function)} [ease='Linear'] - The ease to use for the zoom. Can be any of the Phaser Easing constants or a custom function.\r\n * @param {boolean} [force=false] - Force the zoom effect to start immediately, even if already running.\r\n * @param {Phaser.Types.Cameras.Scene2D.CameraZoomCallback} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent three arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\r\n * and the current camera zoom value.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The target Camera zoom value.", "name": "zoom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Cameras.Scene2D.CameraZoomCallback" } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt is sent three arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\rand the current camera zoom value.", "name": "callback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#zoomTo", "scope": "instance", "___id": "T000002R001962", "___s": true }, { "comment": "/**\r\n * Updates camera matrix. Also resets any active effects on this Camera (such as shake, flash and fade) and quickly clears them all.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#preRender\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 516, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Updates camera matrix. Also resets any active effects on this Camera (such as shake, flash and fade) and quickly clears them all.", "kind": "function", "name": "preRender", "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#preRender", "scope": "instance", "___id": "T000002R001964", "___s": true }, { "comment": "/**\r\n * Returns the view matrix of the camera. This is used internally.\r\n *\r\n * This is `matrix` if the camera is intended to render to a framebuffer,\r\n * and `matrixCombined` otherwise.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#getViewMatrix\r\n * @webglonly\r\n * @since 4.0.0\r\n * @param {boolean} [forceComposite=false] - If `true`, the view matrix will always be `matrix`. This is typically used when rendering to a framebuffer, so the external matrix is irrelevant.\r\n * @return {Phaser.GameObjects.Components.TransformMatrix} The view matrix of the camera.\r\n */", "meta": { "filename": "Camera.js", "lineno": 647, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Returns the view matrix of the camera. This is used internally.\r\rThis is `matrix` if the camera is intended to render to a framebuffer,\rand `matrixCombined` otherwise.", "kind": "function", "name": "getViewMatrix", "tags": [ { "originalTitle": "webglonly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true`, the view matrix will always be `matrix`. This is typically used when rendering to a framebuffer, so the external matrix is irrelevant.", "name": "forceComposite" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The view matrix of the camera." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#getViewMatrix", "scope": "instance", "___id": "T000002R002003", "___s": true }, { "comment": "/**\r\n * Return a proxy for managing camera padding.\r\n *\r\n * Camera padding enlarges the camera, adding to each side of the region.\r\n * This is useful when you need data from just outside the normal\r\n * camera region, e.g. when using a Blur filter.\r\n *\r\n * Use the proxy in place of the camera.\r\n * It conceals the complicated parts, so you can carry on using the camera\r\n * just as before.\r\n * You can still use the original camera to see the adjusted values.\r\n *\r\n * Padding affects the following properties on the original camera:\r\n *\r\n * - Subtracts from `x`, `y`, `scrollX`, `scrollY`.\r\n * - Adds double to `width`, height`.\r\n *\r\n * Padding increases the rendered region, so it can have a performance cost.\r\n * If you don't need the extra data at some time, set padding to 0.\r\n *\r\n * You can't use more than one such proxy at a time. If you try,\r\n * they fight and nobody wins.\r\n *\r\n * @example\r\n * // Create a padding proxy with 16 pixels of padding.\r\n * var proxy = this.cameras.main.getPaddingWrapper(16);\r\n * console.log(proxy.scrollX, this.cameras.main.scrollX); // 0, -16\r\n *\r\n * // Adjust proxy scroll.\r\n * proxy.scrollX += 4;\r\n * console.log(proxy.scrollX, this.cameras.main.scrollX); // 4, -12\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#getPaddingWrapper\r\n * @since 4.0.0\r\n * @param {number} [padding=0] - Initial padding value.\r\n * @return {Phaser.Types.Cameras.Scene2D.CameraPaddingWrapper} The proxy for the camera.\r\n */", "meta": { "filename": "Camera.js", "lineno": 675, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Return a proxy for managing camera padding.\r\rCamera padding enlarges the camera, adding to each side of the region.\rThis is useful when you need data from just outside the normal\rcamera region, e.g. when using a Blur filter.\r\rUse the proxy in place of the camera.\rIt conceals the complicated parts, so you can carry on using the camera\rjust as before.\rYou can still use the original camera to see the adjusted values.\r\rPadding affects the following properties on the original camera:\r\r- Subtracts from `x`, `y`, `scrollX`, `scrollY`.\r- Adds double to `width`, height`.\r\rPadding increases the rendered region, so it can have a performance cost.\rIf you don't need the extra data at some time, set padding to 0.\r\rYou can't use more than one such proxy at a time. If you try,\rthey fight and nobody wins.", "examples": [ "// Create a padding proxy with 16 pixels of padding.\rvar proxy = this.cameras.main.getPaddingWrapper(16);\rconsole.log(proxy.scrollX, this.cameras.main.scrollX); // 0, -16\r\r// Adjust proxy scroll.\rproxy.scrollX += 4;\rconsole.log(proxy.scrollX, this.cameras.main.scrollX); // 4, -12" ], "kind": "function", "name": "getPaddingWrapper", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Initial padding value.", "name": "padding" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Cameras.Scene2D.CameraPaddingWrapper" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Cameras.Scene2D.CameraPaddingWrapper" } }, "description": "The proxy for the camera." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#getPaddingWrapper", "scope": "instance", "___id": "T000002R002005", "___s": true }, { "comment": "/**\r\n * Sets the linear interpolation value to use when following a target.\r\n *\r\n * The default values of 1 means the camera will instantly snap to the target coordinates.\r\n * A lower value, such as 0.1 means the camera will more slowly track the target, giving\r\n * a smooth transition. You can set the horizontal and vertical values independently, and also\r\n * adjust this value in real-time during your game.\r\n *\r\n * Be sure to keep the value between 0 and 1. A value of zero will disable tracking on that axis.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#setLerp\r\n * @since 3.9.0\r\n *\r\n * @param {number} [x=1] - The horizontal linear interpolation value for the follow target. A value between 0 and 1.\r\n * @param {number} [y=1] - The vertical linear interpolation value for the follow target. A value between 0 and 1.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 765, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Sets the linear interpolation value to use when following a target.\r\rThe default values of 1 means the camera will instantly snap to the target coordinates.\rA lower value, such as 0.1 means the camera will more slowly track the target, giving\ra smooth transition. You can set the horizontal and vertical values independently, and also\radjust this value in real-time during your game.\r\rBe 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The horizontal linear interpolation value for the follow target. A value between 0 and 1.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The vertical linear interpolation value for the follow target. A value between 0 and 1.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#setLerp", "scope": "instance", "___id": "T000002R002026", "___s": true }, { "comment": "/**\r\n * Sets the horizontal and vertical offset of the camera from its follow target.\r\n * The values are subtracted from the targets position during the Cameras update step.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#setFollowOffset\r\n * @since 3.9.0\r\n *\r\n * @param {number} [x=0] - The horizontal offset from the camera follow target.x position.\r\n * @param {number} [y=0] - The vertical offset from the camera follow target.y position.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 793, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Sets the horizontal and vertical offset of the camera from its follow target.\rThe values are subtracted from the targets position during the Cameras update step.", "kind": "function", "name": "setFollowOffset", "since": "3.9.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal offset from the camera follow target.x position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical offset from the camera follow target.y position.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#setFollowOffset", "scope": "instance", "___id": "T000002R002030", "___s": true }, { "comment": "/**\r\n * Sets the Camera to follow a Game Object.\r\n *\r\n * When enabled the Camera will automatically adjust its scroll position to keep the target Game Object\r\n * in its center.\r\n *\r\n * You can set the linear interpolation value used in the follow code.\r\n * Use low lerp values (such as 0.1) to automatically smooth the camera motion.\r\n *\r\n * If you find you're getting a slight \"jitter\" effect when following an object it's probably to do with sub-pixel\r\n * rendering of the targets position. This can be rounded by setting the `roundPixels` argument to `true` to\r\n * force full pixel rounding rendering. Note that this can still be broken if you have specified a non-integer zoom\r\n * value on the camera. So be sure to keep the camera zoom to integers.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#startFollow\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|object)} target - The target for the Camera to follow.\r\n * @param {boolean} [roundPixels=false] - Round the camera position to whole integers to avoid sub-pixel rendering?\r\n * @param {number} [lerpX=1] - 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.\r\n * @param {number} [lerpY=1] - 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.\r\n * @param {number} [offsetX=0] - The horizontal offset from the camera follow target.x position.\r\n * @param {number} [offsetY=0] - The vertical offset from the camera follow target.y position.\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 815, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Sets the Camera to follow a Game Object.\r\rWhen enabled the Camera will automatically adjust its scroll position to keep the target Game Object\rin its center.\r\rYou can set the linear interpolation value used in the follow code.\rUse low lerp values (such as 0.1) to automatically smooth the camera motion.\r\rIf you find you're getting a slight \"jitter\" effect when following an object it's probably to do with sub-pixel\rrendering of the targets position. This can be rounded by setting the `roundPixels` argument to `true` to\rforce full pixel rounding rendering. Note that this can still be broken if you have specified a non-integer zoom\rvalue 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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The target for the Camera to follow.", "name": "target" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Round the camera position to whole integers to avoid sub-pixel rendering?", "name": "roundPixels" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal offset from the camera follow target.x position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical offset from the camera follow target.y position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#startFollow", "scope": "instance", "___id": "T000002R002034", "___s": true }, { "comment": "/**\r\n * Stops a Camera from following a Game Object, if previously set via `Camera.startFollow`.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#stopFollow\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 880, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#stopFollow", "scope": "instance", "___id": "T000002R002053", "___s": true }, { "comment": "/**\r\n * Resets any active FX, such as a fade, flash or shake. Useful to call after a fade in order to\r\n * remove the fade.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#resetFX\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Camera instance.\r\n */", "meta": { "filename": "Camera.js", "lineno": 895, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Resets any active FX, such as a fade, flash or shake. Useful to call after a fade in order to\rremove the fade.", "kind": "function", "name": "resetFX", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera instance." } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#resetFX", "scope": "instance", "___id": "T000002R002056", "___s": true }, { "comment": "/**\r\n * Internal method called automatically by the Camera Manager.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#update\r\n * @protected\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "Camera.js", "lineno": 915, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Internal method called automatically by the Camera Manager.", "kind": "function", "name": "update", "access": "protected", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp as generated by the Request Animation Frame or SetTimeout.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time, in ms, elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.Cameras.Scene2D.Camera", "longname": "Phaser.Cameras.Scene2D.Camera#update", "scope": "instance", "overrides": "Phaser.Cameras.Scene2D.BaseCamera#update", "___id": "T000002R002058", "___s": true }, { "comment": "/**\r\n * Destroys this Camera instance. You rarely need to call this directly.\r\n *\r\n * Called by the Camera Manager. If you wish to destroy a Camera please use `CameraManager.remove` as\r\n * cameras are stored in a pool, ready for recycling later, and calling this directly will prevent that.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Camera#destroy\r\n * @fires Phaser.Cameras.Scene2D.Events#DESTROY\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Camera.js", "lineno": 938, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Destroys this Camera instance. You rarely need to call this directly.\r\rCalled by the Camera Manager. If you wish to destroy a Camera please use `CameraManager.remove` as\rcameras 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", "___id": "T000002R002060", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Camera Manager is a plugin that belongs to a Scene and is responsible for managing all of the Scene Cameras.\r\n *\r\n * By default you can access the Camera Manager from within a Scene using `this.cameras`, although this can be changed\r\n * in your game config.\r\n *\r\n * Create new Cameras using the `add` method. Or extend the Camera class with your own addition code and then add\r\n * the new Camera in using the `addExisting` method.\r\n *\r\n * Cameras provide a view into your game world, and can be positioned, rotated, zoomed and scrolled accordingly.\r\n *\r\n * A Camera consists of two elements: The viewport and the scroll values.\r\n *\r\n * The viewport is the physical position and size of the Camera within your game. Cameras, by default, are\r\n * created the same size as your game, but their position and size can be set to anything. This means if you\r\n * wanted to create a camera that was 320x200 in size, positioned in the bottom-right corner of your game,\r\n * you'd adjust the viewport to do that (using methods like `setViewport` and `setSize`).\r\n *\r\n * If you wish to change where the Camera is looking in your game, then you scroll it. You can do this\r\n * via the properties `scrollX` and `scrollY` or the method `setScroll`. Scrolling has no impact on the\r\n * viewport, and changing the viewport has no impact on the scrolling.\r\n *\r\n * By default a Camera will render all Game Objects it can see. You can change this using the `ignore` method,\r\n * allowing you to filter Game Objects out on a per-Camera basis. The Camera Manager can manage up to 31 unique\r\n * 'Game Object ignore capable' Cameras. Any Cameras beyond 31 that you create will all be given a Camera ID of\r\n * zero, meaning that they cannot be used for Game Object exclusion. This means if you need your Camera to ignore\r\n * Game Objects, make sure it's one of the first 31 created.\r\n *\r\n * A Camera also has built-in special effects including Fade, Flash, Camera Shake, Pan and Zoom.\r\n *\r\n * @class CameraManager\r\n * @memberof Phaser.Cameras.Scene2D\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene that owns the Camera Manager plugin.\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "classdesc": "The Camera Manager is a plugin that belongs to a Scene and is responsible for managing all of the Scene Cameras.\r\rBy default you can access the Camera Manager from within a Scene using `this.cameras`, although this can be changed\rin your game config.\r\rCreate new Cameras using the `add` method. Or extend the Camera class with your own addition code and then add\rthe new Camera in using the `addExisting` method.\r\rCameras provide a view into your game world, and can be positioned, rotated, zoomed and scrolled accordingly.\r\rA Camera consists of two elements: The viewport and the scroll values.\r\rThe viewport is the physical position and size of the Camera within your game. Cameras, by default, are\rcreated the same size as your game, but their position and size can be set to anything. This means if you\rwanted to create a camera that was 320x200 in size, positioned in the bottom-right corner of your game,\ryou'd adjust the viewport to do that (using methods like `setViewport` and `setSize`).\r\rIf you wish to change where the Camera is looking in your game, then you scroll it. You can do this\rvia the properties `scrollX` and `scrollY` or the method `setScroll`. Scrolling has no impact on the\rviewport, and changing the viewport has no impact on the scrolling.\r\rBy default a Camera will render all Game Objects it can see. You can change this using the `ignore` method,\rallowing you to filter Game Objects out on a per-Camera basis. The Camera Manager can manage up to 31 unique\r'Game Object ignore capable' Cameras. Any Cameras beyond 31 that you create will all be given a Camera ID of\rzero, meaning that they cannot be used for Game Object exclusion. This means if you need your Camera to ignore\rGame Objects, make sure it's one of the first 31 created.\r\rA 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene that owns the Camera Manager plugin.", "name": "scene" } ], "scope": "static", "longname": "Phaser.Cameras.Scene2D.CameraManager", "___id": "T000002R002072", "___s": true }, { "comment": "/**\r\n * The Scene that owns the Camera Manager plugin.\r\n *\r\n * @name Phaser.Cameras.Scene2D.CameraManager#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The Scene that owns the Camera Manager plugin.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#scene", "scope": "instance", "kind": "member", "___id": "T000002R002075", "___s": true }, { "comment": "/**\r\n * A reference to the Scene.Systems handler for the Scene that owns the Camera Manager.\r\n *\r\n * @name Phaser.Cameras.Scene2D.CameraManager#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "A reference to the Scene.Systems handler for the Scene that owns the Camera Manager.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#systems", "scope": "instance", "kind": "member", "___id": "T000002R002077", "___s": true }, { "comment": "/**\r\n * All Cameras created by, or added to, this Camera Manager, will have their `roundPixels`\r\n * property set to match this value. By default it is set to match the value set in the\r\n * game configuration, but can be changed at any point. Equally, individual cameras can\r\n * also be changed as needed.\r\n *\r\n * @name Phaser.Cameras.Scene2D.CameraManager#roundPixels\r\n * @type {boolean}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "All Cameras created by, or added to, this Camera Manager, will have their `roundPixels`\rproperty set to match this value. By default it is set to match the value set in the\rgame configuration, but can be changed at any point. Equally, individual cameras can\ralso be changed as needed.", "name": "roundPixels", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#roundPixels", "scope": "instance", "kind": "member", "___id": "T000002R002079", "___s": true }, { "comment": "/**\r\n * An Array of the Camera objects being managed by this Camera Manager.\r\n * The Cameras are updated and rendered in the same order in which they appear in this array.\r\n * Do not directly add or remove entries to this array. However, you can move the contents\r\n * around the array should you wish to adjust the display order.\r\n *\r\n * @name Phaser.Cameras.Scene2D.CameraManager#cameras\r\n * @type {Phaser.Cameras.Scene2D.Camera[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 89, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "An Array of the Camera objects being managed by this Camera Manager.\rThe Cameras are updated and rendered in the same order in which they appear in this array.\rDo not directly add or remove entries to this array. However, you can move the contents\raround the array should you wish to adjust the display order.", "name": "cameras", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Cameras.Scene2D.Camera", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#cameras", "scope": "instance", "kind": "member", "___id": "T000002R002081", "___s": true }, { "comment": "/**\r\n * A handy reference to the 'main' camera. By default this is the first Camera the\r\n * Camera Manager creates. You can also set it directly, or use the `makeMain` argument\r\n * in the `add` and `addExisting` methods. It allows you to access it from your game:\r\n *\r\n * ```javascript\r\n * var cam = this.cameras.main;\r\n * ```\r\n *\r\n * Also see the properties `camera1`, `camera2` and so on.\r\n *\r\n * @name Phaser.Cameras.Scene2D.CameraManager#main\r\n * @type {Phaser.Cameras.Scene2D.Camera}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 101, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "A handy reference to the 'main' camera. By default this is the first Camera the\rCamera Manager creates. You can also set it directly, or use the `makeMain` argument\rin the `add` and `addExisting` methods. It allows you to access it from your game:\r\r```javascript\rvar cam = this.cameras.main;\r```\r\rAlso see the properties `camera1`, `camera2` and so on.", "name": "main", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#main", "scope": "instance", "kind": "member", "___id": "T000002R002083", "___s": true }, { "comment": "/**\r\n * A default un-transformed Camera that doesn't exist on the camera list and doesn't\r\n * count towards the total number of cameras being managed. It exists for other\r\n * systems, as well as your own code, should they require a basic un-transformed\r\n * camera instance from which to calculate a view matrix.\r\n *\r\n * @name Phaser.Cameras.Scene2D.CameraManager#default\r\n * @type {Phaser.Cameras.Scene2D.Camera}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 118, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "A default un-transformed Camera that doesn't exist on the camera list and doesn't\rcount towards the total number of cameras being managed. It exists for other\rsystems, as well as your own code, should they require a basic un-transformed\rcamera instance from which to calculate a view matrix.", "name": "default", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "since": "3.17.0", "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#default", "scope": "instance", "kind": "member", "___id": "T000002R002085", "___s": true }, { "comment": "/**\r\n * Adds a new Camera into the Camera Manager. The Camera Manager can support up to 31 different Cameras.\r\n *\r\n * Each Camera has its own viewport, which controls the size of the Camera and its position within the canvas.\r\n *\r\n * Use the `Camera.scrollX` and `Camera.scrollY` properties to change where the Camera is looking, or the\r\n * Camera methods such as `centerOn`. Cameras also have built in special effects, such as fade, flash, shake,\r\n * pan and zoom.\r\n *\r\n * By default Cameras are transparent and will render anything that they can see based on their `scrollX`\r\n * and `scrollY` values. Game Objects can be set to be ignored by a Camera by using the `Camera.ignore` method.\r\n *\r\n * The Camera will have its `roundPixels` property set to whatever `CameraManager.roundPixels` is. You can change\r\n * it after creation if required.\r\n *\r\n * See the Camera class documentation for more details.\r\n *\r\n * @method Phaser.Cameras.Scene2D.CameraManager#add\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of the Camera viewport.\r\n * @param {number} [y=0] - The vertical position of the Camera viewport.\r\n * @param {number} [width] - The width of the Camera viewport. If not given it'll be the game config size.\r\n * @param {number} [height] - The height of the Camera viewport. If not given it'll be the game config size.\r\n * @param {boolean} [makeMain=false] - Set this Camera as being the 'main' camera. This just makes the property `main` a reference to it.\r\n * @param {string} [name=''] - The name of the Camera.\r\n *\r\n * @return {Phaser.Cameras.Scene2D.Camera} The newly created Camera.\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Adds a new Camera into the Camera Manager. The Camera Manager can support up to 31 different Cameras.\r\rEach Camera has its own viewport, which controls the size of the Camera and its position within the canvas.\r\rUse the `Camera.scrollX` and `Camera.scrollY` properties to change where the Camera is looking, or the\rCamera methods such as `centerOn`. Cameras also have built in special effects, such as fade, flash, shake,\rpan and zoom.\r\rBy default Cameras are transparent and will render anything that they can see based on their `scrollX`\rand `scrollY` values. Game Objects can be set to be ignored by a Camera by using the `Camera.ignore` method.\r\rThe Camera will have its `roundPixels` property set to whatever `CameraManager.roundPixels` is. You can change\rit after creation if required.\r\rSee the Camera class documentation for more details.", "kind": "function", "name": "add", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the Camera viewport.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the Camera viewport.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the Camera viewport. If not given it'll be the game config size.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the Camera viewport. If not given it'll be the game config size.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "''", "description": "The name of the Camera.", "name": "name" } ], "returns": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The newly created Camera." } ], "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#add", "scope": "instance", "___id": "T000002R002097", "___s": true }, { "comment": "/**\r\n * Adds an existing Camera into the Camera Manager.\r\n *\r\n * The Camera should either be a `Phaser.Cameras.Scene2D.Camera` instance, or a class that extends from it.\r\n *\r\n * The Camera will have its `roundPixels` property set to whatever `CameraManager.roundPixels` is. You can change\r\n * it after addition if required.\r\n *\r\n * The Camera will be assigned an ID, which is used for Game Object exclusion and then added to the\r\n * manager. As long as it doesn't already exist in the manager it will be added then returned.\r\n *\r\n * If this method returns `null` then the Camera already exists in this Camera Manager.\r\n *\r\n * @method Phaser.Cameras.Scene2D.CameraManager#addExisting\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to be added to the Camera Manager.\r\n * @param {boolean} [makeMain=false] - Set this Camera as being the 'main' camera. This just makes the property `main` a reference to it.\r\n *\r\n * @return {?Phaser.Cameras.Scene2D.Camera} The Camera that was added to the Camera Manager, or `null` if it couldn't be added.\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 261, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Adds an existing Camera into the Camera Manager.\r\rThe Camera should either be a `Phaser.Cameras.Scene2D.Camera` instance, or a class that extends from it.\r\rThe Camera will have its `roundPixels` property set to whatever `CameraManager.roundPixels` is. You can change\rit after addition if required.\r\rThe Camera will be assigned an ID, which is used for Game Object exclusion and then added to the\rmanager. As long as it doesn't already exist in the manager it will be added then returned.\r\rIf 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to be added to the Camera Manager.", "name": "camera" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera", "nullable": true } }, "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", "___id": "T000002R002108", "___s": true }, { "comment": "/**\r\n * Gets the total number of Cameras in this Camera Manager.\r\n *\r\n * If the optional `isVisible` argument is set it will only count Cameras that are currently visible.\r\n *\r\n * @method Phaser.Cameras.Scene2D.CameraManager#getTotal\r\n * @since 3.11.0\r\n *\r\n * @param {boolean} [isVisible=false] - Set to `true` to only include visible Cameras in the total.\r\n *\r\n * @return {number} The total number of Cameras in this Camera Manager.\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 355, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Gets the total number of Cameras in this Camera Manager.\r\rIf 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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Set to `true` to only include visible Cameras in the total.", "name": "isVisible" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of Cameras in this Camera Manager." } ], "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#getTotal", "scope": "instance", "___id": "T000002R002124", "___s": true }, { "comment": "/**\r\n * Populates this Camera Manager based on the given configuration object, or an array of config objects.\r\n *\r\n * See the `Phaser.Types.Cameras.Scene2D.CameraConfig` documentation for details of the object structure.\r\n *\r\n * @method Phaser.Cameras.Scene2D.CameraManager#fromJSON\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Types.Cameras.Scene2D.CameraConfig|Phaser.Types.Cameras.Scene2D.CameraConfig[])} config - A Camera configuration object, or an array of them, to be added to this Camera Manager.\r\n *\r\n * @return {this} This Camera Manager instance.\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 388, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Populates this Camera Manager based on the given configuration object, or an array of config objects.\r\rSee 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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Cameras.Scene2D.CameraConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Cameras.Scene2D.CameraConfig", "type": "NameExpression" } ] } ] } }, "description": "A Camera configuration object, or an array of them, to be added to this Camera Manager.", "name": "config" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Camera Manager instance." } ], "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#fromJSON", "scope": "instance", "___id": "T000002R002131", "___s": true }, { "comment": "/**\r\n * Gets a Camera based on its name.\r\n *\r\n * Camera names are optional and don't have to be set, so this method is only of any use if you\r\n * have given your Cameras unique names.\r\n *\r\n * @method Phaser.Cameras.Scene2D.CameraManager#getCamera\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The name of the Camera.\r\n *\r\n * @return {?Phaser.Cameras.Scene2D.Camera} The first Camera with a name matching the given string, otherwise `null`.\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 457, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Gets a Camera based on its name.\r\rCamera names are optional and don't have to be set, so this method is only of any use if you\rhave given your Cameras unique names.", "kind": "function", "name": "getCamera", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the Camera.", "name": "name" } ], "returns": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera", "nullable": true } }, "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", "___id": "T000002R002156", "___s": true }, { "comment": "/**\r\n * Returns an array of all cameras below the given Pointer.\r\n *\r\n * The first camera in the array is the top-most camera in the camera list.\r\n *\r\n * @method Phaser.Cameras.Scene2D.CameraManager#getCamerasBelowPointer\r\n * @since 3.10.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer to check against.\r\n *\r\n * @return {Phaser.Cameras.Scene2D.Camera[]} An array of cameras below the Pointer.\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 485, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Returns an array of all cameras below the given Pointer.\r\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer to check against.", "name": "pointer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Cameras.Scene2D.Camera", "type": "NameExpression" } ] } }, "description": "An array of cameras below the Pointer." } ], "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#getCamerasBelowPointer", "scope": "instance", "___id": "T000002R002160", "___s": true }, { "comment": "/**\r\n * Removes the given Camera, or an array of Cameras, from this Camera Manager.\r\n *\r\n * If found in the Camera Manager it will be immediately removed from the local cameras array.\r\n * If also currently the 'main' camera, 'main' will be reset to be camera 0.\r\n *\r\n * The removed Cameras are automatically destroyed if the `runDestroy` argument is `true`, which is the default.\r\n * If you wish to re-use the cameras then set this to `false`, but know that they will retain their references\r\n * and internal data until destroyed or re-added to a Camera Manager.\r\n *\r\n * @method Phaser.Cameras.Scene2D.CameraManager#remove\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Cameras.Scene2D.Camera|Phaser.Cameras.Scene2D.Camera[])} camera - The Camera, or an array of Cameras, to be removed from this Camera Manager.\r\n * @param {boolean} [runDestroy=true] - Automatically call `Camera.destroy` on each Camera removed from this Camera Manager.\r\n *\r\n * @return {number} The total number of Cameras removed.\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 520, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Removes the given Camera, or an array of Cameras, from this Camera Manager.\r\rIf found in the Camera Manager it will be immediately removed from the local cameras array.\rIf also currently the 'main' camera, 'main' will be reset to be camera 0.\r\rThe removed Cameras are automatically destroyed if the `runDestroy` argument is `true`, which is the default.\rIf you wish to re-use the cameras then set this to `false`, but know that they will retain their references\rand 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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Cameras.Scene2D.Camera", "type": "NameExpression" } ] } ] } }, "description": "The Camera, or an array of Cameras, to be removed from this Camera Manager.", "name": "camera" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Automatically call `Camera.destroy` on each Camera removed from this Camera Manager.", "name": "runDestroy" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of Cameras removed." } ], "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#remove", "scope": "instance", "___id": "T000002R002168", "___s": true }, { "comment": "/**\r\n * The internal render method. This is called automatically by the Scene and should not be invoked directly.\r\n *\r\n * It will iterate through all local cameras and render them in turn, as long as they're visible and have\r\n * an alpha level > 0.\r\n *\r\n * @method Phaser.Cameras.Scene2D.CameraManager#render\r\n * @protected\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - The Renderer that will render the children to this camera.\r\n * @param {Phaser.GameObjects.DisplayList} displayList - The Display List for the Scene.\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 579, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The internal render method. This is called automatically by the Scene and should not be invoked directly.\r\rIt will iterate through all local cameras and render them in turn, as long as they're visible and have\ran alpha level > 0.", "kind": "function", "name": "render", "access": "protected", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Renderer.Canvas.CanvasRenderer", "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.Canvas.CanvasRenderer" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } ] } }, "description": "The Renderer that will render the children to this camera.", "name": "renderer" }, { "type": { "names": [ "Phaser.GameObjects.DisplayList" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.DisplayList" } }, "description": "The Display List for the Scene.", "name": "displayList" } ], "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#render", "scope": "instance", "___id": "T000002R002178", "___s": true }, { "comment": "/**\r\n * Takes an array of Game Objects and a Camera and returns a new array\r\n * containing only those Game Objects that pass the `willRender` test\r\n * against the given Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.CameraManager#getVisibleChildren\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject[]} children - An array of Game Objects to be checked against the camera.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera to filter the Game Objects against.\r\n *\r\n * @return {Phaser.GameObjects.GameObject[]} A filtered list of only Game Objects within the Scene that will render against the given Camera.\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 612, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Takes an array of Game Objects and a Camera and returns a new array\rcontaining only those Game Objects that pass the `willRender` test\ragainst the given Camera.", "kind": "function", "name": "getVisibleChildren", "since": "3.50.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "An array of Game Objects to be checked against the camera.", "name": "children" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera to filter the Game Objects against.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "A filtered list of only Game Objects within the Scene that will render against the given Camera." } ], "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#getVisibleChildren", "scope": "instance", "___id": "T000002R002185", "___s": true }, { "comment": "/**\r\n * Resets this Camera Manager.\r\n *\r\n * This will iterate through all current Cameras, destroying them all, then it will reset the\r\n * cameras array, reset the ID counter and create 1 new single camera using the default values.\r\n *\r\n * @method Phaser.Cameras.Scene2D.CameraManager#resetAll\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Cameras.Scene2D.Camera} The freshly created main Camera.\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 633, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Resets this Camera Manager.\r\rThis will iterate through all current Cameras, destroying them all, then it will reset the\rcameras 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The freshly created main Camera." } ], "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#resetAll", "scope": "instance", "___id": "T000002R002187", "___s": true }, { "comment": "/**\r\n * The main update loop. Called automatically when the Scene steps.\r\n *\r\n * @method Phaser.Cameras.Scene2D.CameraManager#update\r\n * @protected\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 658, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "The main update loop. Called automatically when the Scene steps.", "kind": "function", "name": "update", "access": "protected", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp as generated by the Request Animation Frame or SetTimeout.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time, in ms, elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#update", "scope": "instance", "___id": "T000002R002192", "___s": true }, { "comment": "/**\r\n * The event handler that manages the `resize` event dispatched by the Scale Manager.\r\n *\r\n * @method Phaser.Cameras.Scene2D.CameraManager#onResize\r\n * @since 3.18.0\r\n *\r\n * @param {Phaser.Structs.Size} gameSize - The default Game Size object. This is the un-modified game dimensions.\r\n * @param {Phaser.Structs.Size} baseSize - The base Size object. The game dimensions. The canvas width / height values match this.\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 676, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Size" } }, "description": "The default Game Size object. This is the un-modified game dimensions.", "name": "gameSize" }, { "type": { "names": [ "Phaser.Structs.Size" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Structs.Size" } }, "description": "The base Size object. The game dimensions. The canvas width / height values match this.", "name": "baseSize" } ], "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#onResize", "scope": "instance", "___id": "T000002R002195", "___s": true }, { "comment": "/**\r\n * Resizes all cameras to the given dimensions.\r\n *\r\n * @method Phaser.Cameras.Scene2D.CameraManager#resize\r\n * @since 3.2.0\r\n *\r\n * @param {number} width - The new width of the camera.\r\n * @param {number} height - The new height of the camera.\r\n */", "meta": { "filename": "CameraManager.js", "lineno": 701, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "description": "Resizes all cameras to the given dimensions.", "kind": "function", "name": "resize", "since": "3.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the camera.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new height of the camera.", "name": "height" } ], "memberof": "Phaser.Cameras.Scene2D.CameraManager", "longname": "Phaser.Cameras.Scene2D.CameraManager#resize", "scope": "instance", "___id": "T000002R002199", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Camera Fade effect.\r\n *\r\n * This effect will fade the camera viewport to the given color, over the duration specified.\r\n *\r\n * Only the camera viewport is faded. None of the objects it is displaying are impacted, i.e. their colors do\r\n * not change.\r\n *\r\n * The effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\r\n * which is invoked each frame for the duration of the effect, if required.\r\n *\r\n * @class Fade\r\n * @memberof Phaser.Cameras.Scene2D.Effects\r\n * @constructor\r\n * @since 3.5.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera this effect is acting upon.\r\n */", "meta": { "filename": "Fade.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "classdesc": "A Camera Fade effect.\r\rThis effect will fade the camera viewport to the given color, over the duration specified.\r\rOnly the camera viewport is faded. None of the objects it is displaying are impacted, i.e. their colors do\rnot change.\r\rThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\rwhich 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera this effect is acting upon.", "name": "camera" } ], "scope": "static", "longname": "Phaser.Cameras.Scene2D.Effects.Fade", "___id": "T000002R002216", "___s": true }, { "comment": "/**\r\n * The Camera this effect belongs to.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Fade#camera\r\n * @type {Phaser.Cameras.Scene2D.Camera}\r\n * @readonly\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Fade.js", "lineno": 36, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The Camera this effect belongs to.", "name": "camera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002219", "___s": true }, { "comment": "/**\r\n * Is this effect actively running?\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Fade#isRunning\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Fade.js", "lineno": 46, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Is this effect actively running?", "name": "isRunning", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002221", "___s": true }, { "comment": "/**\r\n * Has this effect finished running?\r\n *\r\n * This is different from `isRunning` because it remains set to `true` when the effect is over,\r\n * until the effect is either reset or started again.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Fade#isComplete\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Fade.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Has this effect finished running?\r\rThis is different from `isRunning` because it remains set to `true` when the effect is over,\runtil the effect is either reset or started again.", "name": "isComplete", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002223", "___s": true }, { "comment": "/**\r\n * The direction of the fade.\r\n * `true` = fade out (transparent to color), `false` = fade in (color to transparent)\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Fade#direction\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Fade.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The direction of the fade.\r`true` = fade out (transparent to color), `false` = fade in (color to transparent)", "name": "direction", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.5.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Fade", "longname": "Phaser.Cameras.Scene2D.Effects.Fade#direction", "scope": "instance", "kind": "member", "___id": "T000002R002225", "___s": true }, { "comment": "/**\r\n * The duration of the effect, in milliseconds.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Fade#duration\r\n * @type {number}\r\n * @readonly\r\n * @default 0\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Fade.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The duration of the effect, in milliseconds.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R002227", "___s": true }, { "comment": "/**\r\n * If this effect is running this holds the current percentage of the progress, a value between 0 and 1.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Fade#progress\r\n * @type {number}\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Fade.js", "lineno": 137, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.5.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Fade", "longname": "Phaser.Cameras.Scene2D.Effects.Fade#progress", "scope": "instance", "kind": "member", "___id": "T000002R002237", "___s": true }, { "comment": "/**\r\n * Fades the Camera to or from the given color over the duration specified.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Fade#start\r\n * @fires Phaser.Cameras.Scene2D.Events#FADE_IN_START\r\n * @fires Phaser.Cameras.Scene2D.Events#FADE_OUT_START\r\n * @since 3.5.0\r\n *\r\n * @param {boolean} [direction=true] - The direction of the fade. `true` = fade out (transparent to color), `false` = fade in (color to transparent)\r\n * @param {number} [duration=1000] - The duration of the effect in milliseconds.\r\n * @param {number} [red=0] - The amount to fade the red channel towards. A value between 0 and 255.\r\n * @param {number} [green=0] - The amount to fade the green channel towards. A value between 0 and 255.\r\n * @param {number} [blue=0] - The amount to fade the blue channel towards. A value between 0 and 255.\r\n * @param {boolean} [force=false] - Force the effect to start immediately, even if already running.\r\n * @param {Phaser.Types.Cameras.Scene2D.CameraFadeCallback} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {Phaser.Cameras.Scene2D.Camera} The Camera on which the effect was started.\r\n */", "meta": { "filename": "Fade.js", "lineno": 178, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the red channel towards. A value between 0 and 255.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the green channel towards. A value between 0 and 255.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount to fade the blue channel towards. A value between 0 and 255.", "name": "blue" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Cameras.Scene2D.CameraFadeCallback" } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002245", "___s": true }, { "comment": "/**\r\n * The main update loop for this effect. Called automatically by the Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Fade#update\r\n * @since 3.5.0\r\n *\r\n * @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "Fade.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The main update loop for this effect. Called automatically by the Camera.", "kind": "function", "name": "update", "since": "3.5.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp as generated by the Request Animation Frame or SetTimeout.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002268", "___s": true }, { "comment": "/**\r\n * Called internally by the Canvas Renderer.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Fade#postRenderCanvas\r\n * @since 3.5.0\r\n *\r\n * @param {CanvasRenderingContext2D} ctx - The Canvas context to render to.\r\n *\r\n * @return {boolean} `true` if the effect drew to the renderer, otherwise `false`.\r\n */", "meta": { "filename": "Fade.js", "lineno": 273, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Called internally by the Canvas Renderer.", "kind": "function", "name": "postRenderCanvas", "since": "3.5.0", "params": [ { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "description": "The Canvas context to render to.", "name": "ctx" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002274", "___s": true }, { "comment": "/**\r\n * Called internally by the WebGL Renderer.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Fade#postRenderWebGL\r\n * @since 3.5.0\r\n *\r\n * @return {boolean} `true` if the effect should draw to the renderer, otherwise `false`.\r\n */", "meta": { "filename": "Fade.js", "lineno": 298, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Called internally by the WebGL Renderer.", "kind": "function", "name": "postRenderWebGL", "since": "3.5.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the effect should draw to the renderer, otherwise `false`." } ], "memberof": "Phaser.Cameras.Scene2D.Effects.Fade", "longname": "Phaser.Cameras.Scene2D.Effects.Fade#postRenderWebGL", "scope": "instance", "___id": "T000002R002278", "___s": true }, { "comment": "/**\r\n * Called internally when the effect completes.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Fade#effectComplete\r\n * @fires Phaser.Cameras.Scene2D.Events#FADE_IN_COMPLETE\r\n * @fires Phaser.Cameras.Scene2D.Events#FADE_OUT_COMPLETE\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Fade.js", "lineno": 311, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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", "___id": "T000002R002280", "___s": true }, { "comment": "/**\r\n * Resets this camera effect.\r\n * If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Fade#reset\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Fade.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Resets this camera effect.\rIf 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", "___id": "T000002R002287", "___s": true }, { "comment": "/**\r\n * Destroys this effect, releasing it from the Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Fade#destroy\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Fade.js", "lineno": 348, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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", "___id": "T000002R002293", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Camera Flash effect.\r\n *\r\n * This effect will flash the camera viewport to the given color, over the duration specified.\r\n *\r\n * Only the camera viewport is flashed. None of the objects it is displaying are impacted, i.e. their colors do\r\n * not change.\r\n *\r\n * The effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\r\n * which is invoked each frame for the duration of the effect, if required.\r\n *\r\n * @class Flash\r\n * @memberof Phaser.Cameras.Scene2D.Effects\r\n * @constructor\r\n * @since 3.5.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera this effect is acting upon.\r\n */", "meta": { "filename": "Flash.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "classdesc": "A Camera Flash effect.\r\rThis effect will flash the camera viewport to the given color, over the duration specified.\r\rOnly the camera viewport is flashed. None of the objects it is displaying are impacted, i.e. their colors do\rnot change.\r\rThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\rwhich 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera this effect is acting upon.", "name": "camera" } ], "scope": "static", "longname": "Phaser.Cameras.Scene2D.Effects.Flash", "___id": "T000002R002300", "___s": true }, { "comment": "/**\r\n * The Camera this effect belongs to.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Flash#camera\r\n * @type {Phaser.Cameras.Scene2D.Camera}\r\n * @readonly\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Flash.js", "lineno": 36, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The Camera this effect belongs to.", "name": "camera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002303", "___s": true }, { "comment": "/**\r\n * Is this effect actively running?\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Flash#isRunning\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Flash.js", "lineno": 46, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Is this effect actively running?", "name": "isRunning", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002305", "___s": true }, { "comment": "/**\r\n * The duration of the effect, in milliseconds.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Flash#duration\r\n * @type {number}\r\n * @readonly\r\n * @default 0\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Flash.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The duration of the effect, in milliseconds.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R002307", "___s": true }, { "comment": "/**\r\n * The value of the alpha channel used during the flash effect.\r\n * A value between 0 and 1.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Flash#alpha\r\n * @type {number}\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Flash.js", "lineno": 101, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The value of the alpha channel used during the flash effect.\rA value between 0 and 1.", "name": "alpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.5.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Flash", "longname": "Phaser.Cameras.Scene2D.Effects.Flash#alpha", "scope": "instance", "kind": "member", "___id": "T000002R002315", "___s": true }, { "comment": "/**\r\n * If this effect is running this holds the current percentage of the progress, a value between 0 and 1.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Flash#progress\r\n * @type {number}\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Flash.js", "lineno": 111, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.5.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Flash", "longname": "Phaser.Cameras.Scene2D.Effects.Flash#progress", "scope": "instance", "kind": "member", "___id": "T000002R002317", "___s": true }, { "comment": "/**\r\n * Flashes the Camera to or from the given color over the duration specified.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Flash#start\r\n * @fires Phaser.Cameras.Scene2D.Events#FLASH_START\r\n * @fires Phaser.Cameras.Scene2D.Events#FLASH_COMPLETE\r\n * @since 3.5.0\r\n *\r\n * @param {number} [duration=250] - The duration of the effect in milliseconds.\r\n * @param {number} [red=255] - The amount to flash the red channel towards. A value between 0 and 255.\r\n * @param {number} [green=255] - The amount to flash the green channel towards. A value between 0 and 255.\r\n * @param {number} [blue=255] - The amount to flash the blue channel towards. A value between 0 and 255.\r\n * @param {boolean} [force=false] - Force the effect to start immediately, even if already running.\r\n * @param {Phaser.Types.Cameras.Scene2D.CameraFlashCallback} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {Phaser.Cameras.Scene2D.Camera} The Camera on which the effect was started.\r\n */", "meta": { "filename": "Flash.js", "lineno": 163, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 250, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The amount to flash the red channel towards. A value between 0 and 255.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The amount to flash the green channel towards. A value between 0 and 255.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The amount to flash the blue channel towards. A value between 0 and 255.", "name": "blue" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Cameras.Scene2D.CameraFlashCallback" } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002327", "___s": true }, { "comment": "/**\r\n * The main update loop for this effect. Called automatically by the Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Flash#update\r\n * @since 3.5.0\r\n *\r\n * @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "Flash.js", "lineno": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The main update loop for this effect. Called automatically by the Camera.", "kind": "function", "name": "update", "since": "3.5.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp as generated by the Request Animation Frame or SetTimeout.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002346", "___s": true }, { "comment": "/**\r\n * Called internally by the Canvas Renderer.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Flash#postRenderCanvas\r\n * @since 3.5.0\r\n *\r\n * @param {CanvasRenderingContext2D} ctx - The Canvas context to render to.\r\n *\r\n * @return {boolean} `true` if the effect drew to the renderer, otherwise `false`.\r\n */", "meta": { "filename": "Flash.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Called internally by the Canvas Renderer.", "kind": "function", "name": "postRenderCanvas", "since": "3.5.0", "params": [ { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "description": "The Canvas context to render to.", "name": "ctx" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002351", "___s": true }, { "comment": "/**\r\n * Called internally by the WebGL Renderer.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Flash#postRenderWebGL\r\n * @since 3.5.0\r\n *\r\n * @return {boolean} `true` if the effect should draw to the renderer, otherwise `false`.\r\n */", "meta": { "filename": "Flash.js", "lineno": 276, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Called internally by the WebGL Renderer.", "kind": "function", "name": "postRenderWebGL", "since": "3.5.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the effect should draw to the renderer, otherwise `false`." } ], "memberof": "Phaser.Cameras.Scene2D.Effects.Flash", "longname": "Phaser.Cameras.Scene2D.Effects.Flash#postRenderWebGL", "scope": "instance", "___id": "T000002R002355", "___s": true }, { "comment": "/**\r\n * Called internally when the effect completes.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Flash#effectComplete\r\n * @fires Phaser.Cameras.Scene2D.Events#FLASH_COMPLETE\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Flash.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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", "___id": "T000002R002357", "___s": true }, { "comment": "/**\r\n * Resets this camera effect.\r\n * If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Flash#reset\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Flash.js", "lineno": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Resets this camera effect.\rIf 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", "___id": "T000002R002363", "___s": true }, { "comment": "/**\r\n * Destroys this effect, releasing it from the Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Flash#destroy\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Flash.js", "lineno": 322, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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", "___id": "T000002R002368", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Cameras.Scene2D.Effects\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "kind": "namespace", "name": "Effects", "memberof": "Phaser.Cameras.Scene2D", "longname": "Phaser.Cameras.Scene2D.Effects", "scope": "static", "___id": "T000002R002372", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Camera Pan effect.\r\n *\r\n * This effect will scroll the Camera so that the center of its viewport finishes at the given destination,\r\n * over the duration and with the ease specified.\r\n *\r\n * Only the camera scroll is moved. None of the objects it is displaying are impacted, i.e. their positions do\r\n * not change.\r\n *\r\n * The effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\r\n * which is invoked each frame for the duration of the effect if required.\r\n *\r\n * @class Pan\r\n * @memberof Phaser.Cameras.Scene2D.Effects\r\n * @constructor\r\n * @since 3.11.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera this effect is acting upon.\r\n */", "meta": { "filename": "Pan.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "classdesc": "A Camera Pan effect.\r\rThis effect will scroll the Camera so that the center of its viewport finishes at the given destination,\rover the duration and with the ease specified.\r\rOnly the camera scroll is moved. None of the objects it is displaying are impacted, i.e. their positions do\rnot change.\r\rThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\rwhich 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera this effect is acting upon.", "name": "camera" } ], "scope": "static", "longname": "Phaser.Cameras.Scene2D.Effects.Pan", "___id": "T000002R002385", "___s": true }, { "comment": "/**\r\n * The Camera this effect belongs to.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Pan#camera\r\n * @type {Phaser.Cameras.Scene2D.Camera}\r\n * @readonly\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Pan.js", "lineno": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The Camera this effect belongs to.", "name": "camera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002388", "___s": true }, { "comment": "/**\r\n * Is this effect actively running?\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Pan#isRunning\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Pan.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Is this effect actively running?", "name": "isRunning", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002390", "___s": true }, { "comment": "/**\r\n * The duration of the effect, in milliseconds.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Pan#duration\r\n * @type {number}\r\n * @readonly\r\n * @default 0\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Pan.js", "lineno": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The duration of the effect, in milliseconds.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R002392", "___s": true }, { "comment": "/**\r\n * The starting scroll coordinates to pan the camera from.\r\n * \r\n * @name Phaser.Cameras.Scene2D.Effects.Pan#source\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Pan.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The starting scroll coordinates to pan the camera from.", "name": "source", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Pan", "longname": "Phaser.Cameras.Scene2D.Effects.Pan#source", "scope": "instance", "kind": "member", "___id": "T000002R002394", "___s": true }, { "comment": "/**\r\n * The zoom-adjusted scroll coordinates of the camera, recalculated each frame during the pan\r\n * to account for the current camera zoom level. Used as an intermediate value when interpolating\r\n * between the source and destination scroll positions.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Pan#current\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Pan.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The zoom-adjusted scroll coordinates of the camera, recalculated each frame during the pan\rto account for the current camera zoom level. Used as an intermediate value when interpolating\rbetween the source and destination scroll positions.", "name": "current", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Pan", "longname": "Phaser.Cameras.Scene2D.Effects.Pan#current", "scope": "instance", "kind": "member", "___id": "T000002R002396", "___s": true }, { "comment": "/**\r\n * The destination scroll coordinates to pan the camera to.\r\n * \r\n * @name Phaser.Cameras.Scene2D.Effects.Pan#destination\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Pan.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The destination scroll coordinates to pan the camera to.", "name": "destination", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Pan", "longname": "Phaser.Cameras.Scene2D.Effects.Pan#destination", "scope": "instance", "kind": "member", "___id": "T000002R002398", "___s": true }, { "comment": "/**\r\n * The ease function to use during the pan.\r\n * \r\n * @name Phaser.Cameras.Scene2D.Effects.Pan#ease\r\n * @type {function}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Pan.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The ease function to use during the pan.", "name": "ease", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Pan", "longname": "Phaser.Cameras.Scene2D.Effects.Pan#ease", "scope": "instance", "kind": "member", "___id": "T000002R002400", "___s": true }, { "comment": "/**\r\n * If this effect is running this holds the current percentage of the progress, a value between 0 and 1.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Pan#progress\r\n * @type {number}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Pan.js", "lineno": 109, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Pan", "longname": "Phaser.Cameras.Scene2D.Effects.Pan#progress", "scope": "instance", "kind": "member", "___id": "T000002R002402", "___s": true }, { "comment": "/**\r\n * This effect will scroll the Camera so that the center of its viewport finishes at the given destination,\r\n * over the duration and with the ease specified.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Pan#start\r\n * @fires Phaser.Cameras.Scene2D.Events#PAN_START\r\n * @fires Phaser.Cameras.Scene2D.Events#PAN_COMPLETE\r\n * @since 3.11.0\r\n *\r\n * @param {number} x - The destination x coordinate to scroll the center of the Camera viewport to.\r\n * @param {number} y - The destination y coordinate to scroll the center of the Camera viewport to.\r\n * @param {number} [duration=1000] - The duration of the effect in milliseconds.\r\n * @param {(string|function)} [ease='Linear'] - The ease to use for the pan. Can be any of the Phaser Easing constants or a custom function.\r\n * @param {boolean} [force=false] - Force the pan effect to start immediately, even if already running.\r\n * @param {Phaser.Types.Cameras.Scene2D.CameraPanCallback} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\r\n * the current camera scroll x coordinate and the current camera scroll y coordinate.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {Phaser.Cameras.Scene2D.Camera} The Camera on which the effect was started.\r\n */", "meta": { "filename": "Pan.js", "lineno": 150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "This effect will scroll the Camera so that the center of its viewport finishes at the given destination,\rover 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The destination x coordinate to scroll the center of the Camera viewport to.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The destination y coordinate to scroll the center of the Camera viewport to.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Cameras.Scene2D.CameraPanCallback" } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\rthe current camera scroll x coordinate and the current camera scroll y coordinate.", "name": "callback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002410", "___s": true }, { "comment": "/**\r\n * The main update loop for this effect. Called automatically by the Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Pan#update\r\n * @since 3.11.0\r\n *\r\n * @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "Pan.js", "lineno": 219, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The main update loop for this effect. Called automatically by the Camera.", "kind": "function", "name": "update", "since": "3.11.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp as generated by the Request Animation Frame or SetTimeout.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002426", "___s": true }, { "comment": "/**\r\n * Called internally when the effect completes.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Pan#effectComplete\r\n * @fires Phaser.Cameras.Scene2D.Events#PAN_COMPLETE\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Pan.js", "lineno": 272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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", "___id": "T000002R002435", "___s": true }, { "comment": "/**\r\n * Resets this camera effect.\r\n * If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Pan#reset\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Pan.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Resets this camera effect.\rIf 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", "___id": "T000002R002440", "___s": true }, { "comment": "/**\r\n * Destroys this effect, releasing it from the Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Pan#destroy\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Pan.js", "lineno": 304, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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", "___id": "T000002R002445", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Camera Rotate effect that smoothly rotates the Camera to a target angle over a specified duration.\r\n *\r\n * This effect will rotate the Camera so that its viewport finishes at the given angle in radians,\r\n * over the duration and with the ease specified.\r\n *\r\n * Camera rotation always takes place based on the Camera viewport. By default, rotation happens\r\n * in the center of the viewport. You can adjust this with the `originX` and `originY` properties.\r\n *\r\n * Rotation influences the rendering of _all_ Game Objects visible by this Camera. However, it does not\r\n * rotate the Camera viewport itself, which always remains an axis-aligned rectangle.\r\n *\r\n * Only the camera is rotated. None of the objects it is displaying are impacted, i.e. their positions do\r\n * not change.\r\n *\r\n * The effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\r\n * which is invoked each frame for the duration of the effect if required.\r\n *\r\n * @class RotateTo\r\n * @memberof Phaser.Cameras.Scene2D.Effects\r\n * @constructor\r\n * @since 3.23.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera this effect is acting upon.\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "classdesc": "A Camera Rotate effect that smoothly rotates the Camera to a target angle over a specified duration.\r\rThis effect will rotate the Camera so that its viewport finishes at the given angle in radians,\rover the duration and with the ease specified.\r\rCamera rotation always takes place based on the Camera viewport. By default, rotation happens\rin the center of the viewport. You can adjust this with the `originX` and `originY` properties.\r\rRotation influences the rendering of _all_ Game Objects visible by this Camera. However, it does not\rrotate the Camera viewport itself, which always remains an axis-aligned rectangle.\r\rOnly the camera is rotated. None of the objects it is displaying are impacted, i.e. their positions do\rnot change.\r\rThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\rwhich is invoked each frame for the duration of the effect if required.", "kind": "class", "name": "RotateTo", "memberof": "Phaser.Cameras.Scene2D.Effects", "since": "3.23.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera this effect is acting upon.", "name": "camera" } ], "scope": "static", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo", "___id": "T000002R002456", "___s": true }, { "comment": "/**\r\n * The Camera this effect belongs to.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.RotateTo#camera\r\n * @type {Phaser.Cameras.Scene2D.Camera}\r\n * @readonly\r\n * @since 3.23.0\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The Camera this effect belongs to.", "name": "camera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "readonly": true, "since": "3.23.0", "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#camera", "scope": "instance", "kind": "member", "___id": "T000002R002459", "___s": true }, { "comment": "/**\r\n * Is this effect actively running?\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.RotateTo#isRunning\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.23.0\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 55, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Is this effect actively running?", "name": "isRunning", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "false", "since": "3.23.0", "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#isRunning", "scope": "instance", "kind": "member", "___id": "T000002R002461", "___s": true }, { "comment": "/**\r\n * The duration of the effect, in milliseconds.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.RotateTo#duration\r\n * @type {number}\r\n * @readonly\r\n * @default 0\r\n * @since 3.23.0\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The duration of the effect, in milliseconds.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0", "since": "3.23.0", "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#duration", "scope": "instance", "kind": "member", "___id": "T000002R002463", "___s": true }, { "comment": "/**\r\n * The starting angle to rotate the camera from, in radians.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.RotateTo#source\r\n * @type {number}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The starting angle to rotate the camera from, in radians.", "name": "source", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.23.0", "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#source", "scope": "instance", "kind": "member", "___id": "T000002R002465", "___s": true }, { "comment": "/**\r\n * The current camera angle during the rotation, in radians.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.RotateTo#current\r\n * @type {number}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The current camera angle during the rotation, in radians.", "name": "current", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.23.0", "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#current", "scope": "instance", "kind": "member", "___id": "T000002R002467", "___s": true }, { "comment": "/**\r\n * The destination angle to rotate the camera to, in radians.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.RotateTo#destination\r\n * @type {number}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The destination angle to rotate the camera to, in radians.", "name": "destination", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.23.0", "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#destination", "scope": "instance", "kind": "member", "___id": "T000002R002469", "___s": true }, { "comment": "/**\r\n * The ease function to use during the rotation.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.RotateTo#ease\r\n * @type {function}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The ease function to use during the rotation.", "name": "ease", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.23.0", "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#ease", "scope": "instance", "kind": "member", "___id": "T000002R002471", "___s": true }, { "comment": "/**\r\n * If this effect is running this holds the current progress, a value between 0 (start) and 1 (end).\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.RotateTo#progress\r\n * @type {number}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "If this effect is running this holds the current progress, a value between 0 (start) and 1 (end).", "name": "progress", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.23.0", "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#progress", "scope": "instance", "kind": "member", "___id": "T000002R002473", "___s": true }, { "comment": "/**\r\n * Whether the rotation is progressing in a clockwise (`true`) or counter-clockwise (`false`) direction.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.RotateTo#clockwise\r\n * @type {boolean}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 153, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Whether the rotation is progressing in a clockwise (`true`) or counter-clockwise (`false`) direction.", "name": "clockwise", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.23.0", "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#clockwise", "scope": "instance", "kind": "member", "___id": "T000002R002481", "___s": true }, { "comment": "/**\r\n * Whether the effect should rotate via the shortest angular path to the destination angle.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.RotateTo#shortestPath\r\n * @type {boolean}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Whether the effect should rotate via the shortest angular path to the destination angle.", "name": "shortestPath", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.23.0", "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#shortestPath", "scope": "instance", "kind": "member", "___id": "T000002R002483", "___s": true }, { "comment": "/**\r\n * Rotate the Camera to the given angle over the duration and with the ease specified.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.RotateTo#start\r\n * @fires Phaser.Cameras.Scene2D.Events#ROTATE_START\r\n * @fires Phaser.Cameras.Scene2D.Events#ROTATE_COMPLETE\r\n * @since 3.23.0\r\n *\r\n * @param {number} angle - The destination angle in radians to rotate the Camera view to.\r\n * @param {boolean} [shortestPath=false] - If true, take the shortest distance to the destination. This adjusts the destination angle to be within one half turn of the start angle.\r\n * @param {number} [duration=1000] - The duration of the effect in milliseconds.\r\n * @param {(string|function)} [ease='Linear'] - The ease to use. Can be any of the Phaser Easing constants or a custom function.\r\n * @param {boolean} [force=false] - Force the rotation effect to start immediately, even if already running.\r\n * @param {Phaser.Types.Cameras.Scene2D.CameraRotateCallback} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent three arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\r\n * and the current camera rotation.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {Phaser.Cameras.Scene2D.Camera} The Camera on which the effect was started.\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 172, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Rotate the Camera to the given angle over the duration and with the ease specified.", "kind": "function", "name": "start", "fires": [ "Phaser.Cameras.Scene2D.Events#event:ROTATE_START", "Phaser.Cameras.Scene2D.Events#event:ROTATE_COMPLETE" ], "since": "3.23.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The destination angle in radians to rotate the Camera view to.", "name": "angle" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If true, take the shortest distance to the destination. This adjusts the destination angle to be within one half turn of the start angle.", "name": "shortestPath" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "defaultvalue": "'Linear'", "description": "The ease to use. Can be any of the Phaser Easing constants or a custom function.", "name": "ease" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Force the rotation effect to start immediately, even if already running.", "name": "force" }, { "type": { "names": [ "Phaser.Types.Cameras.Scene2D.CameraRotateCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Cameras.Scene2D.CameraRotateCallback" } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt is sent three arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\rand the current camera rotation.", "name": "callback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera on which the effect was started." } ], "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#start", "scope": "instance", "___id": "T000002R002485", "___s": true }, { "comment": "/**\r\n * The main update loop for this effect. Called automatically by the Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.RotateTo#update\r\n * @since 3.23.0\r\n *\r\n * @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The main update loop for this effect. Called automatically by the Camera.", "kind": "function", "name": "update", "since": "3.23.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp as generated by the Request Animation Frame or SetTimeout.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time, in ms, elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#update", "scope": "instance", "___id": "T000002R002509", "___s": true }, { "comment": "/**\r\n * Called internally when the effect completes.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.RotateTo#effectComplete\r\n * @since 3.23.0\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 305, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Called internally when the effect completes.", "kind": "function", "name": "effectComplete", "since": "3.23.0", "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#effectComplete", "scope": "instance", "___id": "T000002R002521", "___s": true }, { "comment": "/**\r\n * Resets this camera effect.\r\n * If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.RotateTo#reset\r\n * @since 3.23.0\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 321, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Resets this camera effect.\rIf it was previously running, it stops instantly without calling its onComplete callback or emitting an event.", "kind": "function", "name": "reset", "since": "3.23.0", "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#reset", "scope": "instance", "___id": "T000002R002526", "___s": true }, { "comment": "/**\r\n * Destroys this effect, releasing it from the Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.RotateTo#destroy\r\n * @since 3.23.0\r\n */", "meta": { "filename": "RotateTo.js", "lineno": 336, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Destroys this effect, releasing it from the Camera.", "kind": "function", "name": "destroy", "since": "3.23.0", "memberof": "Phaser.Cameras.Scene2D.Effects.RotateTo", "longname": "Phaser.Cameras.Scene2D.Effects.RotateTo#destroy", "scope": "instance", "___id": "T000002R002531", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Camera Shake effect.\r\n *\r\n * This effect will shake the camera viewport by a random amount, bounded by the specified intensity, each frame.\r\n *\r\n * Only the camera viewport is moved. None of the objects it is displaying are impacted, i.e. their positions do\r\n * not change.\r\n *\r\n * The effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\r\n * which is invoked each frame for the duration of the effect if required.\r\n *\r\n * @class Shake\r\n * @memberof Phaser.Cameras.Scene2D.Effects\r\n * @constructor\r\n * @since 3.5.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera this effect is acting upon.\r\n */", "meta": { "filename": "Shake.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "classdesc": "A Camera Shake effect.\r\rThis effect will shake the camera viewport by a random amount, bounded by the specified intensity, each frame.\r\rOnly the camera viewport is moved. None of the objects it is displaying are impacted, i.e. their positions do\rnot change.\r\rThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\rwhich 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera this effect is acting upon.", "name": "camera" } ], "scope": "static", "longname": "Phaser.Cameras.Scene2D.Effects.Shake", "___id": "T000002R002541", "___s": true }, { "comment": "/**\r\n * The Camera this effect belongs to.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Shake#camera\r\n * @type {Phaser.Cameras.Scene2D.Camera}\r\n * @readonly\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Shake.js", "lineno": 37, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The Camera this effect belongs to.", "name": "camera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002544", "___s": true }, { "comment": "/**\r\n * Is this effect actively running?\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Shake#isRunning\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Shake.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Is this effect actively running?", "name": "isRunning", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002546", "___s": true }, { "comment": "/**\r\n * The duration of the effect, in milliseconds.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Shake#duration\r\n * @type {number}\r\n * @readonly\r\n * @default 0\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Shake.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The duration of the effect, in milliseconds.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R002548", "___s": true }, { "comment": "/**\r\n * The intensity of the effect. Use small float values. The default when the effect starts is 0.05.\r\n * This is a Vector2 object, allowing you to control the shake intensity independently across x and y.\r\n * You can modify this value while the effect is active to create more varied shake effects.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Shake#intensity\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Shake.js", "lineno": 69, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The intensity of the effect. Use small float values. The default when the effect starts is 0.05.\rThis is a Vector2 object, allowing you to control the shake intensity independently across x and y.\rYou can modify this value while the effect is active to create more varied shake effects.", "name": "intensity", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.5.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Shake", "longname": "Phaser.Cameras.Scene2D.Effects.Shake#intensity", "scope": "instance", "kind": "member", "___id": "T000002R002550", "___s": true }, { "comment": "/**\r\n * If this effect is running this holds the current percentage of the progress, a value between 0 and 1.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Shake#progress\r\n * @type {number}\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Shake.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.5.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Shake", "longname": "Phaser.Cameras.Scene2D.Effects.Shake#progress", "scope": "instance", "kind": "member", "___id": "T000002R002552", "___s": true }, { "comment": "/**\r\n * Shakes the Camera by the given intensity over the duration specified.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Shake#start\r\n * @fires Phaser.Cameras.Scene2D.Events#SHAKE_START\r\n * @fires Phaser.Cameras.Scene2D.Events#SHAKE_COMPLETE\r\n * @since 3.5.0\r\n *\r\n * @param {number} [duration=100] - The duration of the effect in milliseconds.\r\n * @param {(number|Phaser.Math.Vector2)} [intensity=0.05] - The intensity of the shake.\r\n * @param {boolean} [force=false] - Force the shake effect to start immediately, even if already running.\r\n * @param {Phaser.Types.Cameras.Scene2D.CameraShakeCallback} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {Phaser.Cameras.Scene2D.Camera} The Camera on which the effect was started.\r\n */", "meta": { "filename": "Shake.js", "lineno": 143, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 100, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "number", "Phaser.Math.Vector2" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Math.Vector2" } ] } }, "optional": true, "defaultvalue": 0.05, "description": "The intensity of the shake.", "name": "intensity" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Cameras.Scene2D.CameraShakeCallback" } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002564", "___s": true }, { "comment": "/**\r\n * The pre-render step for this effect. Called automatically by the Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Shake#preRender\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Shake.js", "lineno": 198, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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", "___id": "T000002R002579", "___s": true }, { "comment": "/**\r\n * The main update loop for this effect. Called automatically by the Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Shake#update\r\n * @since 3.5.0\r\n *\r\n * @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "Shake.js", "lineno": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The main update loop for this effect. Called automatically by the Camera.", "kind": "function", "name": "update", "since": "3.5.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp as generated by the Request Animation Frame or SetTimeout.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002581", "___s": true }, { "comment": "/**\r\n * Called internally when the effect completes.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Shake#effectComplete\r\n * @fires Phaser.Cameras.Scene2D.Events#SHAKE_COMPLETE\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Shake.js", "lineno": 259, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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", "___id": "T000002R002593", "___s": true }, { "comment": "/**\r\n * Resets this camera effect.\r\n * If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Shake#reset\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Shake.js", "lineno": 279, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Resets this camera effect.\rIf 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", "___id": "T000002R002600", "___s": true }, { "comment": "/**\r\n * Destroys this effect, releasing it from the Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Shake#destroy\r\n * @since 3.5.0\r\n */", "meta": { "filename": "Shake.js", "lineno": 297, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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", "___id": "T000002R002607", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Camera Zoom effect.\r\n *\r\n * This effect smoothly animates a Camera's zoom level from its current value to a target zoom value over a\r\n * specified duration. Use it to create cinematic zoom-in or zoom-out transitions, focus the player's\r\n * attention on a point of interest, or produce dramatic effects such as a slow zoom during a cutscene.\r\n *\r\n * The effect integrates with Phaser's easing system, allowing any of the built-in easing functions (or a\r\n * custom one) to control the interpolation curve. It is accessed via `Camera.zoomTo` rather than being\r\n * instantiated directly.\r\n *\r\n * The effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\r\n * which is invoked each frame for the duration of the effect if required.\r\n *\r\n * @class Zoom\r\n * @memberof Phaser.Cameras.Scene2D.Effects\r\n * @constructor\r\n * @since 3.11.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera this effect is acting upon.\r\n */", "meta": { "filename": "Zoom.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "classdesc": "A Camera Zoom effect.\r\rThis effect smoothly animates a Camera's zoom level from its current value to a target zoom value over a\rspecified duration. Use it to create cinematic zoom-in or zoom-out transitions, focus the player's\rattention on a point of interest, or produce dramatic effects such as a slow zoom during a cutscene.\r\rThe effect integrates with Phaser's easing system, allowing any of the built-in easing functions (or a\rcustom one) to control the interpolation curve. It is accessed via `Camera.zoomTo` rather than being\rinstantiated directly.\r\rThe effect will dispatch several events on the Camera itself and you can also specify an `onUpdate` callback,\rwhich 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera this effect is acting upon.", "name": "camera" } ], "scope": "static", "longname": "Phaser.Cameras.Scene2D.Effects.Zoom", "___id": "T000002R002616", "___s": true }, { "comment": "/**\r\n * The Camera this effect belongs to.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Zoom#camera\r\n * @type {Phaser.Cameras.Scene2D.Camera}\r\n * @readonly\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Zoom.js", "lineno": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The Camera this effect belongs to.", "name": "camera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002619", "___s": true }, { "comment": "/**\r\n * Is this effect actively running?\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Zoom#isRunning\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Zoom.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Is this effect actively running?", "name": "isRunning", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002621", "___s": true }, { "comment": "/**\r\n * The duration of the effect, in milliseconds.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Zoom#duration\r\n * @type {number}\r\n * @readonly\r\n * @default 0\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Zoom.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The duration of the effect, in milliseconds.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R002623", "___s": true }, { "comment": "/**\r\n * The starting zoom value.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Zoom#source\r\n * @type {number}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Zoom.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The starting zoom value.", "name": "source", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Zoom", "longname": "Phaser.Cameras.Scene2D.Effects.Zoom#source", "scope": "instance", "kind": "member", "___id": "T000002R002625", "___s": true }, { "comment": "/**\r\n * The destination zoom value.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Zoom#destination\r\n * @type {number}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Zoom.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The destination zoom value.", "name": "destination", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Zoom", "longname": "Phaser.Cameras.Scene2D.Effects.Zoom#destination", "scope": "instance", "kind": "member", "___id": "T000002R002627", "___s": true }, { "comment": "/**\r\n * The ease function to use during the zoom.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Zoom#ease\r\n * @type {function}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Zoom.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The ease function to use during the zoom.", "name": "ease", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Zoom", "longname": "Phaser.Cameras.Scene2D.Effects.Zoom#ease", "scope": "instance", "kind": "member", "___id": "T000002R002629", "___s": true }, { "comment": "/**\r\n * If this effect is running this holds the current percentage of the progress, a value between 0 and 1.\r\n *\r\n * @name Phaser.Cameras.Scene2D.Effects.Zoom#progress\r\n * @type {number}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Zoom.js", "lineno": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.11.0", "memberof": "Phaser.Cameras.Scene2D.Effects.Zoom", "longname": "Phaser.Cameras.Scene2D.Effects.Zoom#progress", "scope": "instance", "kind": "member", "___id": "T000002R002631", "___s": true }, { "comment": "/**\r\n * This effect will zoom the Camera to the given scale, over the duration and with the ease specified.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Zoom#start\r\n * @fires Phaser.Cameras.Scene2D.Events#ZOOM_START\r\n * @fires Phaser.Cameras.Scene2D.Events#ZOOM_COMPLETE\r\n * @since 3.11.0\r\n *\r\n * @param {number} zoom - The target Camera zoom value.\r\n * @param {number} [duration=1000] - The duration of the effect in milliseconds.\r\n * @param {(string|function)} [ease='Linear'] - The ease to use for the Zoom. Can be any of the Phaser Easing constants or a custom function.\r\n * @param {boolean} [force=false] - Force the zoom effect to start immediately, even if already running.\r\n * @param {Phaser.Types.Cameras.Scene2D.CameraZoomCallback} [callback] - This callback will be invoked every frame for the duration of the effect.\r\n * It is sent three arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\r\n * and the current camera zoom value.\r\n * @param {any} [context] - The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.\r\n *\r\n * @return {Phaser.Cameras.Scene2D.Camera} The Camera on which the effect was started.\r\n */", "meta": { "filename": "Zoom.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The target Camera zoom value.", "name": "zoom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the effect in milliseconds.", "name": "duration" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Cameras.Scene2D.CameraZoomCallback" } }, "optional": true, "description": "This callback will be invoked every frame for the duration of the effect.\rIt is sent three arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,\rand the current camera zoom value.", "name": "callback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002639", "___s": true }, { "comment": "/**\r\n * The main update loop for this effect. Called automatically by the Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Zoom#update\r\n * @since 3.11.0\r\n *\r\n * @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "Zoom.js", "lineno": 204, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "The main update loop for this effect. Called automatically by the Camera.", "kind": "function", "name": "update", "since": "3.11.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp as generated by the Request Animation Frame or SetTimeout.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002657", "___s": true }, { "comment": "/**\r\n * Called internally when the effect completes.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Zoom#effectComplete\r\n * @fires Phaser.Cameras.Scene2D.Events#ZOOM_COMPLETE\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Zoom.js", "lineno": 246, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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", "___id": "T000002R002663", "___s": true }, { "comment": "/**\r\n * Resets this camera effect.\r\n * If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Zoom#reset\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Zoom.js", "lineno": 263, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "description": "Resets this camera effect.\rIf 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", "___id": "T000002R002668", "___s": true }, { "comment": "/**\r\n * Destroys this effect, releasing it from the Camera.\r\n *\r\n * @method Phaser.Cameras.Scene2D.Effects.Zoom#destroy\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Zoom.js", "lineno": 278, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\effects", "code": {} }, "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", "___id": "T000002R002673", "___s": true }, { "comment": "/**\r\n * The Destroy Camera Event.\r\n *\r\n * This event is dispatched by a Camera instance when it is destroyed by the Camera Manager.\r\n *\r\n * Listen for it via either of the following:\r\n *\r\n * ```js\r\n * this.cameras.main.on('cameradestroy', () => {});\r\n * ```\r\n *\r\n * or use the constant, to avoid having to remember the correct event string:\r\n *\r\n * ```js\r\n * this.cameras.main.on(Phaser.Cameras.Scene2D.Events.DESTROY, () => {});\r\n * ```\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#DESTROY\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.BaseCamera} camera - The camera that was destroyed.\r\n */", "meta": { "filename": "DESTROY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Destroy Camera Event.\r\rThis event is dispatched by a Camera instance when it is destroyed by the Camera Manager.\r\rListen for it via either of the following:\r\r```js\rthis.cameras.main.on('cameradestroy', () => {});\r```\r\ror use the constant, to avoid having to remember the correct event string:\r\r```js\rthis.cameras.main.on(Phaser.Cameras.Scene2D.Events.DESTROY, () => {});\r```", "kind": "event", "name": "DESTROY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.BaseCamera" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002677", "___s": true }, { "comment": "/**\r\n * The Camera Fade In Complete Event.\r\n *\r\n * This event is dispatched by a Camera instance when the Fade In Effect completes.\r\n *\r\n * Listen to it from a Camera instance using `Camera.on('camerafadeincomplete', listener)`.\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#FADE_IN_COMPLETE\r\n * @type {string}\r\n * @since 3.3.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.\r\n * @param {Phaser.Cameras.Scene2D.Effects.Fade} effect - A reference to the effect instance.\r\n */", "meta": { "filename": "FADE_IN_COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Fade In Complete Event.\r\rThis event is dispatched by a Camera instance when the Fade In Effect completes.\r\rListen to it from a Camera instance using `Camera.on('camerafadeincomplete', listener)`.", "kind": "event", "name": "FADE_IN_COMPLETE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.3.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that the effect began on.", "name": "camera" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Fade" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002679", "___s": true }, { "comment": "/**\r\n * The Camera Fade In Start Event.\r\n *\r\n * This event is dispatched by a Camera instance when the Fade In Effect starts.\r\n *\r\n * Listen to it from a Camera instance using `Camera.on('camerafadeinstart', listener)`.\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#FADE_IN_START\r\n * @type {string}\r\n * @since 3.3.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.\r\n * @param {Phaser.Cameras.Scene2D.Effects.Fade} effect - A reference to the effect instance.\r\n * @param {number} duration - The duration of the effect.\r\n * @param {number} red - The red color channel value.\r\n * @param {number} green - The green color channel value.\r\n * @param {number} blue - The blue color channel value.\r\n */", "meta": { "filename": "FADE_IN_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Fade In Start Event.\r\rThis event is dispatched by a Camera instance when the Fade In Effect starts.\r\rListen to it from a Camera instance using `Camera.on('camerafadeinstart', listener)`.", "kind": "event", "name": "FADE_IN_START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.3.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that the effect began on.", "name": "camera" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Fade" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Effects.Fade" } }, "description": "A reference to the effect instance.", "name": "effect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the effect.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The red color channel value.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The green color channel value.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blue color channel value.", "name": "blue" } ], "memberof": "Phaser.Cameras.Scene2D.Events", "longname": "Phaser.Cameras.Scene2D.Events#event:FADE_IN_START", "scope": "instance", "___id": "T000002R002681", "___s": true }, { "comment": "/**\r\n * The Camera Fade Out Complete Event.\r\n *\r\n * This event is dispatched by a Camera instance when the Fade Out Effect completes.\r\n *\r\n * Listen to it from a Camera instance using `Camera.on('camerafadeoutcomplete', listener)`.\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#FADE_OUT_COMPLETE\r\n * @type {string}\r\n * @since 3.3.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.\r\n * @param {Phaser.Cameras.Scene2D.Effects.Fade} effect - A reference to the effect instance.\r\n */", "meta": { "filename": "FADE_OUT_COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Fade Out Complete Event.\r\rThis event is dispatched by a Camera instance when the Fade Out Effect completes.\r\rListen to it from a Camera instance using `Camera.on('camerafadeoutcomplete', listener)`.", "kind": "event", "name": "FADE_OUT_COMPLETE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.3.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that the effect began on.", "name": "camera" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Fade" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002683", "___s": true }, { "comment": "/**\r\n * The Camera Fade Out Start Event.\r\n *\r\n * This event is dispatched by a Camera instance when the Fade Out Effect starts.\r\n *\r\n * Listen to it from a Camera instance using `Camera.on('camerafadeoutstart', listener)`.\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#FADE_OUT_START\r\n * @type {string}\r\n * @since 3.3.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.\r\n * @param {Phaser.Cameras.Scene2D.Effects.Fade} effect - A reference to the effect instance.\r\n * @param {number} duration - The duration of the effect.\r\n * @param {number} red - The red color channel value.\r\n * @param {number} green - The green color channel value.\r\n * @param {number} blue - The blue color channel value.\r\n */", "meta": { "filename": "FADE_OUT_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Fade Out Start Event.\r\rThis event is dispatched by a Camera instance when the Fade Out Effect starts.\r\rListen to it from a Camera instance using `Camera.on('camerafadeoutstart', listener)`.", "kind": "event", "name": "FADE_OUT_START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.3.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that the effect began on.", "name": "camera" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Fade" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Effects.Fade" } }, "description": "A reference to the effect instance.", "name": "effect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the effect.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The red color channel value.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The green color channel value.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blue color channel value.", "name": "blue" } ], "memberof": "Phaser.Cameras.Scene2D.Events", "longname": "Phaser.Cameras.Scene2D.Events#event:FADE_OUT_START", "scope": "instance", "___id": "T000002R002685", "___s": true }, { "comment": "/**\r\n * The Camera Flash Complete Event.\r\n *\r\n * This event is dispatched by a Camera instance when the Flash Effect completes.\r\n *\r\n * Listen for it via either of the following:\r\n *\r\n * ```js\r\n * this.cameras.main.on('cameraflashcomplete', () => {});\r\n * ```\r\n *\r\n * or use the constant, to avoid having to remember the correct event string:\r\n *\r\n * ```js\r\n * this.cameras.main.on(Phaser.Cameras.Scene2D.Events.FLASH_COMPLETE, () => {});\r\n * ```\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#FLASH_COMPLETE\r\n * @type {string}\r\n * @since 3.3.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.\r\n * @param {Phaser.Cameras.Scene2D.Effects.Flash} effect - A reference to the effect instance.\r\n */", "meta": { "filename": "FLASH_COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Flash Complete Event.\r\rThis event is dispatched by a Camera instance when the Flash Effect completes.\r\rListen for it via either of the following:\r\r```js\rthis.cameras.main.on('cameraflashcomplete', () => {});\r```\r\ror use the constant, to avoid having to remember the correct event string:\r\r```js\rthis.cameras.main.on(Phaser.Cameras.Scene2D.Events.FLASH_COMPLETE, () => {});\r```", "kind": "event", "name": "FLASH_COMPLETE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.3.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that the effect began on.", "name": "camera" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Flash" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002687", "___s": true }, { "comment": "/**\r\n * The Camera Flash Start Event.\r\n *\r\n * This event is dispatched by a Camera instance when the Flash Effect starts.\r\n *\r\n * Listen for it via either of the following:\r\n *\r\n * ```js\r\n * this.cameras.main.on('cameraflashstart', () => {});\r\n * ```\r\n *\r\n * or use the constant, to avoid having to remember the correct event string:\r\n *\r\n * ```js\r\n * this.cameras.main.on(Phaser.Cameras.Scene2D.Events.FLASH_START, () => {});\r\n * ```\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#FLASH_START\r\n * @type {string}\r\n * @since 3.3.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.\r\n * @param {Phaser.Cameras.Scene2D.Effects.Flash} effect - A reference to the effect instance.\r\n * @param {number} duration - The duration of the effect.\r\n * @param {number} red - The red color channel value.\r\n * @param {number} green - The green color channel value.\r\n * @param {number} blue - The blue color channel value.\r\n */", "meta": { "filename": "FLASH_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Flash Start Event.\r\rThis event is dispatched by a Camera instance when the Flash Effect starts.\r\rListen for it via either of the following:\r\r```js\rthis.cameras.main.on('cameraflashstart', () => {});\r```\r\ror use the constant, to avoid having to remember the correct event string:\r\r```js\rthis.cameras.main.on(Phaser.Cameras.Scene2D.Events.FLASH_START, () => {});\r```", "kind": "event", "name": "FLASH_START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.3.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that the effect began on.", "name": "camera" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Flash" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Effects.Flash" } }, "description": "A reference to the effect instance.", "name": "effect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the effect.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The red color channel value.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The green color channel value.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blue color channel value.", "name": "blue" } ], "memberof": "Phaser.Cameras.Scene2D.Events", "longname": "Phaser.Cameras.Scene2D.Events#event:FLASH_START", "scope": "instance", "___id": "T000002R002689", "___s": true }, { "comment": "/**\r\n * The Camera Follower Update Event.\r\n *\r\n * This event is dispatched by a Camera instance when it is following a\r\n * Game Object and the Camera position has been updated as a result of\r\n * that following.\r\n *\r\n * Listen to it from a Camera instance using: `camera.on('followupdate', listener)`.\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#FOLLOW_UPDATE\r\n * @type {string}\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.BaseCamera} camera - The camera that emitted the event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object the camera is following.\r\n */", "meta": { "filename": "FOLLOW_UPDATE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Follower Update Event.\r\rThis event is dispatched by a Camera instance when it is following a\rGame Object and the Camera position has been updated as a result of\rthat following.\r\rListen to it from a Camera instance using: `camera.on('followupdate', listener)`.", "kind": "event", "name": "FOLLOW_UPDATE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.BaseCamera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.BaseCamera" } }, "description": "The camera that emitted the event.", "name": "camera" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object the camera is following.", "name": "gameObject" } ], "memberof": "Phaser.Cameras.Scene2D.Events", "longname": "Phaser.Cameras.Scene2D.Events#event:FOLLOW_UPDATE", "scope": "instance", "___id": "T000002R002691", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Cameras.Scene2D.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Cameras.Scene2D", "longname": "Phaser.Cameras.Scene2D.Events", "scope": "static", "___id": "T000002R002693", "___s": true }, { "comment": "/**\r\n * The Camera Pan Complete Event.\r\n *\r\n * This event is dispatched by a Camera instance when the Pan Effect completes.\r\n *\r\n * Listen for it via either of the following:\r\n *\r\n * ```js\r\n * this.cameras.main.on('camerapancomplete', () => {});\r\n * ```\r\n *\r\n * or use the constant, to avoid having to remember the correct event string:\r\n *\r\n * ```js\r\n * this.cameras.main.on(Phaser.Cameras.Scene2D.Events.PAN_COMPLETE, () => {});\r\n * ```\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#PAN_COMPLETE\r\n * @type {string}\r\n * @since 3.3.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.\r\n * @param {Phaser.Cameras.Scene2D.Effects.Pan} effect - A reference to the effect instance.\r\n */", "meta": { "filename": "PAN_COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Pan Complete Event.\r\rThis event is dispatched by a Camera instance when the Pan Effect completes.\r\rListen for it via either of the following:\r\r```js\rthis.cameras.main.on('camerapancomplete', () => {});\r```\r\ror use the constant, to avoid having to remember the correct event string:\r\r```js\rthis.cameras.main.on(Phaser.Cameras.Scene2D.Events.PAN_COMPLETE, () => {});\r```", "kind": "event", "name": "PAN_COMPLETE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.3.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that the effect began on.", "name": "camera" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Pan" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002713", "___s": true }, { "comment": "/**\r\n * The Camera Pan Start Event.\r\n *\r\n * This event is dispatched by a Camera instance when the Pan Effect starts.\r\n *\r\n * Listen for it via either of the following:\r\n *\r\n * ```js\r\n * this.cameras.main.on('camerapanstart', () => {});\r\n * ```\r\n *\r\n * or use the constant, to avoid having to remember the correct event string:\r\n *\r\n * ```js\r\n * this.cameras.main.on(Phaser.Cameras.Scene2D.Events.PAN_START, () => {});\r\n * ```\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#PAN_START\r\n * @type {string}\r\n * @since 3.3.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.\r\n * @param {Phaser.Cameras.Scene2D.Effects.Pan} effect - A reference to the effect instance.\r\n * @param {number} duration - The duration of the effect.\r\n * @param {number} x - The destination scroll x coordinate.\r\n * @param {number} y - The destination scroll y coordinate.\r\n */", "meta": { "filename": "PAN_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Pan Start Event.\r\rThis event is dispatched by a Camera instance when the Pan Effect starts.\r\rListen for it via either of the following:\r\r```js\rthis.cameras.main.on('camerapanstart', () => {});\r```\r\ror use the constant, to avoid having to remember the correct event string:\r\r```js\rthis.cameras.main.on(Phaser.Cameras.Scene2D.Events.PAN_START, () => {});\r```", "kind": "event", "name": "PAN_START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.3.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that the effect began on.", "name": "camera" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Pan" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Effects.Pan" } }, "description": "A reference to the effect instance.", "name": "effect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the effect.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The destination scroll x coordinate.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The destination scroll y coordinate.", "name": "y" } ], "memberof": "Phaser.Cameras.Scene2D.Events", "longname": "Phaser.Cameras.Scene2D.Events#event:PAN_START", "scope": "instance", "___id": "T000002R002715", "___s": true }, { "comment": "/**\r\n * The Camera Post-Render Event.\r\n *\r\n * This event is dispatched by a Camera instance after is has finished rendering.\r\n * It is dispatched whether the Camera is rendering to a texture or to the main canvas.\r\n *\r\n * Listen to it from a Camera instance using: `camera.on('postrender', listener)`.\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#POST_RENDER\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.BaseCamera} camera - The camera that has finished rendering to a texture.\r\n */", "meta": { "filename": "POST_RENDER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Post-Render Event.\r\rThis event is dispatched by a Camera instance after is has finished rendering.\rIt is dispatched whether the Camera is rendering to a texture or to the main canvas.\r\rListen to it from a Camera instance using: `camera.on('postrender', listener)`.", "kind": "event", "name": "POST_RENDER", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.BaseCamera" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002717", "___s": true }, { "comment": "/**\r\n * The Camera Pre-Render Event.\r\n *\r\n * This event is dispatched by a Camera instance when it is about to render.\r\n * It is only dispatched if the Camera is rendering to a texture.\r\n *\r\n * Listen to it from a Camera instance using: `camera.on('prerender', listener)`.\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#PRE_RENDER\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.BaseCamera} camera - The camera that is about to render to a texture.\r\n */", "meta": { "filename": "PRE_RENDER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Pre-Render Event.\r\rThis event is dispatched by a Camera instance when it is about to render.\rIt is only dispatched if the Camera is rendering to a texture.\r\rListen to it from a Camera instance using: `camera.on('prerender', listener)`.", "kind": "event", "name": "PRE_RENDER", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.BaseCamera" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002719", "___s": true }, { "comment": "/**\r\n * The Camera Rotate Complete Event.\r\n *\r\n * This event is dispatched by a Camera instance when the Rotate Effect completes.\r\n *\r\n * Listen for it via either of the following:\r\n *\r\n * ```js\r\n * this.cameras.main.on('camerarotatecomplete', () => {});\r\n * ```\r\n *\r\n * or use the constant, to avoid having to remember the correct event string:\r\n *\r\n * ```js\r\n * this.cameras.main.on(Phaser.Cameras.Scene2D.Events.ROTATE_COMPLETE, () => {});\r\n * ```\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#ROTATE_COMPLETE\r\n * @type {string}\r\n * @since 3.23.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.\r\n * @param {Phaser.Cameras.Scene2D.Effects.RotateTo} effect - A reference to the effect instance.\r\n */", "meta": { "filename": "ROTATE_COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Rotate Complete Event.\r\rThis event is dispatched by a Camera instance when the Rotate Effect completes.\r\rListen for it via either of the following:\r\r```js\rthis.cameras.main.on('camerarotatecomplete', () => {});\r```\r\ror use the constant, to avoid having to remember the correct event string:\r\r```js\rthis.cameras.main.on(Phaser.Cameras.Scene2D.Events.ROTATE_COMPLETE, () => {});\r```", "kind": "event", "name": "ROTATE_COMPLETE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.23.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that the effect began on.", "name": "camera" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.RotateTo" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Effects.RotateTo" } }, "description": "A reference to the effect instance.", "name": "effect" } ], "memberof": "Phaser.Cameras.Scene2D.Events", "longname": "Phaser.Cameras.Scene2D.Events#event:ROTATE_COMPLETE", "scope": "instance", "___id": "T000002R002721", "___s": true }, { "comment": "/**\r\n * The Camera Rotate Start Event.\r\n *\r\n * This event is dispatched by a Camera instance when the Rotate Effect starts.\r\n *\r\n * Listen for it via either of the following:\r\n *\r\n * ```js\r\n * this.cameras.main.on('camerarotatestart', () => {});\r\n * ```\r\n *\r\n * or use the constant, to avoid having to remember the correct event string:\r\n *\r\n * ```js\r\n * this.cameras.main.on(Phaser.Cameras.Scene2D.Events.ROTATE_START, () => {});\r\n * ```\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#ROTATE_START\r\n * @type {string}\r\n * @since 3.23.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.\r\n * @param {Phaser.Cameras.Scene2D.Effects.RotateTo} effect - A reference to the effect instance.\r\n * @param {number} duration - The duration of the effect.\r\n * @param {number} destination - The destination value.\r\n */", "meta": { "filename": "ROTATE_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Rotate Start Event.\r\rThis event is dispatched by a Camera instance when the Rotate Effect starts.\r\rListen for it via either of the following:\r\r```js\rthis.cameras.main.on('camerarotatestart', () => {});\r```\r\ror use the constant, to avoid having to remember the correct event string:\r\r```js\rthis.cameras.main.on(Phaser.Cameras.Scene2D.Events.ROTATE_START, () => {});\r```", "kind": "event", "name": "ROTATE_START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.23.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that the effect began on.", "name": "camera" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.RotateTo" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Effects.RotateTo" } }, "description": "A reference to the effect instance.", "name": "effect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the effect.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The destination value.", "name": "destination" } ], "memberof": "Phaser.Cameras.Scene2D.Events", "longname": "Phaser.Cameras.Scene2D.Events#event:ROTATE_START", "scope": "instance", "___id": "T000002R002723", "___s": true }, { "comment": "/**\r\n * The Camera Shake Complete Event.\r\n *\r\n * This event is dispatched by a Camera instance when the Shake Effect completes.\r\n *\r\n * Listen for it via either of the following:\r\n *\r\n * ```js\r\n * this.cameras.main.on('camerashakecomplete', () => {});\r\n * ```\r\n *\r\n * or use the constant, to avoid having to remember the correct event string:\r\n *\r\n * ```js\r\n * this.cameras.main.on(Phaser.Cameras.Scene2D.Events.SHAKE_COMPLETE, () => {});\r\n * ```\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#SHAKE_COMPLETE\r\n * @type {string}\r\n * @since 3.3.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.\r\n * @param {Phaser.Cameras.Scene2D.Effects.Shake} effect - A reference to the effect instance.\r\n */", "meta": { "filename": "SHAKE_COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Shake Complete Event.\r\rThis event is dispatched by a Camera instance when the Shake Effect completes.\r\rListen for it via either of the following:\r\r```js\rthis.cameras.main.on('camerashakecomplete', () => {});\r```\r\ror use the constant, to avoid having to remember the correct event string:\r\r```js\rthis.cameras.main.on(Phaser.Cameras.Scene2D.Events.SHAKE_COMPLETE, () => {});\r```", "kind": "event", "name": "SHAKE_COMPLETE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.3.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that the effect began on.", "name": "camera" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Shake" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002725", "___s": true }, { "comment": "/**\r\n * The Camera Shake Start Event.\r\n *\r\n * This event is dispatched by a Camera instance when the Shake Effect starts.\r\n *\r\n * Listen for it via either of the following:\r\n *\r\n * ```js\r\n * this.cameras.main.on('camerashakestart', () => {});\r\n * ```\r\n *\r\n * or use the constant, to avoid having to remember the correct event string:\r\n *\r\n * ```js\r\n * this.cameras.main.on(Phaser.Cameras.Scene2D.Events.SHAKE_START, () => {});\r\n * ```\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#SHAKE_START\r\n * @type {string}\r\n * @since 3.3.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.\r\n * @param {Phaser.Cameras.Scene2D.Effects.Shake} effect - A reference to the effect instance.\r\n * @param {number} duration - The duration of the effect.\r\n * @param {number} intensity - The intensity of the effect.\r\n */", "meta": { "filename": "SHAKE_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Shake Start Event.\r\rThis event is dispatched by a Camera instance when the Shake Effect starts.\r\rListen for it via either of the following:\r\r```js\rthis.cameras.main.on('camerashakestart', () => {});\r```\r\ror use the constant, to avoid having to remember the correct event string:\r\r```js\rthis.cameras.main.on(Phaser.Cameras.Scene2D.Events.SHAKE_START, () => {});\r```", "kind": "event", "name": "SHAKE_START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.3.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that the effect began on.", "name": "camera" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Shake" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Effects.Shake" } }, "description": "A reference to the effect instance.", "name": "effect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the effect.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The intensity of the effect.", "name": "intensity" } ], "memberof": "Phaser.Cameras.Scene2D.Events", "longname": "Phaser.Cameras.Scene2D.Events#event:SHAKE_START", "scope": "instance", "___id": "T000002R002727", "___s": true }, { "comment": "/**\r\n * The Camera Zoom Complete Event.\r\n *\r\n * This event is dispatched by a Camera instance when the Zoom Effect completes.\r\n *\r\n * Listen for it via either of the following:\r\n *\r\n * ```js\r\n * this.cameras.main.on('camerazoomcomplete', () => {});\r\n * ```\r\n *\r\n * or use the constant, to avoid having to remember the correct event string:\r\n *\r\n * ```js\r\n * this.cameras.main.on(Phaser.Cameras.Scene2D.Events.ZOOM_COMPLETE, () => {});\r\n * ```\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#ZOOM_COMPLETE\r\n * @type {string}\r\n * @since 3.3.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.\r\n * @param {Phaser.Cameras.Scene2D.Effects.Zoom} effect - A reference to the effect instance.\r\n */", "meta": { "filename": "ZOOM_COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Zoom Complete Event.\r\rThis event is dispatched by a Camera instance when the Zoom Effect completes.\r\rListen for it via either of the following:\r\r```js\rthis.cameras.main.on('camerazoomcomplete', () => {});\r```\r\ror use the constant, to avoid having to remember the correct event string:\r\r```js\rthis.cameras.main.on(Phaser.Cameras.Scene2D.Events.ZOOM_COMPLETE, () => {});\r```", "kind": "event", "name": "ZOOM_COMPLETE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.3.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that the effect began on.", "name": "camera" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Zoom" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002729", "___s": true }, { "comment": "/**\r\n * The Camera Zoom Start Event.\r\n *\r\n * This event is dispatched by a Camera instance when the Zoom Effect starts.\r\n *\r\n * Listen for it via either of the following:\r\n *\r\n * ```js\r\n * this.cameras.main.on('camerazoomstart', () => {});\r\n * ```\r\n *\r\n * or use the constant, to avoid having to remember the correct event string:\r\n *\r\n * ```js\r\n * this.cameras.main.on(Phaser.Cameras.Scene2D.Events.ZOOM_START, () => {});\r\n * ```\r\n *\r\n * @event Phaser.Cameras.Scene2D.Events#ZOOM_START\r\n * @type {string}\r\n * @since 3.3.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.\r\n * @param {Phaser.Cameras.Scene2D.Effects.Zoom} effect - A reference to the effect instance.\r\n * @param {number} duration - The duration of the effect.\r\n * @param {number} zoom - The destination zoom value.\r\n */", "meta": { "filename": "ZOOM_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\events", "code": {} }, "description": "The Camera Zoom Start Event.\r\rThis event is dispatched by a Camera instance when the Zoom Effect starts.\r\rListen for it via either of the following:\r\r```js\rthis.cameras.main.on('camerazoomstart', () => {});\r```\r\ror use the constant, to avoid having to remember the correct event string:\r\r```js\rthis.cameras.main.on(Phaser.Cameras.Scene2D.Events.ZOOM_START, () => {});\r```", "kind": "event", "name": "ZOOM_START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.3.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that the effect began on.", "name": "camera" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Effects.Zoom" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Effects.Zoom" } }, "description": "A reference to the effect instance.", "name": "effect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the effect.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The destination zoom value.", "name": "zoom" } ], "memberof": "Phaser.Cameras.Scene2D.Events", "longname": "Phaser.Cameras.Scene2D.Events#event:ZOOM_START", "scope": "instance", "___id": "T000002R002731", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Cameras.Scene2D\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d", "code": {} }, "kind": "namespace", "name": "Scene2D", "memberof": "Phaser.Cameras", "longname": "Phaser.Cameras.Scene2D", "scope": "static", "___id": "T000002R002733", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Cameras.Scene2D.CameraConfig\r\n * @since 3.0.0\r\n *\r\n * @property {string} [name=''] - The name of the Camera.\r\n * @property {number} [x=0] - The horizontal position of the Camera viewport.\r\n * @property {number} [y=0] - The vertical position of the Camera viewport.\r\n * @property {number} [width] - The width of the Camera viewport.\r\n * @property {number} [height] - The height of the Camera viewport.\r\n * @property {number} [zoom=1] - The default zoom level of the Camera.\r\n * @property {number} [rotation=0] - The rotation of the Camera, in radians.\r\n * @property {boolean} [roundPixels=false] - Should the Camera round pixels before rendering?\r\n * @property {number} [scrollX=0] - The horizontal scroll position of the Camera.\r\n * @property {number} [scrollY=0] - The vertical scroll position of the Camera.\r\n * @property {(false|string)} [backgroundColor=false] - A CSS color string controlling the Camera background color.\r\n * @property {?object} [bounds] - Defines the Camera bounds.\r\n * @property {number} [bounds.x=0] - The top-left extent of the Camera bounds.\r\n * @property {number} [bounds.y=0] - The top-left extent of the Camera bounds.\r\n * @property {number} [bounds.width] - The width of the Camera bounds.\r\n * @property {number} [bounds.height] - The height of the Camera bounds.\r\n */", "meta": { "filename": "CameraConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\typedefs", "code": {} }, "kind": "typedef", "name": "CameraConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "''", "description": "The name of the Camera.", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the Camera viewport.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the Camera viewport.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the Camera viewport.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the Camera viewport.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The default zoom level of the Camera.", "name": "zoom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of the Camera, in radians.", "name": "rotation" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the Camera round pixels before rendering?", "name": "roundPixels" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal scroll position of the Camera.", "name": "scrollX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical scroll position of the Camera.", "name": "scrollY" }, { "type": { "names": [ "false", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "false", "reservedWord": true }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "defaultvalue": false, "description": "A CSS color string controlling the Camera background color.", "name": "backgroundColor" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "optional": true, "nullable": true, "description": "Defines the Camera bounds.", "name": "bounds" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The top-left extent of the Camera bounds.", "name": "bounds.x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The top-left extent of the Camera bounds.", "name": "bounds.y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the Camera bounds.", "name": "bounds.width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002740", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Cameras.Scene2D.CameraFadeCallback\r\n * @since 3.5.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.\r\n * @param {number} progress - The progress of the effect. A value between 0 and 1.\r\n */", "meta": { "filename": "CameraFadeCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\typedefs", "code": {} }, "kind": "typedef", "name": "CameraFadeCallback", "type": { "names": [ "function" ] }, "since": "3.5.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera on which the effect is running.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002741", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Cameras.Scene2D.CameraFlashCallback\r\n * @since 3.5.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.\r\n * @param {number} progress - The progress of the effect. A value between 0 and 1.\r\n */", "meta": { "filename": "CameraFlashCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\typedefs", "code": {} }, "kind": "typedef", "name": "CameraFlashCallback", "type": { "names": [ "function" ] }, "since": "3.5.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera on which the effect is running.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002742", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Cameras.Scene2D.CameraPaddingWrapper\r\n * @extends Phaser.Cameras.Scene2D.Camera\r\n * @since 4.0.0\r\n *\r\n * @property {number} padding - How much padding to apply to each side of the camera. This adjusts the size, position, and scroll of the camera, but the CameraPaddingWrapper proxy abstracts these adjustments so you don't need to consider them.\r\n */", "meta": { "filename": "CameraPaddingWrapper.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\typedefs", "code": {} }, "kind": "typedef", "name": "CameraPaddingWrapper", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Cameras.Scene2D.Camera" ], "since": "4.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How much padding to apply to each side of the camera. This adjusts the size, position, and scroll of the camera, but the CameraPaddingWrapper proxy abstracts these adjustments so you don't need to consider them.", "name": "padding" } ], "memberof": "Phaser.Types.Cameras.Scene2D", "longname": "Phaser.Types.Cameras.Scene2D.CameraPaddingWrapper", "scope": "static", "___id": "T000002R002743", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Cameras.Scene2D.CameraPanCallback\r\n * @since 3.5.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.\r\n * @param {number} progress - The progress of the effect. A value between 0 and 1.\r\n * @param {number} x - The Camera's new scrollX coordinate.\r\n * @param {number} y - The Camera's new scrollY coordinate.\r\n */", "meta": { "filename": "CameraPanCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\typedefs", "code": {} }, "kind": "typedef", "name": "CameraPanCallback", "type": { "names": [ "function" ] }, "since": "3.5.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera on which the effect is running.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The progress of the effect. A value between 0 and 1.", "name": "progress" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Camera's new scrollX coordinate.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Camera's new scrollY coordinate.", "name": "y" } ], "memberof": "Phaser.Types.Cameras.Scene2D", "longname": "Phaser.Types.Cameras.Scene2D.CameraPanCallback", "scope": "static", "___id": "T000002R002744", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Cameras.Scene2D.CameraRotateCallback\r\n * @since 3.23.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.\r\n * @param {number} progress - The progress of the effect. A value between 0 and 1.\r\n * @param {number} rotation - The Camera's new rotation in radians.\r\n */", "meta": { "filename": "CameraRotateCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\typedefs", "code": {} }, "kind": "typedef", "name": "CameraRotateCallback", "type": { "names": [ "function" ] }, "since": "3.23.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera on which the effect is running.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The progress of the effect. A value between 0 and 1.", "name": "progress" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Camera's new rotation in radians.", "name": "rotation" } ], "memberof": "Phaser.Types.Cameras.Scene2D", "longname": "Phaser.Types.Cameras.Scene2D.CameraRotateCallback", "scope": "static", "___id": "T000002R002745", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Cameras.Scene2D.CameraShakeCallback\r\n * @since 3.5.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.\r\n * @param {number} progress - The progress of the effect. A value between 0 and 1.\r\n */", "meta": { "filename": "CameraShakeCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\typedefs", "code": {} }, "kind": "typedef", "name": "CameraShakeCallback", "type": { "names": [ "function" ] }, "since": "3.5.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera on which the effect is running.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002746", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Cameras.Scene2D.CameraZoomCallback\r\n * @since 3.11.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera on which the effect is running.\r\n * @param {number} progress - The progress of the effect. A value between 0 and 1.\r\n * @param {number} zoom - The Camera's new zoom value.\r\n */", "meta": { "filename": "CameraZoomCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\typedefs", "code": {} }, "kind": "typedef", "name": "CameraZoomCallback", "type": { "names": [ "function" ] }, "since": "3.11.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera on which the effect is running.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The progress of the effect. A value between 0 and 1.", "name": "progress" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Camera's new zoom value.", "name": "zoom" } ], "memberof": "Phaser.Types.Cameras.Scene2D", "longname": "Phaser.Types.Cameras.Scene2D.CameraZoomCallback", "scope": "static", "___id": "T000002R002747", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Cameras.Scene2D\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\typedefs", "code": {} }, "kind": "namespace", "name": "Scene2D", "memberof": "Phaser.Types.Cameras", "longname": "Phaser.Types.Cameras.Scene2D", "scope": "static", "___id": "T000002R002748", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Cameras.Scene2D.JSONCamera\r\n * @since 3.0.0\r\n *\r\n * @property {string} name - The name of the camera\r\n * @property {number} x - The horizontal position of camera\r\n * @property {number} y - The vertical position of camera\r\n * @property {number} width - The width size of camera\r\n * @property {number} height - The height size of camera\r\n * @property {number} zoom - The zoom of camera\r\n * @property {number} rotation - The rotation of camera\r\n * @property {boolean} roundPixels - The round pixels indicate the status of the camera\r\n * @property {number} scrollX - The horizontal scroll of camera\r\n * @property {number} scrollY - The vertical scroll of camera\r\n * @property {string} backgroundColor - The background color of camera\r\n * @property {(Phaser.Types.Cameras.Scene2D.JSONCameraBounds|undefined)} [bounds] - The bounds of camera\r\n */", "meta": { "filename": "JSONCamera.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\typedefs", "code": {} }, "kind": "typedef", "name": "JSONCamera", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the camera", "name": "name" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of camera", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of camera", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width size of camera", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height size of camera", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The zoom of camera", "name": "zoom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rotation of camera", "name": "rotation" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The round pixels indicate the status of the camera", "name": "roundPixels" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal scroll of camera", "name": "scrollX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical scroll of camera", "name": "scrollY" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The background color of camera", "name": "backgroundColor" }, { "type": { "names": [ "Phaser.Types.Cameras.Scene2D.JSONCameraBounds", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Cameras.Scene2D.JSONCameraBounds" }, { "type": "UndefinedLiteral" } ] } }, "optional": true, "description": "The bounds of camera", "name": "bounds" } ], "memberof": "Phaser.Types.Cameras.Scene2D", "longname": "Phaser.Types.Cameras.Scene2D.JSONCamera", "scope": "static", "___id": "T000002R002749", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Cameras.Scene2D.JSONCameraBounds\r\n * @since 3.0.0\r\n * \r\n * @property {number} x - The horizontal position of camera\r\n * @property {number} y - The vertical position of camera\r\n * @property {number} width - The width size of camera\r\n * @property {number} height - The height size of camera\r\n */", "meta": { "filename": "JSONCameraBounds.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\2d\\typedefs", "code": {} }, "kind": "typedef", "name": "JSONCameraBounds", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of camera", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of camera", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width size of camera", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height size of camera", "name": "height" } ], "memberof": "Phaser.Types.Cameras.Scene2D", "longname": "Phaser.Types.Cameras.Scene2D.JSONCameraBounds", "scope": "static", "___id": "T000002R002750", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Fixed Key Camera Control.\r\n *\r\n * This allows you to control the movement and zoom of a camera using keyboard keys. Unlike\r\n * the `SmoothedKeyControl`, this control applies movement and zoom changes directly each\r\n * update tick with no easing or smoothing. The camera responds instantly when a key is\r\n * pressed and stops instantly when it is released, making it suitable for grid-based or\r\n * precision camera navigation.\r\n *\r\n * ```javascript\r\n * var camControl = new FixedKeyControl({\r\n * camera: this.cameras.main,\r\n * left: cursors.left,\r\n * right: cursors.right,\r\n * speed: float OR { x: 0, y: 0 }\r\n * });\r\n * ```\r\n *\r\n * Movement is precise and has no 'smoothing' applied to it.\r\n *\r\n * You must call the `update` method of this controller every frame.\r\n *\r\n * @class FixedKeyControl\r\n * @memberof Phaser.Cameras.Controls\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Cameras.Controls.FixedKeyControlConfig} config - The Fixed Key Control configuration object.\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "classdesc": "A Fixed Key Camera Control.\r\rThis allows you to control the movement and zoom of a camera using keyboard keys. Unlike\rthe `SmoothedKeyControl`, this control applies movement and zoom changes directly each\rupdate tick with no easing or smoothing. The camera responds instantly when a key is\rpressed and stops instantly when it is released, making it suitable for grid-based or\rprecision camera navigation.\r\r```javascript\rvar camControl = new FixedKeyControl({\r camera: this.cameras.main,\r left: cursors.left,\r right: cursors.right,\r speed: float OR { x: 0, y: 0 }\r});\r```\r\rMovement is precise and has no 'smoothing' applied to it.\r\rYou 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Cameras.Controls.FixedKeyControlConfig" } }, "description": "The Fixed Key Control configuration object.", "name": "config" } ], "scope": "static", "longname": "Phaser.Cameras.Controls.FixedKeyControl", "___id": "T000002R002753", "___s": true }, { "comment": "/**\r\n * The Camera that this Control will update.\r\n *\r\n * @name Phaser.Cameras.Controls.FixedKeyControl#camera\r\n * @type {?Phaser.Cameras.Scene2D.Camera}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 46, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The Camera that this Control will update.", "name": "camera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#camera", "scope": "instance", "kind": "member", "___id": "T000002R002756", "___s": true }, { "comment": "/**\r\n * The Key to be pressed that will move the Camera left.\r\n *\r\n * @name Phaser.Cameras.Controls.FixedKeyControl#left\r\n * @type {?Phaser.Input.Keyboard.Key}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 56, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The Key to be pressed that will move the Camera left.", "name": "left", "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#left", "scope": "instance", "kind": "member", "___id": "T000002R002758", "___s": true }, { "comment": "/**\r\n * The Key to be pressed that will move the Camera right.\r\n *\r\n * @name Phaser.Cameras.Controls.FixedKeyControl#right\r\n * @type {?Phaser.Input.Keyboard.Key}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The Key to be pressed that will move the Camera right.", "name": "right", "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#right", "scope": "instance", "kind": "member", "___id": "T000002R002760", "___s": true }, { "comment": "/**\r\n * The Key to be pressed that will move the Camera up.\r\n *\r\n * @name Phaser.Cameras.Controls.FixedKeyControl#up\r\n * @type {?Phaser.Input.Keyboard.Key}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The Key to be pressed that will move the Camera up.", "name": "up", "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#up", "scope": "instance", "kind": "member", "___id": "T000002R002762", "___s": true }, { "comment": "/**\r\n * The Key to be pressed that will move the Camera down.\r\n *\r\n * @name Phaser.Cameras.Controls.FixedKeyControl#down\r\n * @type {?Phaser.Input.Keyboard.Key}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The Key to be pressed that will move the Camera down.", "name": "down", "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#down", "scope": "instance", "kind": "member", "___id": "T000002R002764", "___s": true }, { "comment": "/**\r\n * The Key to be pressed that will zoom the Camera in.\r\n *\r\n * @name Phaser.Cameras.Controls.FixedKeyControl#zoomIn\r\n * @type {?Phaser.Input.Keyboard.Key}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The Key to be pressed that will zoom the Camera in.", "name": "zoomIn", "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#zoomIn", "scope": "instance", "kind": "member", "___id": "T000002R002766", "___s": true }, { "comment": "/**\r\n * The Key to be pressed that will zoom the Camera out.\r\n *\r\n * @name Phaser.Cameras.Controls.FixedKeyControl#zoomOut\r\n * @type {?Phaser.Input.Keyboard.Key}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The Key to be pressed that will zoom the Camera out.", "name": "zoomOut", "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#zoomOut", "scope": "instance", "kind": "member", "___id": "T000002R002768", "___s": true }, { "comment": "/**\r\n * The amount by which the camera zoom level is changed on each update tick when the `zoomIn` or `zoomOut` keys are pressed. Unlike the scroll speed, this value is not scaled by delta time.\r\n *\r\n * @name Phaser.Cameras.Controls.FixedKeyControl#zoomSpeed\r\n * @type {number}\r\n * @default 0.01\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The amount by which the camera zoom level is changed on each update tick when the `zoomIn` or `zoomOut` keys are pressed. Unlike the scroll speed, this value is not scaled by delta time.", "name": "zoomSpeed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.01", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#zoomSpeed", "scope": "instance", "kind": "member", "___id": "T000002R002770", "___s": true }, { "comment": "/**\r\n * The smallest zoom value the camera will reach when zoomed out.\r\n *\r\n * @name Phaser.Cameras.Controls.FixedKeyControl#minZoom\r\n * @type {number}\r\n * @default 0.001\r\n * @since 3.53.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The smallest zoom value the camera will reach when zoomed out.", "name": "minZoom", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.001", "since": "3.53.0", "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#minZoom", "scope": "instance", "kind": "member", "___id": "T000002R002772", "___s": true }, { "comment": "/**\r\n * The largest zoom value the camera will reach when zoomed in.\r\n *\r\n * @name Phaser.Cameras.Controls.FixedKeyControl#maxZoom\r\n * @type {number}\r\n * @default 1000\r\n * @since 3.53.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The largest zoom value the camera will reach when zoomed in.", "name": "maxZoom", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1000", "since": "3.53.0", "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#maxZoom", "scope": "instance", "kind": "member", "___id": "T000002R002774", "___s": true }, { "comment": "/**\r\n * The horizontal speed at which the camera will scroll, in pixels per millisecond.\r\n *\r\n * @name Phaser.Cameras.Controls.FixedKeyControl#speedX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 146, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The horizontal speed at which the camera will scroll, in pixels per millisecond.", "name": "speedX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#speedX", "scope": "instance", "kind": "member", "___id": "T000002R002776", "___s": true }, { "comment": "/**\r\n * The vertical speed at which the camera will scroll, in pixels per millisecond.\r\n *\r\n * @name Phaser.Cameras.Controls.FixedKeyControl#speedY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 156, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The vertical speed at which the camera will scroll, in pixels per millisecond.", "name": "speedY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#speedY", "scope": "instance", "kind": "member", "___id": "T000002R002778", "___s": true }, { "comment": "/**\r\n * A flag controlling if the Controls will update the Camera or not.\r\n *\r\n * @name Phaser.Cameras.Controls.FixedKeyControl#active\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 190, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "A flag controlling if the Controls will update the Camera or not.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#active", "scope": "instance", "kind": "member", "___id": "T000002R002787", "___s": true }, { "comment": "/**\r\n * Starts the Key Control running, providing it has been linked to a camera.\r\n *\r\n * @method Phaser.Cameras.Controls.FixedKeyControl#start\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Key Control instance.\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Key Control instance." } ], "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#start", "scope": "instance", "___id": "T000002R002789", "___s": true }, { "comment": "/**\r\n * Stops this Key Control from running. Call `start` to start it again.\r\n *\r\n * @method Phaser.Cameras.Controls.FixedKeyControl#stop\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Key Control instance.\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 215, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "Stops this Key Control from running. Call `start` to start it again.", "kind": "function", "name": "stop", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Key Control instance." } ], "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#stop", "scope": "instance", "___id": "T000002R002792", "___s": true }, { "comment": "/**\r\n * Binds this Key Control to a camera.\r\n *\r\n * @method Phaser.Cameras.Controls.FixedKeyControl#setCamera\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera to bind this Key Control to.\r\n *\r\n * @return {this} This Key Control instance.\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "Binds this Key Control to a camera.", "kind": "function", "name": "setCamera", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera to bind this Key Control to.", "name": "camera" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Key Control instance." } ], "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#setCamera", "scope": "instance", "___id": "T000002R002795", "___s": true }, { "comment": "/**\r\n * Applies the results of pressing the control keys to the Camera.\r\n *\r\n * You must call this every step, it is not called automatically.\r\n *\r\n * @method Phaser.Cameras.Controls.FixedKeyControl#update\r\n * @since 3.0.0\r\n *\r\n * @param {number} delta - The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "Applies the results of pressing the control keys to the Camera.\r\rYou must call this every step, it is not called automatically.", "kind": "function", "name": "update", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002798", "___s": true }, { "comment": "/**\r\n * Destroys this Key Control, nulling its camera and key references to allow for garbage collection.\r\n * This Key Control cannot be used again after being destroyed.\r\n *\r\n * @method Phaser.Cameras.Controls.FixedKeyControl#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FixedKeyControl.js", "lineno": 308, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "Destroys this Key Control, nulling its camera and key references to allow for garbage collection.\rThis Key Control cannot be used again after being destroyed.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.FixedKeyControl", "longname": "Phaser.Cameras.Controls.FixedKeyControl#destroy", "scope": "instance", "___id": "T000002R002810", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Cameras.Controls\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "kind": "namespace", "name": "Controls", "memberof": "Phaser.Cameras", "longname": "Phaser.Cameras.Controls", "scope": "static", "___id": "T000002R002820", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Smoothed Key Camera Control.\r\n *\r\n * This allows you to control the movement and zoom of a camera using the defined keys.\r\n * Unlike the Fixed Camera Control you can also provide physics values for acceleration, drag and maxSpeed for smoothing effects.\r\n *\r\n * ```javascript\r\n * var controlConfig = {\r\n * camera: this.cameras.main,\r\n * left: cursors.left,\r\n * right: cursors.right,\r\n * up: cursors.up,\r\n * down: cursors.down,\r\n * zoomIn: this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.Q),\r\n * zoomOut: this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.E),\r\n * zoomSpeed: 0.02,\r\n * acceleration: 0.06,\r\n * drag: 0.0005,\r\n * maxSpeed: 1.0\r\n * };\r\n * ```\r\n *\r\n * You must call the `update` method of this controller every frame.\r\n *\r\n * @class SmoothedKeyControl\r\n * @memberof Phaser.Cameras.Controls\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Cameras.Controls.SmoothedKeyControlConfig} config - The Smoothed Key Control configuration object.\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "classdesc": "A Smoothed Key Camera Control.\r\rThis allows you to control the movement and zoom of a camera using the defined keys.\rUnlike the Fixed Camera Control you can also provide physics values for acceleration, drag and maxSpeed for smoothing effects.\r\r```javascript\rvar controlConfig = {\r camera: this.cameras.main,\r left: cursors.left,\r right: cursors.right,\r up: cursors.up,\r down: cursors.down,\r zoomIn: this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.Q),\r zoomOut: this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.E),\r zoomSpeed: 0.02,\r acceleration: 0.06,\r drag: 0.0005,\r maxSpeed: 1.0\r};\r```\r\rYou 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Cameras.Controls.SmoothedKeyControlConfig" } }, "description": "The Smoothed Key Control configuration object.", "name": "config" } ], "scope": "static", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl", "___id": "T000002R002826", "___s": true }, { "comment": "/**\r\n * The Camera that this Control will update.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#camera\r\n * @type {?Phaser.Cameras.Scene2D.Camera}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 48, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The Camera that this Control will update.", "name": "camera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#camera", "scope": "instance", "kind": "member", "___id": "T000002R002829", "___s": true }, { "comment": "/**\r\n * The Key to be pressed that will move the Camera left.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#left\r\n * @type {?Phaser.Input.Keyboard.Key}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The Key to be pressed that will move the Camera left.", "name": "left", "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#left", "scope": "instance", "kind": "member", "___id": "T000002R002831", "___s": true }, { "comment": "/**\r\n * The Key to be pressed that will move the Camera right.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#right\r\n * @type {?Phaser.Input.Keyboard.Key}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The Key to be pressed that will move the Camera right.", "name": "right", "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#right", "scope": "instance", "kind": "member", "___id": "T000002R002833", "___s": true }, { "comment": "/**\r\n * The Key to be pressed that will move the Camera up.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#up\r\n * @type {?Phaser.Input.Keyboard.Key}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 78, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The Key to be pressed that will move the Camera up.", "name": "up", "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#up", "scope": "instance", "kind": "member", "___id": "T000002R002835", "___s": true }, { "comment": "/**\r\n * The Key to be pressed that will move the Camera down.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#down\r\n * @type {?Phaser.Input.Keyboard.Key}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The Key to be pressed that will move the Camera down.", "name": "down", "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#down", "scope": "instance", "kind": "member", "___id": "T000002R002837", "___s": true }, { "comment": "/**\r\n * The Key to be pressed that will zoom the Camera in.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#zoomIn\r\n * @type {?Phaser.Input.Keyboard.Key}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The Key to be pressed that will zoom the Camera in.", "name": "zoomIn", "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#zoomIn", "scope": "instance", "kind": "member", "___id": "T000002R002839", "___s": true }, { "comment": "/**\r\n * The Key to be pressed that will zoom the Camera out.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#zoomOut\r\n * @type {?Phaser.Input.Keyboard.Key}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The Key to be pressed that will zoom the Camera out.", "name": "zoomOut", "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#zoomOut", "scope": "instance", "kind": "member", "___id": "T000002R002841", "___s": true }, { "comment": "/**\r\n * The speed at which the camera will zoom if the `zoomIn` or `zoomOut` keys are pressed.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#zoomSpeed\r\n * @type {number}\r\n * @default 0.01\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 118, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The speed at which the camera will zoom if the `zoomIn` or `zoomOut` keys are pressed.", "name": "zoomSpeed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.01", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#zoomSpeed", "scope": "instance", "kind": "member", "___id": "T000002R002843", "___s": true }, { "comment": "/**\r\n * The smallest zoom value the camera will reach when zoomed out.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#minZoom\r\n * @type {number}\r\n * @default 0.001\r\n * @since 3.53.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 128, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The smallest zoom value the camera will reach when zoomed out.", "name": "minZoom", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.001", "since": "3.53.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#minZoom", "scope": "instance", "kind": "member", "___id": "T000002R002845", "___s": true }, { "comment": "/**\r\n * The largest zoom value the camera will reach when zoomed in.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#maxZoom\r\n * @type {number}\r\n * @default 1000\r\n * @since 3.53.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 138, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The largest zoom value the camera will reach when zoomed in.", "name": "maxZoom", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1000", "since": "3.53.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#maxZoom", "scope": "instance", "kind": "member", "___id": "T000002R002847", "___s": true }, { "comment": "/**\r\n * The horizontal acceleration applied to the camera's movement when a directional key is held down.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#accelX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The horizontal acceleration applied to the camera's movement when a directional key is held down.", "name": "accelX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#accelX", "scope": "instance", "kind": "member", "___id": "T000002R002849", "___s": true }, { "comment": "/**\r\n * The vertical acceleration applied to the camera's movement when a directional key is held down.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#accelY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 158, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The vertical acceleration applied to the camera's movement when a directional key is held down.", "name": "accelY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#accelY", "scope": "instance", "kind": "member", "___id": "T000002R002851", "___s": true }, { "comment": "/**\r\n * The horizontal drag applied to the camera when it is moving.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#dragX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 181, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The horizontal drag applied to the camera when it is moving.", "name": "dragX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#dragX", "scope": "instance", "kind": "member", "___id": "T000002R002858", "___s": true }, { "comment": "/**\r\n * The vertical drag applied to the camera when it is moving.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#dragY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 191, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The vertical drag applied to the camera when it is moving.", "name": "dragY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#dragY", "scope": "instance", "kind": "member", "___id": "T000002R002860", "___s": true }, { "comment": "/**\r\n * The maximum horizontal speed the camera can reach.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#maxSpeedX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 214, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The maximum horizontal speed the camera can reach.", "name": "maxSpeedX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#maxSpeedX", "scope": "instance", "kind": "member", "___id": "T000002R002867", "___s": true }, { "comment": "/**\r\n * The maximum vertical speed the camera can reach.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#maxSpeedY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 224, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "The maximum vertical speed the camera can reach.", "name": "maxSpeedY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#maxSpeedY", "scope": "instance", "kind": "member", "___id": "T000002R002869", "___s": true }, { "comment": "/**\r\n * A flag controlling if the Controls will update the Camera or not.\r\n *\r\n * @name Phaser.Cameras.Controls.SmoothedKeyControl#active\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 280, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "A flag controlling if the Controls will update the Camera or not.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#active", "scope": "instance", "kind": "member", "___id": "T000002R002882", "___s": true }, { "comment": "/**\r\n * Starts the Key Control running, providing it has been linked to a camera.\r\n *\r\n * @method Phaser.Cameras.Controls.SmoothedKeyControl#start\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Key Control instance.\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 290, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Key Control instance." } ], "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#start", "scope": "instance", "___id": "T000002R002884", "___s": true }, { "comment": "/**\r\n * Stops this Key Control from running. Call `start` to start it again.\r\n *\r\n * @method Phaser.Cameras.Controls.SmoothedKeyControl#stop\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Key Control instance.\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 305, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "Stops this Key Control from running. Call `start` to start it again.", "kind": "function", "name": "stop", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Key Control instance." } ], "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#stop", "scope": "instance", "___id": "T000002R002887", "___s": true }, { "comment": "/**\r\n * Binds this Key Control to a camera.\r\n *\r\n * @method Phaser.Cameras.Controls.SmoothedKeyControl#setCamera\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera to bind this Key Control to.\r\n *\r\n * @return {this} This Key Control instance.\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 320, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "Binds this Key Control to a camera.", "kind": "function", "name": "setCamera", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera to bind this Key Control to.", "name": "camera" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Key Control instance." } ], "memberof": "Phaser.Cameras.Controls.SmoothedKeyControl", "longname": "Phaser.Cameras.Controls.SmoothedKeyControl#setCamera", "scope": "instance", "___id": "T000002R002890", "___s": true }, { "comment": "/**\r\n * Applies the results of pressing the control keys to the Camera.\r\n *\r\n * You must call this every step, it is not called automatically.\r\n *\r\n * @method Phaser.Cameras.Controls.SmoothedKeyControl#update\r\n * @since 3.0.0\r\n *\r\n * @param {number} delta - The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "description": "Applies the results of pressing the control keys to the Camera.\r\rYou must call this every step, it is not called automatically.", "kind": "function", "name": "update", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002893", "___s": true }, { "comment": "/**\r\n * Destroys this Key Control.\r\n *\r\n * @method Phaser.Cameras.Controls.SmoothedKeyControl#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SmoothedKeyControl.js", "lineno": 480, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls", "code": {} }, "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", "___id": "T000002R002921", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Cameras.Controls.FixedKeyControlConfig\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera that this Control will update.\r\n * @property {Phaser.Input.Keyboard.Key} [left] - The Key to be pressed that will move the Camera left.\r\n * @property {Phaser.Input.Keyboard.Key} [right] - The Key to be pressed that will move the Camera right.\r\n * @property {Phaser.Input.Keyboard.Key} [up] - The Key to be pressed that will move the Camera up.\r\n * @property {Phaser.Input.Keyboard.Key} [down] - The Key to be pressed that will move the Camera down.\r\n * @property {Phaser.Input.Keyboard.Key} [zoomIn] - The Key to be pressed that will zoom the Camera in.\r\n * @property {Phaser.Input.Keyboard.Key} [zoomOut] - The Key to be pressed that will zoom the Camera out.\r\n * @property {number} [zoomSpeed=0.01] - The speed at which the camera will zoom if the `zoomIn` or `zoomOut` keys are pressed.\r\n * @property {(number|{x:number,y:number})} [speed=0] - The horizontal and vertical speed the camera will move.\r\n * @property {number} [minZoom=0.001] - The smallest zoom value the camera will reach when zoomed out.\r\n * @property {number} [maxZoom=1000] - The largest zoom value the camera will reach when zoomed in.\r\n */", "meta": { "filename": "FixedKeyControlConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls\\typedefs", "code": {} }, "kind": "typedef", "name": "FixedKeyControlConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera that this Control will update.", "name": "camera" }, { "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "optional": true, "description": "The Key to be pressed that will zoom the Camera out.", "name": "zoomOut" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "RecordType", "fields": [ { "type": "FieldType", "key": { "type": "NameExpression", "name": "x:number" } }, { "type": "FieldType", "key": { "type": "NameExpression", "name": "y:number" } } ] } ] } }, "optional": true, "defaultvalue": 0, "description": "The horizontal and vertical speed the camera will move.", "name": "speed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.001, "description": "The smallest zoom value the camera will reach when zoomed out.", "name": "minZoom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The largest zoom value the camera will reach when zoomed in.", "name": "maxZoom" } ], "memberof": "Phaser.Types.Cameras.Controls", "longname": "Phaser.Types.Cameras.Controls.FixedKeyControlConfig", "scope": "static", "___id": "T000002R002931", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Cameras.Controls\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls\\typedefs", "code": {} }, "kind": "namespace", "name": "Controls", "memberof": "Phaser.Types.Cameras", "longname": "Phaser.Types.Cameras.Controls", "scope": "static", "___id": "T000002R002932", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Cameras.Controls.SmoothedKeyControlConfig\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera that this Control will update.\r\n * @property {Phaser.Input.Keyboard.Key} [left] - The Key to be pressed that will move the Camera left.\r\n * @property {Phaser.Input.Keyboard.Key} [right] - The Key to be pressed that will move the Camera right.\r\n * @property {Phaser.Input.Keyboard.Key} [up] - The Key to be pressed that will move the Camera up.\r\n * @property {Phaser.Input.Keyboard.Key} [down] - The Key to be pressed that will move the Camera down.\r\n * @property {Phaser.Input.Keyboard.Key} [zoomIn] - The Key to be pressed that will zoom the Camera in.\r\n * @property {Phaser.Input.Keyboard.Key} [zoomOut] - The Key to be pressed that will zoom the Camera out.\r\n * @property {number} [zoomSpeed=0.01] - The speed at which the camera will zoom if the `zoomIn` or `zoomOut` keys are pressed.\r\n * @property {(number|{x:number,y:number})} [acceleration=0] - The horizontal and vertical acceleration the camera will move.\r\n * @property {(number|{x:number,y:number})} [drag=0] - The horizontal and vertical drag applied to the camera when it is moving.\r\n * @property {(number|{x:number,y:number})} [maxSpeed=0] - The maximum horizontal and vertical speed the camera will move.\r\n * @property {number} [minZoom=0.001] - The smallest zoom value the camera will reach when zoomed out.\r\n * @property {number} [maxZoom=1000] - The largest zoom value the camera will reach when zoomed in.\r\n */", "meta": { "filename": "SmoothedKeyControlConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras\\controls\\typedefs", "code": {} }, "kind": "typedef", "name": "SmoothedKeyControlConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera that this Control will update.", "name": "camera" }, { "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "optional": true, "description": "The Key to be pressed that will zoom the Camera out.", "name": "zoomOut" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "RecordType", "fields": [ { "type": "FieldType", "key": { "type": "NameExpression", "name": "x:number" } }, { "type": "FieldType", "key": { "type": "NameExpression", "name": "y:number" } } ] } ] } }, "optional": true, "defaultvalue": 0, "description": "The horizontal and vertical acceleration the camera will move.", "name": "acceleration" }, { "type": { "names": [ "number", "Object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "RecordType", "fields": [ { "type": "FieldType", "key": { "type": "NameExpression", "name": "x:number" } }, { "type": "FieldType", "key": { "type": "NameExpression", "name": "y:number" } } ] } ] } }, "optional": true, "defaultvalue": 0, "description": "The horizontal and vertical drag applied to the camera when it is moving.", "name": "drag" }, { "type": { "names": [ "number", "Object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "RecordType", "fields": [ { "type": "FieldType", "key": { "type": "NameExpression", "name": "x:number" } }, { "type": "FieldType", "key": { "type": "NameExpression", "name": "y:number" } } ] } ] } }, "optional": true, "defaultvalue": 0, "description": "The maximum horizontal and vertical speed the camera will move.", "name": "maxSpeed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.001, "description": "The smallest zoom value the camera will reach when zoomed out.", "name": "minZoom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The largest zoom value the camera will reach when zoomed in.", "name": "maxZoom" } ], "memberof": "Phaser.Types.Cameras.Controls", "longname": "Phaser.Types.Cameras.Controls.SmoothedKeyControlConfig", "scope": "static", "___id": "T000002R002933", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Cameras\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras", "code": {} }, "kind": "namespace", "name": "Cameras", "memberof": "Phaser", "longname": "Phaser.Cameras", "scope": "static", "___id": "T000002R002934", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Cameras\r\n */", "meta": { "filename": "index.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\cameras", "code": {} }, "kind": "namespace", "name": "Cameras", "memberof": "Phaser.Types", "longname": "Phaser.Types.Cameras", "scope": "static", "___id": "T000002R002935", "___s": true }, { "comment": "/**\r\n * Phaser Release Version\r\n *\r\n * @name Phaser.VERSION\r\n * @const\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 15, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "Phaser Release Version", "name": "VERSION", "kind": "constant", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.VERSION", "scope": "static", "___id": "T000002R002940", "___s": true }, { "comment": "/**\r\n * Phaser Release Version as displayed in the console.log header URL.\r\n *\r\n * @name Phaser.LOG_VERSION\r\n * @const\r\n * @type {string}\r\n * @since 3.87.0\r\n */", "meta": { "filename": "const.js", "lineno": 25, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "Phaser Release Version as displayed in the console.log header URL.", "name": "LOG_VERSION", "kind": "constant", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.87.0", "memberof": "Phaser", "longname": "Phaser.LOG_VERSION", "scope": "static", "___id": "T000002R002942", "___s": true }, { "comment": "/**\r\n * This setting will auto-detect if the browser is capable of supporting WebGL.\r\n * If it is, it will use the WebGL Renderer. If not, it will fall back to the Canvas Renderer.\r\n *\r\n * @name Phaser.AUTO\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 39, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "This setting will auto-detect if the browser is capable of supporting WebGL.\rIf it is, it will use the WebGL Renderer. If not, it will fall back to the Canvas Renderer.", "name": "AUTO", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.AUTO", "scope": "static", "___id": "T000002R002946", "___s": true }, { "comment": "/**\r\n * Forces Phaser to only use the Canvas Renderer, regardless if the browser supports\r\n * WebGL or not.\r\n *\r\n * @name Phaser.CANVAS\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 50, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "Forces Phaser to only use the Canvas Renderer, regardless if the browser supports\rWebGL or not.", "name": "CANVAS", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.CANVAS", "scope": "static", "___id": "T000002R002948", "___s": true }, { "comment": "/**\r\n * Forces Phaser to use the WebGL Renderer. If the browser does not support it, there is\r\n * no fallback to Canvas with this setting, so you should trap it and display a suitable\r\n * message to the user.\r\n *\r\n * @name Phaser.WEBGL\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 61, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "Forces Phaser to use the WebGL Renderer. If the browser does not support it, there is\rno fallback to Canvas with this setting, so you should trap it and display a suitable\rmessage to the user.", "name": "WEBGL", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.WEBGL", "scope": "static", "___id": "T000002R002950", "___s": true }, { "comment": "/**\r\n * A Headless Renderer doesn't create either a Canvas or WebGL Renderer. However, it still\r\n * absolutely relies on the DOM being present and available. This mode is meant for unit testing,\r\n * not for running Phaser on the server, which is something you really shouldn't do.\r\n *\r\n * @name Phaser.HEADLESS\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 73, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "A Headless Renderer doesn't create either a Canvas or WebGL Renderer. However, it still\rabsolutely relies on the DOM being present and available. This mode is meant for unit testing,\rnot for running Phaser on the server, which is something you really shouldn't do.", "name": "HEADLESS", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.HEADLESS", "scope": "static", "___id": "T000002R002952", "___s": true }, { "comment": "/**\r\n * In Phaser the value -1 means 'forever' in lots of cases, this const allows you to use it instead\r\n * to help you remember what the value is doing in your code.\r\n *\r\n * @name Phaser.FOREVER\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 85, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "In Phaser the value -1 means 'forever' in lots of cases, this const allows you to use it instead\rto help you remember what the value is doing in your code.", "name": "FOREVER", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.FOREVER", "scope": "static", "___id": "T000002R002954", "___s": true }, { "comment": "/**\r\n * Direction constant representing no direction, or an unset direction. Used in various\r\n * Phaser systems such as physics and input where a direction value is required but none applies.\r\n *\r\n * @name Phaser.NONE\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 96, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "Direction constant representing no direction, or an unset direction. Used in various\rPhaser systems such as physics and input where a direction value is required but none applies.", "name": "NONE", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.NONE", "scope": "static", "___id": "T000002R002956", "___s": true }, { "comment": "/**\r\n * Direction constant representing upward movement or orientation. Used in physics,\r\n * tilemaps, and other Phaser systems that work with cardinal directions.\r\n *\r\n * @name Phaser.UP\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "Direction constant representing upward movement or orientation. Used in physics,\rtilemaps, and other Phaser systems that work with cardinal directions.", "name": "UP", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.UP", "scope": "static", "___id": "T000002R002958", "___s": true }, { "comment": "/**\r\n * Direction constant representing downward movement or orientation. Used in physics,\r\n * tilemaps, and other Phaser systems that work with cardinal directions.\r\n *\r\n * @name Phaser.DOWN\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 118, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "Direction constant representing downward movement or orientation. Used in physics,\rtilemaps, and other Phaser systems that work with cardinal directions.", "name": "DOWN", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.DOWN", "scope": "static", "___id": "T000002R002960", "___s": true }, { "comment": "/**\r\n * Direction constant representing leftward movement or orientation. Used in physics,\r\n * tilemaps, and other Phaser systems that work with cardinal directions.\r\n *\r\n * @name Phaser.LEFT\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "Direction constant representing leftward movement or orientation. Used in physics,\rtilemaps, and other Phaser systems that work with cardinal directions.", "name": "LEFT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.LEFT", "scope": "static", "___id": "T000002R002962", "___s": true }, { "comment": "/**\r\n * Direction constant representing rightward movement or orientation. Used in physics,\r\n * tilemaps, and other Phaser systems that work with cardinal directions.\r\n *\r\n * @name Phaser.RIGHT\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src", "code": {} }, "description": "Direction constant representing rightward movement or orientation. Used in physics,\rtilemaps, and other Phaser systems that work with cardinal directions.", "name": "RIGHT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.RIGHT", "scope": "static", "___id": "T000002R002964", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The active game configuration settings, parsed from a {@link Phaser.Types.Core.GameConfig} object.\r\n * This class takes the raw configuration object passed to `new Phaser.Game()` and resolves all\r\n * values, applying defaults where properties are not specified. The resulting Config instance is\r\n * read-only and available via `game.config`. It controls fundamental aspects of the game including\r\n * canvas dimensions, renderer type, physics settings, audio configuration, and plugin loading.\r\n *\r\n * @class Config\r\n * @memberof Phaser.Core\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Core.GameConfig} [GameConfig] - The configuration object for your Phaser Game instance.\r\n *\r\n * @see Phaser.Game#config\r\n */", "meta": { "filename": "Config.js", "lineno": 18, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "classdesc": "The active game configuration settings, parsed from a {@link Phaser.Types.Core.GameConfig} object.\rThis class takes the raw configuration object passed to `new Phaser.Game()` and resolves all\rvalues, applying defaults where properties are not specified. The resulting Config instance is\rread-only and available via `game.config`. It controls fundamental aspects of the game including\rcanvas dimensions, renderer type, physics settings, audio configuration, and plugin loading.", "kind": "class", "name": "Config", "memberof": "Phaser.Core", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Core.GameConfig" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002977", "___s": true }, { "comment": "/**\r\n * @const {(number|string)} Phaser.Core.Config#width - The width of the underlying canvas, in pixels.\r\n */", "meta": { "filename": "Config.js", "lineno": 55, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "width", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The width of the underlying canvas, in pixels.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#width", "scope": "instance", "___id": "T000002R002984", "___s": true }, { "comment": "/**\r\n * @const {(number|string)} Phaser.Core.Config#height - The height of the underlying canvas, in pixels.\r\n */", "meta": { "filename": "Config.js", "lineno": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "height", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The height of the underlying canvas, in pixels.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#height", "scope": "instance", "___id": "T000002R002986", "___s": true }, { "comment": "/**\r\n * @const {(Phaser.Scale.ZoomType|number)} Phaser.Core.Config#zoom - The zoom factor, as used by the Scale Manager.\r\n */", "meta": { "filename": "Config.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "zoom", "type": { "names": [ "Phaser.Scale.ZoomType", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Scale.ZoomType" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The zoom factor, as used by the Scale Manager.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#zoom", "scope": "instance", "___id": "T000002R002988", "___s": true }, { "comment": "/**\r\n * @const {?*} Phaser.Core.Config#parent - A parent DOM element into which the canvas created by the renderer will be injected.\r\n */", "meta": { "filename": "Config.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "parent", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "nullable": true } }, "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", "___id": "T000002R002990", "___s": true }, { "comment": "/**\r\n * @const {Phaser.Scale.ScaleModeType} Phaser.Core.Config#scaleMode - The scale mode as used by the Scale Manager. The default is zero, which is no scaling.\r\n */", "meta": { "filename": "Config.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "scaleMode", "type": { "names": [ "Phaser.Scale.ScaleModeType" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002992", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#expandParent - Is the Scale Manager allowed to adjust the CSS height property of the parent to be 100%?\r\n */", "meta": { "filename": "Config.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "expandParent", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R002994", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#autoRound - Automatically round the display and style sizes of the canvas. This can help with performance in lower-powered devices.\r\n */", "meta": { "filename": "Config.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "autoRound", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "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", "___id": "T000002R002996", "___s": true }, { "comment": "/**\r\n * @const {Phaser.Scale.CenterType} Phaser.Core.Config#autoCenter - Automatically center the canvas within the parent?\r\n */", "meta": { "filename": "Config.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "autoCenter", "type": { "names": [ "Phaser.Scale.CenterType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.CenterType" } }, "description": "Automatically center the canvas within the parent?", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#autoCenter", "scope": "instance", "___id": "T000002R002998", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#resizeInterval - How many ms should elapse before checking if the browser size has changed?\r\n */", "meta": { "filename": "Config.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "resizeInterval", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R003000", "___s": true }, { "comment": "/**\r\n * @const {?(HTMLElement|string)} Phaser.Core.Config#fullscreenTarget - 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.\r\n */", "meta": { "filename": "Config.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "fullscreenTarget", "type": { "names": [ "HTMLElement", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLElement" }, { "type": "NameExpression", "name": "string" } ], "nullable": 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.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#fullscreenTarget", "scope": "instance", "___id": "T000002R003002", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#minWidth - The minimum width, in pixels, the canvas will scale down to. A value of zero means no minimum.\r\n */", "meta": { "filename": "Config.js", "lineno": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "minWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R003004", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#maxWidth - The maximum width, in pixels, the canvas will scale up to. A value of zero means no maximum.\r\n */", "meta": { "filename": "Config.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "maxWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R003006", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#minHeight - The minimum height, in pixels, the canvas will scale down to. A value of zero means no minimum.\r\n */", "meta": { "filename": "Config.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "minHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R003008", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#maxHeight - The maximum height, in pixels, the canvas will scale up to. A value of zero means no maximum.\r\n */", "meta": { "filename": "Config.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "maxHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R003010", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#snapWidth - The horizontal amount to snap the canvas by when the Scale Manager is resizing. A value of zero means no snapping.\r\n */", "meta": { "filename": "Config.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "snapWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal amount to snap the canvas by when the Scale Manager is resizing. A value of zero means no snapping.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#snapWidth", "scope": "instance", "___id": "T000002R003012", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#snapHeight - The vertical amount to snap the canvas by when the Scale Manager is resizing. A value of zero means no snapping.\r\n */", "meta": { "filename": "Config.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "snapHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical amount to snap the canvas by when the Scale Manager is resizing. A value of zero means no snapping.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#snapHeight", "scope": "instance", "___id": "T000002R003014", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#renderType - Force Phaser to use a specific renderer. Can be `CONST.CANVAS`, `CONST.WEBGL`, `CONST.HEADLESS` or `CONST.AUTO` (default)\r\n */", "meta": { "filename": "Config.js", "lineno": 135, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "renderType", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003016", "___s": true }, { "comment": "/**\r\n * @const {?HTMLCanvasElement} Phaser.Core.Config#canvas - Force Phaser to use your own Canvas element instead of creating one.\r\n */", "meta": { "filename": "Config.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "canvas", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement", "nullable": true } }, "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", "___id": "T000002R003018", "___s": true }, { "comment": "/**\r\n * @const {?(CanvasRenderingContext2D|WebGLRenderingContext)} Phaser.Core.Config#context - Force Phaser to use your own Canvas context instead of creating one.\r\n */", "meta": { "filename": "Config.js", "lineno": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "context", "type": { "names": [ "CanvasRenderingContext2D", "WebGLRenderingContext" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "CanvasRenderingContext2D" }, { "type": "NameExpression", "name": "WebGLRenderingContext" } ], "nullable": true } }, "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", "___id": "T000002R003020", "___s": true }, { "comment": "/**\r\n * @const {?string} Phaser.Core.Config#canvasStyle - Optional CSS attributes to be set on the canvas object created by the renderer.\r\n */", "meta": { "filename": "Config.js", "lineno": 150, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "canvasStyle", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "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", "___id": "T000002R003022", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#customEnvironment - 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`.\r\n */", "meta": { "filename": "Config.js", "lineno": 155, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "customEnvironment", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003024", "___s": true }, { "comment": "/**\r\n * @const {?object} Phaser.Core.Config#sceneConfig - The default Scene configuration object.\r\n */", "meta": { "filename": "Config.js", "lineno": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "sceneConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "nullable": true, "description": "The default Scene configuration object.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#sceneConfig", "scope": "instance", "___id": "T000002R003026", "___s": true }, { "comment": "/**\r\n * @const {string[]} Phaser.Core.Config#seed - A seed which the Random Data Generator will use. If not given, a dynamic seed based on the time is used.\r\n */", "meta": { "filename": "Config.js", "lineno": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "seed", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "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", "___id": "T000002R003028", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#gameTitle - The title of the game.\r\n */", "meta": { "filename": "Config.js", "lineno": 172, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "gameTitle", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The title of the game.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#gameTitle", "scope": "instance", "___id": "T000002R003031", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#gameURL - The URL of the game.\r\n */", "meta": { "filename": "Config.js", "lineno": 177, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "gameURL", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The URL of the game.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#gameURL", "scope": "instance", "___id": "T000002R003033", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#gameVersion - The version of the game.\r\n */", "meta": { "filename": "Config.js", "lineno": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "gameVersion", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The version of the game.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#gameVersion", "scope": "instance", "___id": "T000002R003035", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#autoFocus - If `true` the window will automatically be given focus immediately and on any future mousedown event.\r\n */", "meta": { "filename": "Config.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "autoFocus", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003037", "___s": true }, { "comment": "/**\r\n * @const {(number|boolean)} Phaser.Core.Config#stableSort - `false` or `0` = Use the built-in StableSort (needed for older browsers), `true` or `1` = Rely on ES2019 Array.sort being stable (modern browsers only), or `-1` = Try and determine this automatically based on browser inspection (not guaranteed to work, errs on side of caution).\r\n */", "meta": { "filename": "Config.js", "lineno": 192, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "stableSort", "type": { "names": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "description": "`false` or `0` = Use the built-in StableSort (needed for older browsers), `true` or `1` = Rely on ES2019 Array.sort being stable (modern browsers only), or `-1` = Try and determine this automatically based on browser inspection (not guaranteed to work, errs on side of caution).", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#stableSort", "scope": "instance", "___id": "T000002R003039", "___s": true }, { "comment": "/**\r\n * @const {?boolean} Phaser.Core.Config#domCreateContainer - 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.\r\n */", "meta": { "filename": "Config.js", "lineno": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "domCreateContainer", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "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", "___id": "T000002R003043", "___s": true }, { "comment": "/**\r\n * @const {?string} Phaser.Core.Config#domPointerEvents - The default `pointerEvents` attribute set on the DOM Container.\r\n */", "meta": { "filename": "Config.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "domPointerEvents", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "description": "The default `pointerEvents` attribute set on the DOM Container.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#domPointerEvents", "scope": "instance", "___id": "T000002R003045", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#inputKeyboard - Enable the Keyboard Plugin. This can be disabled in games that don't need keyboard input.\r\n */", "meta": { "filename": "Config.js", "lineno": 218, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputKeyboard", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003047", "___s": true }, { "comment": "/**\r\n * @const {*} Phaser.Core.Config#inputKeyboardEventTarget - The DOM Target to listen for keyboard events on. Defaults to `window` if not specified.\r\n */", "meta": { "filename": "Config.js", "lineno": 223, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputKeyboardEventTarget", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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", "___id": "T000002R003049", "___s": true }, { "comment": "/**\r\n * @const {?number[]} Phaser.Core.Config#inputKeyboardCapture - `preventDefault` will be called on every non-modified key which has a key code in this array. By default, it is empty.\r\n */", "meta": { "filename": "Config.js", "lineno": 228, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputKeyboardCapture", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ], "nullable": 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.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#inputKeyboardCapture", "scope": "instance", "___id": "T000002R003051", "___s": true }, { "comment": "/**\r\n * @const {(boolean|object)} Phaser.Core.Config#inputMouse - Enable the Mouse Plugin. This can be disabled in games that don't need mouse input.\r\n */", "meta": { "filename": "Config.js", "lineno": 233, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputMouse", "type": { "names": [ "boolean", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "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", "___id": "T000002R003053", "___s": true }, { "comment": "/**\r\n * @const {?*} Phaser.Core.Config#inputMouseEventTarget - The DOM Target to listen for mouse events on. Defaults to the game canvas if not specified.\r\n */", "meta": { "filename": "Config.js", "lineno": 238, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputMouseEventTarget", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "nullable": true } }, "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", "___id": "T000002R003055", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#inputMousePreventDefaultDown - Should `mousedown` DOM events have `preventDefault` called on them?\r\n */", "meta": { "filename": "Config.js", "lineno": 243, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputMousePreventDefaultDown", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should `mousedown` DOM events have `preventDefault` called on them?", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#inputMousePreventDefaultDown", "scope": "instance", "___id": "T000002R003057", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#inputMousePreventDefaultUp - Should `mouseup` DOM events have `preventDefault` called on them?\r\n */", "meta": { "filename": "Config.js", "lineno": 248, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputMousePreventDefaultUp", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should `mouseup` DOM events have `preventDefault` called on them?", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#inputMousePreventDefaultUp", "scope": "instance", "___id": "T000002R003059", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#inputMousePreventDefaultMove - Should `mousemove` DOM events have `preventDefault` called on them?\r\n */", "meta": { "filename": "Config.js", "lineno": 253, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputMousePreventDefaultMove", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should `mousemove` DOM events have `preventDefault` called on them?", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#inputMousePreventDefaultMove", "scope": "instance", "___id": "T000002R003061", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#inputMousePreventDefaultWheel - Should `wheel` DOM events have `preventDefault` called on them?\r\n */", "meta": { "filename": "Config.js", "lineno": 258, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputMousePreventDefaultWheel", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should `wheel` DOM events have `preventDefault` called on them?", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#inputMousePreventDefaultWheel", "scope": "instance", "___id": "T000002R003063", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#inputTouch - Enable the Touch Plugin. This can be disabled in games that don't need touch input.\r\n */", "meta": { "filename": "Config.js", "lineno": 263, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputTouch", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003065", "___s": true }, { "comment": "/**\r\n * @const {?*} Phaser.Core.Config#inputTouchEventTarget - The DOM Target to listen for touch events on. Defaults to the game canvas if not specified.\r\n */", "meta": { "filename": "Config.js", "lineno": 268, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputTouchEventTarget", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "nullable": true } }, "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", "___id": "T000002R003067", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#inputTouchCapture - Should touch events be captured? I.e. have prevent default called on them.\r\n */", "meta": { "filename": "Config.js", "lineno": 273, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputTouchCapture", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003069", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#inputActivePointers - The number of Pointer objects created by default. In a mouse-only, or non-multi touch game, you can leave this as 1.\r\n */", "meta": { "filename": "Config.js", "lineno": 278, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputActivePointers", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R003071", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#inputSmoothFactor - The smoothing factor to apply during Pointer movement. See {@link Phaser.Input.Pointer#smoothFactor}.\r\n */", "meta": { "filename": "Config.js", "lineno": 283, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputSmoothFactor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R003073", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#inputWindowEvents - Should Phaser listen for input events on the Window? If you disable this, events like 'POINTER_UP_OUTSIDE' will no longer fire.\r\n */", "meta": { "filename": "Config.js", "lineno": 288, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputWindowEvents", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003075", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#inputGamepad - Enable the Gamepad Plugin. This can be disabled in games that don't need gamepad input.\r\n */", "meta": { "filename": "Config.js", "lineno": 293, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputGamepad", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003077", "___s": true }, { "comment": "/**\r\n * @const {*} Phaser.Core.Config#inputGamepadEventTarget - The DOM Target to listen for gamepad events on. Defaults to `window` if not specified.\r\n */", "meta": { "filename": "Config.js", "lineno": 298, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "inputGamepadEventTarget", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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", "___id": "T000002R003079", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#disableContextMenu - Set to `true` to disable the right-click context menu.\r\n */", "meta": { "filename": "Config.js", "lineno": 303, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "disableContextMenu", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to `true` to disable the right-click context menu.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#disableContextMenu", "scope": "instance", "___id": "T000002R003081", "___s": true }, { "comment": "/**\r\n * @const {Phaser.Types.Core.AudioConfig} Phaser.Core.Config#audio - The Audio Configuration object.\r\n */", "meta": { "filename": "Config.js", "lineno": 308, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "audio", "type": { "names": [ "Phaser.Types.Core.AudioConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.AudioConfig" } }, "description": "The Audio Configuration object.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#audio", "scope": "instance", "___id": "T000002R003083", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#hideBanner - Don't write the banner line to the console.log. See `Phaser.Types.Core.BannerConfig` for details of this object.\r\n */", "meta": { "filename": "Config.js", "lineno": 315, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "hideBanner", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Don't write the banner line to the console.log. See `Phaser.Types.Core.BannerConfig` for details of this object.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#hideBanner", "scope": "instance", "___id": "T000002R003085", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#hidePhaser - Omit Phaser's name and version from the banner.\r\n */", "meta": { "filename": "Config.js", "lineno": 320, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "hidePhaser", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Omit Phaser's name and version from the banner.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#hidePhaser", "scope": "instance", "___id": "T000002R003087", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#bannerTextColor - The color of the banner text.\r\n */", "meta": { "filename": "Config.js", "lineno": 325, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "bannerTextColor", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The color of the banner text.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#bannerTextColor", "scope": "instance", "___id": "T000002R003089", "___s": true }, { "comment": "/**\r\n * @const {string[]} Phaser.Core.Config#bannerBackgroundColor - The background colors of the banner.\r\n */", "meta": { "filename": "Config.js", "lineno": 330, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "bannerBackgroundColor", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "The background colors of the banner.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#bannerBackgroundColor", "scope": "instance", "___id": "T000002R003091", "___s": true }, { "comment": "/**\r\n * @const {Phaser.Types.Core.FPSConfig} Phaser.Core.Config#fps - The Frame Rate Configuration object, as parsed by the Timestep class.\r\n */", "meta": { "filename": "Config.js", "lineno": 340, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "fps", "type": { "names": [ "Phaser.Types.Core.FPSConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.FPSConfig" } }, "description": "The Frame Rate Configuration object, as parsed by the Timestep class.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#fps", "scope": "instance", "___id": "T000002R003094", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#autoMobileTextures - If iOS or Android detected, automatically restrict WebGL to use 1 texture per batch. This can help performance on some devices.\r\n */", "meta": { "filename": "Config.js", "lineno": 349, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "autoMobileTextures", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If iOS or Android detected, automatically restrict WebGL to use 1 texture per batch. This can help performance on some devices.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#autoMobileTextures", "scope": "instance", "___id": "T000002R003097", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#antialias - 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.\r\n */", "meta": { "filename": "Config.js", "lineno": 354, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "antialias", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003099", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#antialiasGL - 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.\r\n */", "meta": { "filename": "Config.js", "lineno": 359, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "antialiasGL", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003101", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#mipmapFilter - Sets the mipmap magFilter to be used when creating WebGL textures. Don't set unless you wish to create mipmaps. Set to one of the following: 'NEAREST', 'LINEAR', 'NEAREST_MIPMAP_NEAREST', 'LINEAR_MIPMAP_NEAREST', 'NEAREST_MIPMAP_LINEAR' or 'LINEAR_MIPMAP_LINEAR'.\r\n */", "meta": { "filename": "Config.js", "lineno": 364, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "mipmapFilter", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Sets the mipmap magFilter to be used when creating WebGL textures. Don't set unless you wish to create mipmaps. Set to one of the following: 'NEAREST', 'LINEAR', 'NEAREST_MIPMAP_NEAREST', 'LINEAR_MIPMAP_NEAREST', 'NEAREST_MIPMAP_LINEAR' or 'LINEAR_MIPMAP_LINEAR'.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#mipmapFilter", "scope": "instance", "___id": "T000002R003103", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#mipmapRegeneration - - Whether to regenerate mipmaps for framebuffers. If this is false, framebuffers will not use mipmaps. If this is true, framebuffers will use the `mipmapFilter` setting, and regenerate mipmaps if redrawn. This affects filters and DynamicTextures. Mipmap generation is expensive (10 microseconds or more per texture), so be careful with this setting.\r\n */", "meta": { "filename": "Config.js", "lineno": 369, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "mipmapRegeneration", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "- Whether to regenerate mipmaps for framebuffers. If this is false, framebuffers will not use mipmaps. If this is true, framebuffers will use the `mipmapFilter` setting, and regenerate mipmaps if redrawn. This affects filters and DynamicTextures. Mipmap generation is expensive (10 microseconds or more per texture), so be careful with this setting.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#mipmapRegeneration", "scope": "instance", "___id": "T000002R003105", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#desynchronized - 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.\r\n */", "meta": { "filename": "Config.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "desynchronized", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003107", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#roundPixels - Draw texture-based Game Objects at only whole-integer positions. Game Objects without textures, like Graphics, ignore this property.\r\n */", "meta": { "filename": "Config.js", "lineno": 379, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "roundPixels", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003109", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#selfShadow - On textured objects with lighting, this enables self-shadowing based on the diffuse map.\r\n */", "meta": { "filename": "Config.js", "lineno": 384, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "selfShadow", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "On textured objects with lighting, this enables self-shadowing based on the diffuse map.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#selfShadow", "scope": "instance", "___id": "T000002R003111", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#pathDetailThreshold - Threshold for combining points into a single path in the WebGL renderer for Graphics objects. This can be overridden at the Graphics object level.\r\n */", "meta": { "filename": "Config.js", "lineno": 389, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "pathDetailThreshold", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Threshold for combining points into a single path in the WebGL renderer for Graphics objects. This can be overridden at the Graphics object level.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#pathDetailThreshold", "scope": "instance", "___id": "T000002R003113", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#pixelArt - Prevent pixel art from becoming blurred when scaled. It will remain crisp (tells the WebGL renderer to automatically create textures using a nearest-neighbor filter mode). When enabled, this also sets `antialias` and `antialiasGL` to `false` and `roundPixels` to `true`.\r\n */", "meta": { "filename": "Config.js", "lineno": 394, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "pixelArt", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Prevent pixel art from becoming blurred when scaled. It will remain crisp (tells the WebGL renderer to automatically create textures using a nearest-neighbor filter mode). When enabled, this also sets `antialias` and `antialiasGL` to `false` and `roundPixels` to `true`.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#pixelArt", "scope": "instance", "___id": "T000002R003115", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#smoothPixelArt - WebGL only. Sets `antialias` to true and `pixelArt` to false. Texture-based Game Objects use special shader setting that preserve blocky pixels, but smooth the edges between the pixels. This is only visible when objects are scaled up; otherwise, `antialias` is simpler.\r\n */", "meta": { "filename": "Config.js", "lineno": 406, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "smoothPixelArt", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "WebGL only. Sets `antialias` to true and `pixelArt` to false. Texture-based Game Objects use special shader setting that preserve blocky pixels, but smooth the edges between the pixels. This is only visible when objects are scaled up; otherwise, `antialias` is simpler.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#smoothPixelArt", "scope": "instance", "___id": "T000002R003120", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#transparent - Whether the game canvas will have a transparent background.\r\n */", "meta": { "filename": "Config.js", "lineno": 418, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "transparent", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the game canvas will have a transparent background.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#transparent", "scope": "instance", "___id": "T000002R003125", "___s": true }, { "comment": "/**\r\n * @const {'keep'|'dither'|number} Phaser.Core.Config#alphaStrategy - The default alpha strategy to use when rendering transparent objects with compatible shaders. Strategies other than `keep` will discard fragments instead of turning them transparent, which creates a very grainy look.\r\n */", "meta": { "filename": "Config.js", "lineno": 423, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "alphaStrategy", "type": { "names": [ "'keep'", "'dither'", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "'keep'" }, { "type": "NameExpression", "name": "'dither'" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The default alpha strategy to use when rendering transparent objects with compatible shaders. Strategies other than `keep` will discard fragments instead of turning them transparent, which creates a very grainy look.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#alphaStrategy", "scope": "instance", "___id": "T000002R003127", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#stencil - Whether to enable stencil testing. Disabling this will prevent creation of stencil buffers, which can save framebuffer memory. Disabling stencil prevents the use of stencil-based rendering.\r\n */", "meta": { "filename": "Config.js", "lineno": 428, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "stencil", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to enable stencil testing. Disabling this will prevent creation of stencil buffers, which can save framebuffer memory. Disabling stencil prevents the use of stencil-based rendering.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#stencil", "scope": "instance", "___id": "T000002R003129", "___s": true }, { "comment": "/**\r\n * @const {'keep'|'dither'|number} Phaser.Core.Config#stencilAlphaStrategy - The default alpha strategy to use when rendering stencils. Keeping transparent pixels still creates opaque stencil, which is usually not what you want.\r\n */", "meta": { "filename": "Config.js", "lineno": 433, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "stencilAlphaStrategy", "type": { "names": [ "'keep'", "'dither'", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "'keep'" }, { "type": "NameExpression", "name": "'dither'" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The default alpha strategy to use when rendering stencils. Keeping transparent pixels still creates opaque stencil, which is usually not what you want.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#stencilAlphaStrategy", "scope": "instance", "___id": "T000002R003131", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#clearBeforeRender - 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.\r\n */", "meta": { "filename": "Config.js", "lineno": 438, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "clearBeforeRender", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003133", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#preserveDrawingBuffer - If the value is true the WebGL buffers will not be cleared and will preserve their values until cleared or overwritten by the author.\r\n */", "meta": { "filename": "Config.js", "lineno": 443, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "preserveDrawingBuffer", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If the value is true the WebGL buffers will not be cleared and will preserve their values until cleared or overwritten by the author.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#preserveDrawingBuffer", "scope": "instance", "___id": "T000002R003135", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#premultipliedAlpha - In WebGL mode, sets the drawing buffer to contain colors with pre-multiplied alpha.\r\n */", "meta": { "filename": "Config.js", "lineno": 448, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "premultipliedAlpha", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003137", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#skipUnreadyShaders - Avert stuttering during shader compilation, by enabling parallel shader compilation, where supported. Objects which request a shader that is not yet ready will not be drawn. This prevents stutter, but may cause \"pop-in\" of objects unless you use a pre-touch strategy.\r\n */", "meta": { "filename": "Config.js", "lineno": 453, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "skipUnreadyShaders", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Avert stuttering during shader compilation, by enabling parallel shader compilation, where supported. Objects which request a shader that is not yet ready will not be drawn. This prevents stutter, but may cause \"pop-in\" of objects unless you use a pre-touch strategy.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#skipUnreadyShaders", "scope": "instance", "___id": "T000002R003139", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#failIfMajorPerformanceCaveat - Let the browser abort creating a WebGL context if it judges performance would be unacceptable.\r\n */", "meta": { "filename": "Config.js", "lineno": 458, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "failIfMajorPerformanceCaveat", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003141", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#powerPreference - \"high-performance\", \"low-power\" or \"default\". A hint to the browser on how much device power the game might use.\r\n */", "meta": { "filename": "Config.js", "lineno": 463, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "powerPreference", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003143", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#batchSize - The default WebGL Batch size. Represents the number of _quads_ that can be added to a single batch.\r\n */", "meta": { "filename": "Config.js", "lineno": 468, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "batchSize", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The default WebGL Batch size. Represents the number of _quads_ that can be added to a single batch.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#batchSize", "scope": "instance", "___id": "T000002R003145", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#maxTextures - When in WebGL mode, this sets the maximum number of GPU Textures to use. The default, -1, will use all available units. The WebGL1 spec says all browsers should provide a minimum of 8.\r\n */", "meta": { "filename": "Config.js", "lineno": 473, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "maxTextures", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "When in WebGL mode, this sets the maximum number of GPU Textures to use. The default, -1, will use all available units. The WebGL1 spec says all browsers should provide a minimum of 8.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#maxTextures", "scope": "instance", "___id": "T000002R003147", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#maxLights - The maximum number of lights allowed to be visible within range of a single Camera in the LightManager.\r\n */", "meta": { "filename": "Config.js", "lineno": 478, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "maxLights", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R003149", "___s": true }, { "comment": "/**\r\n * @const {Object} Phaser.Core.Config#renderNodes - A map of custom Render Nodes to be added to the WebGL Renderer. The values will be added to the RenderNodeManager, using the keys as the names.\r\n */", "meta": { "filename": "Config.js", "lineno": 483, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "renderNodes", "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "Phaser.Types.Core.RenderNodesConfig" } ] } }, "description": "A map of custom Render Nodes to be added to the WebGL Renderer. The values will be added to the RenderNodeManager, using the keys as the names.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#renderNodes", "scope": "instance", "___id": "T000002R003151", "___s": true }, { "comment": "/**\r\n * @const {Phaser.Display.Color} Phaser.Core.Config#backgroundColor - The background color of the game canvas. The default is black. This value is ignored if `transparent` is set to `true`.\r\n */", "meta": { "filename": "Config.js", "lineno": 490, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "backgroundColor", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003154", "___s": true }, { "comment": "/**\r\n * @const {Phaser.Types.Core.BootCallback} Phaser.Core.Config#preBoot - Called before Phaser boots. Useful for initializing anything not related to Phaser that Phaser may require while booting.\r\n */", "meta": { "filename": "Config.js", "lineno": 501, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "preBoot", "type": { "names": [ "Phaser.Types.Core.BootCallback" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003158", "___s": true }, { "comment": "/**\r\n * @const {Phaser.Types.Core.BootCallback} Phaser.Core.Config#postBoot - 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.\r\n */", "meta": { "filename": "Config.js", "lineno": 506, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "postBoot", "type": { "names": [ "Phaser.Types.Core.BootCallback" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003160", "___s": true }, { "comment": "/**\r\n * @const {Phaser.Types.Core.PhysicsConfig} Phaser.Core.Config#physics - The Physics Configuration object.\r\n */", "meta": { "filename": "Config.js", "lineno": 511, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "physics", "type": { "names": [ "Phaser.Types.Core.PhysicsConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.PhysicsConfig" } }, "description": "The Physics Configuration object.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#physics", "scope": "instance", "___id": "T000002R003162", "___s": true }, { "comment": "/**\r\n * @const {(boolean|string)} Phaser.Core.Config#defaultPhysicsSystem - The default physics system. It will be started for each scene. Either 'arcade' or 'matter'.\r\n */", "meta": { "filename": "Config.js", "lineno": 516, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "defaultPhysicsSystem", "type": { "names": [ "boolean", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The default physics system. It will be started for each scene. Either 'arcade' or 'matter'.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#defaultPhysicsSystem", "scope": "instance", "___id": "T000002R003164", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#loaderBaseURL - A URL used to resolve paths given to the loader. Example: 'http://labs.phaser.io/assets/'.\r\n */", "meta": { "filename": "Config.js", "lineno": 521, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "loaderBaseURL", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003166", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#loaderPath - A URL path used to resolve relative paths given to the loader. Example: 'images/sprites/'.\r\n */", "meta": { "filename": "Config.js", "lineno": 526, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "loaderPath", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003168", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#loaderMaxParallelDownloads - The maximum number of files the Loader will attempt to download in parallel. Defaults to 32, or 6 on Android where parallel connections are more constrained.\r\n */", "meta": { "filename": "Config.js", "lineno": 531, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "loaderMaxParallelDownloads", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum number of files the Loader will attempt to download in parallel. Defaults to 32, or 6 on Android where parallel connections are more constrained.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#loaderMaxParallelDownloads", "scope": "instance", "___id": "T000002R003170", "___s": true }, { "comment": "/**\r\n * @const {(string|undefined)} Phaser.Core.Config#loaderCrossOrigin - '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}.\r\n */", "meta": { "filename": "Config.js", "lineno": 536, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "loaderCrossOrigin", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "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", "___id": "T000002R003172", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#loaderResponseType - The response type of the XHR request, e.g. `blob`, `text`, etc.\r\n */", "meta": { "filename": "Config.js", "lineno": 541, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "loaderResponseType", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003174", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#loaderAsync - Should the XHR request use async or not?\r\n */", "meta": { "filename": "Config.js", "lineno": 546, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "loaderAsync", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should the XHR request use async or not?", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#loaderAsync", "scope": "instance", "___id": "T000002R003176", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#loaderUser - Optional username for all XHR requests.\r\n */", "meta": { "filename": "Config.js", "lineno": 551, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "loaderUser", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Optional username for all XHR requests.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#loaderUser", "scope": "instance", "___id": "T000002R003178", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#loaderPassword - Optional password for all XHR requests.\r\n */", "meta": { "filename": "Config.js", "lineno": 556, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "loaderPassword", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Optional password for all XHR requests.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#loaderPassword", "scope": "instance", "___id": "T000002R003180", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#loaderTimeout - Optional XHR timeout value, in ms.\r\n */", "meta": { "filename": "Config.js", "lineno": 561, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "loaderTimeout", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Optional XHR timeout value, in ms.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#loaderTimeout", "scope": "instance", "___id": "T000002R003182", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#loaderMaxRetries - The number of times to retry a file load if it fails.\r\n */", "meta": { "filename": "Config.js", "lineno": 566, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "loaderMaxRetries", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of times to retry a file load if it fails.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#loaderMaxRetries", "scope": "instance", "___id": "T000002R003184", "___s": true }, { "comment": "/**\r\n * @const {boolean} Phaser.Core.Config#loaderWithCredentials - Optional XHR withCredentials value.\r\n */", "meta": { "filename": "Config.js", "lineno": 571, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "loaderWithCredentials", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Optional XHR withCredentials value.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#loaderWithCredentials", "scope": "instance", "___id": "T000002R003186", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#loaderImageLoadType - Optional load type for image, `XHR` is default, or `HTMLImageElement` for a lightweight way.\r\n */", "meta": { "filename": "Config.js", "lineno": 576, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "loaderImageLoadType", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Optional load type for image, `XHR` is default, or `HTMLImageElement` for a lightweight way.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#loaderImageLoadType", "scope": "instance", "___id": "T000002R003188", "___s": true }, { "comment": "/**\r\n * @const {string[]} Phaser.Core.Config#loaderLocalScheme - An array of schemes that the Loader considers as being 'local' files. Defaults to: `[ 'file://', 'capacitor://' ]`.\r\n */", "meta": { "filename": "Config.js", "lineno": 584, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "loaderLocalScheme", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "An array of schemes that the Loader considers as being 'local' files. Defaults to: `[ 'file://', 'capacitor://' ]`.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#loaderLocalScheme", "scope": "instance", "___id": "T000002R003190", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#glowQuality - The quality of the Glow filter (defaults to 10)\r\n */", "meta": { "filename": "Config.js", "lineno": 589, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "glowQuality", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The quality of the Glow filter (defaults to 10)", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#glowQuality", "scope": "instance", "___id": "T000002R003192", "___s": true }, { "comment": "/**\r\n * @const {number} Phaser.Core.Config#glowDistance - The distance of the Glow filter (defaults to 10)\r\n */", "meta": { "filename": "Config.js", "lineno": 594, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "glowDistance", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance of the Glow filter (defaults to 10)", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#glowDistance", "scope": "instance", "___id": "T000002R003194", "___s": true }, { "comment": "/**\r\n * @const {any} Phaser.Core.Config#installGlobalPlugins - An array of global plugins to be installed.\r\n */", "meta": { "filename": "Config.js", "lineno": 617, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "installGlobalPlugins", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "An array of global plugins to be installed.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#installGlobalPlugins", "scope": "instance", "___id": "T000002R003196", "___s": true }, { "comment": "/**\r\n * @const {any} Phaser.Core.Config#installScenePlugins - An array of Scene level plugins to be installed.\r\n */", "meta": { "filename": "Config.js", "lineno": 622, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "installScenePlugins", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "An array of Scene level plugins to be installed.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#installScenePlugins", "scope": "instance", "___id": "T000002R003198", "___s": true }, { "comment": "/**\r\n * @const {any} Phaser.Core.Config#defaultPlugins - The plugins installed into every Scene (in addition to CoreScene and Global).\r\n */", "meta": { "filename": "Config.js", "lineno": 653, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "defaultPlugins", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003207", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#defaultImage - A base64 encoded PNG that will be used as the default blank texture.\r\n */", "meta": { "filename": "Config.js", "lineno": 661, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "defaultImage", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003210", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#missingImage - A base64 encoded PNG that will be used as the default texture when a texture is assigned that is missing or not loaded.\r\n */", "meta": { "filename": "Config.js", "lineno": 666, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "missingImage", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003212", "___s": true }, { "comment": "/**\r\n * @const {string} Phaser.Core.Config#whiteImage - A base64 encoded PNG used as the default solid white texture. This small 4x4 white image is used internally by Phaser for colored Game Objects and tinting.\r\n */", "meta": { "filename": "Config.js", "lineno": 671, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "constant", "name": "whiteImage", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A base64 encoded PNG used as the default solid white texture. This small 4x4 white image is used internally by Phaser for colored Game Objects and tinting.", "memberof": "Phaser.Core.Config", "longname": "Phaser.Core.Config#whiteImage", "scope": "instance", "___id": "T000002R003214", "___s": true }, { "comment": "/**\r\n * Called automatically by Phaser.Game and responsible for creating the renderer it will use.\r\n *\r\n * Inspects the game configuration to determine the appropriate render type (WebGL, Canvas, or Headless),\r\n * validates that the chosen renderer is supported by the current device, sets up the canvas element\r\n * (either adopting one provided in the game config or creating a new one from the CanvasPool), applies\r\n * any canvas CSS styles and pixel art interpolation settings, then instantiates and assigns the renderer\r\n * to `game.renderer`.\r\n *\r\n * Relies upon two webpack global flags, `WEBGL_RENDERER` and `CANVAS_RENDERER`, which are defined at\r\n * build time and inlined into the bundle as compile-time constants. They are not available as runtime\r\n * variables and determine which renderer classes are included in the build.\r\n *\r\n * @function Phaser.Core.CreateRenderer\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - The Phaser.Game instance on which the renderer will be set.\r\n */", "meta": { "filename": "CreateRenderer.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Called automatically by Phaser.Game and responsible for creating the renderer it will use.\r\rInspects the game configuration to determine the appropriate render type (WebGL, Canvas, or Headless),\rvalidates that the chosen renderer is supported by the current device, sets up the canvas element\r(either adopting one provided in the game config or creating a new one from the CanvasPool), applies\rany canvas CSS styles and pixel art interpolation settings, then instantiates and assigns the renderer\rto `game.renderer`.\r\rRelies upon two webpack global flags, `WEBGL_RENDERER` and `CANVAS_RENDERER`, which are defined at\rbuild time and inlined into the bundle as compile-time constants. They are not available as runtime\rvariables and determine which renderer classes are included in the build.", "kind": "function", "name": "CreateRenderer", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003223", "___s": true }, { "comment": "/**\r\n * Called automatically by Phaser.Game during initialization to output a styled banner to the browser\r\n * console. The banner displays the Phaser version number, the active renderer (WebGL, Canvas, or\r\n * Headless), the audio system in use (Web Audio, HTML5 Audio, or No Audio), and optionally the\r\n * game title, version, and URL as configured. In browsers that support CSS console styling the\r\n * banner is rendered with the colors defined in the Game Config; in IE it falls back to a plain\r\n * text log. The banner is skipped entirely when `config.hideBanner` is `true`.\r\n *\r\n * You can customize or disable the header via the Game Config object.\r\n *\r\n * @function Phaser.Core.DebugHeader\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - The Phaser.Game instance which will output this debug header.\r\n */", "meta": { "filename": "DebugHeader.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Called automatically by Phaser.Game during initialization to output a styled banner to the browser\rconsole. The banner displays the Phaser version number, the active renderer (WebGL, Canvas, or\rHeadless), the audio system in use (Web Audio, HTML5 Audio, or No Audio), and optionally the\rgame title, version, and URL as configured. In browsers that support CSS console styling the\rbanner is rendered with the colors defined in the Game Config; in IE it falls back to a plain\rtext log. The banner is skipped entirely when `config.hideBanner` is `true`.\r\rYou can customize or disable the header via the Game Config object.", "kind": "function", "name": "DebugHeader", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "The Phaser.Game instance which will output this debug header.", "name": "game" } ], "memberof": "Phaser.Core", "longname": "Phaser.Core.DebugHeader", "scope": "static", "___id": "T000002R003251", "___s": true }, { "comment": "/**\r\n * The Game Blur Event.\r\n *\r\n * This event is dispatched by the Game Visibility Handler when the window in which the Game instance is embedded\r\n * enters a blurred state. The blur event is raised when the window loses focus. This can happen if a user swaps\r\n * tab, or if they simply remove focus from the browser to another app.\r\n *\r\n * @event Phaser.Core.Events#BLUR\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BLUR_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Blur Event.\r\rThis event is dispatched by the Game Visibility Handler when the window in which the Game instance is embedded\renters a blurred state. The blur event is raised when the window loses focus. This can happen if a user swaps\rtab, or if they simply remove focus from the browser to another app.", "kind": "event", "name": "BLUR", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Core.Events", "longname": "Phaser.Core.Events#event:BLUR", "scope": "instance", "___id": "T000002R003281", "___s": true }, { "comment": "/**\r\n * The Game Boot Event.\r\n *\r\n * This event is dispatched when the Phaser Game instance has finished booting, but before it is ready to start running.\r\n * The global systems use this event to know when to set themselves up, dispatching their own `ready` events as required.\r\n *\r\n * @event Phaser.Core.Events#BOOT\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BOOT_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Boot Event.\r\rThis event is dispatched when the Phaser Game instance has finished booting, but before it is ready to start running.\rThe global systems use this event to know when to set themselves up, dispatching their own `ready` events as required.", "kind": "event", "name": "BOOT", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Core.Events", "longname": "Phaser.Core.Events#event:BOOT", "scope": "instance", "___id": "T000002R003283", "___s": true }, { "comment": "/**\r\n * The Game Context Lost Event.\r\n *\r\n * This event is dispatched by the Game if the WebGL Renderer it is using encounters a WebGL Context Lost event from the browser.\r\n *\r\n * The renderer halts all rendering and cannot resume after this happens.\r\n *\r\n * @event Phaser.Core.Events#CONTEXT_LOST\r\n * @type {string}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "CONTEXT_LOST_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Context Lost Event.\r\rThis event is dispatched by the Game if the WebGL Renderer it is using encounters a WebGL Context Lost event from the browser.\r\rThe renderer halts all rendering and cannot resume after this happens.", "kind": "event", "name": "CONTEXT_LOST", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.19.0", "memberof": "Phaser.Core.Events", "longname": "Phaser.Core.Events#event:CONTEXT_LOST", "scope": "instance", "___id": "T000002R003285", "___s": true }, { "comment": "/**\r\n * The Game Destroy Event.\r\n *\r\n * This event is dispatched when the game instance has been told to destroy itself.\r\n * Lots of internal systems listen to this event in order to clear themselves out.\r\n * Custom plugins and game code should also do the same.\r\n *\r\n * @event Phaser.Core.Events#DESTROY\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DESTROY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Destroy Event.\r\rThis event is dispatched when the game instance has been told to destroy itself.\rLots of internal systems listen to this event in order to clear themselves out.\rCustom plugins and game code should also do the same.", "kind": "event", "name": "DESTROY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Core.Events", "longname": "Phaser.Core.Events#event:DESTROY", "scope": "instance", "___id": "T000002R003287", "___s": true }, { "comment": "/**\r\n * The Game Focus Event.\r\n *\r\n * This event is dispatched by the Game Visibility Handler when the window in which the Game instance is embedded\r\n * enters a focused state. The focus event is raised when the window re-gains focus, having previously lost it.\r\n *\r\n * @event Phaser.Core.Events#FOCUS\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "FOCUS_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Focus Event.\r\rThis event is dispatched by the Game Visibility Handler when the window in which the Game instance is embedded\renters a focused state. The focus event is raised when the window re-gains focus, having previously lost it.", "kind": "event", "name": "FOCUS", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Core.Events", "longname": "Phaser.Core.Events#event:FOCUS", "scope": "instance", "___id": "T000002R003289", "___s": true }, { "comment": "/**\r\n * The Game Hidden Event.\r\n *\r\n * This event is dispatched by the Game Visibility Handler when the document in which the Game instance is embedded\r\n * enters a hidden state. Only browsers that support the Visibility API will cause this event to be emitted.\r\n *\r\n * In most modern browsers, when the document enters a hidden state, the Request Animation Frame and setTimeout, which\r\n * control the main game loop, will automatically pause. There is no way to stop this from happening. It is something\r\n * your game should account for in its own code, should the pause be an issue (i.e. for multiplayer games)\r\n *\r\n * @event Phaser.Core.Events#HIDDEN\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "HIDDEN_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Hidden Event.\r\rThis event is dispatched by the Game Visibility Handler when the document in which the Game instance is embedded\renters a hidden state. Only browsers that support the Visibility API will cause this event to be emitted.\r\rIn most modern browsers, when the document enters a hidden state, the Request Animation Frame and setTimeout, which\rcontrol the main game loop, will automatically pause. There is no way to stop this from happening. It is something\ryour game should account for in its own code, should the pause be an issue (i.e. for multiplayer games)", "kind": "event", "name": "HIDDEN", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Core.Events", "longname": "Phaser.Core.Events#event:HIDDEN", "scope": "instance", "___id": "T000002R003291", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Core.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Core", "longname": "Phaser.Core.Events", "scope": "static", "___id": "T000002R003293", "___s": true }, { "comment": "/**\r\n * The Game Pause Event.\r\n *\r\n * This event is dispatched when the Game loop enters a paused state, usually as a result of the Visibility Handler.\r\n *\r\n * @event Phaser.Core.Events#PAUSE\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PAUSE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Pause Event.\r\rThis event is dispatched when the Game loop enters a paused state, usually as a result of the Visibility Handler.", "kind": "event", "name": "PAUSE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Core.Events", "longname": "Phaser.Core.Events#event:PAUSE", "scope": "instance", "___id": "T000002R003311", "___s": true }, { "comment": "/**\r\n * The Game Post-Render Event.\r\n *\r\n * This event is dispatched right at the end of the render process.\r\n *\r\n * Every Scene will have rendered and been drawn to the canvas by the time this event is fired.\r\n * Use it for any last minute post-processing before the next game step begins.\r\n *\r\n * @event Phaser.Core.Events#POST_RENDER\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - A reference to the current renderer being used by the Game instance.\r\n */", "meta": { "filename": "POST_RENDER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Post-Render Event.\r\rThis event is dispatched right at the end of the render process.\r\rEvery Scene will have rendered and been drawn to the canvas by the time this event is fired.\rUse it for any last minute post-processing before the next game step begins.", "kind": "event", "name": "POST_RENDER", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Renderer.Canvas.CanvasRenderer", "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.Canvas.CanvasRenderer" }, { "type": "NameExpression", "name": "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", "___id": "T000002R003313", "___s": true }, { "comment": "/**\r\n * The Game Post-Step Event.\r\n *\r\n * This event is dispatched after the Scene Manager has updated.\r\n * Hook into it from plugins or systems that need to do things before the render starts.\r\n *\r\n * @event Phaser.Core.Events#POST_STEP\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.\r\n * @param {number} delta - The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.\r\n */", "meta": { "filename": "POST_STEP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Post-Step Event.\r\rThis event is dispatched after the Scene Manager has updated.\rHook into it from plugins or systems that need to do things before the render starts.", "kind": "event", "name": "POST_STEP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003315", "___s": true }, { "comment": "/**\r\n * The Game Pre-Render Event.\r\n *\r\n * This event is dispatched immediately before any of the Scenes have started to render.\r\n *\r\n * The 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.\r\n *\r\n * @event Phaser.Core.Events#PRE_RENDER\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - A reference to the current renderer being used by the Game instance.\r\n */", "meta": { "filename": "PRE_RENDER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Pre-Render Event.\r\rThis event is dispatched immediately before any of the Scenes have started to render.\r\rThe 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Renderer.Canvas.CanvasRenderer", "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.Canvas.CanvasRenderer" }, { "type": "NameExpression", "name": "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", "___id": "T000002R003317", "___s": true }, { "comment": "/**\r\n * The Game Pre-Step Event.\r\n *\r\n * This event is dispatched before the main Game Step starts. By this point in the game cycle none of the Scene updates have yet happened.\r\n * Hook into it from plugins or systems that need to update before the Scene Manager does.\r\n *\r\n * @event Phaser.Core.Events#PRE_STEP\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.\r\n * @param {number} delta - The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.\r\n */", "meta": { "filename": "PRE_STEP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Pre-Step Event.\r\rThis event is dispatched before the main Game Step starts. By this point in the game cycle none of the Scene updates have yet happened.\rHook into it from plugins or systems that need to update before the Scene Manager does.", "kind": "event", "name": "PRE_STEP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003319", "___s": true }, { "comment": "/**\r\n * The Game Ready Event.\r\n *\r\n * This event is dispatched when the Phaser Game instance has finished booting, the Texture Manager is fully ready,\r\n * and all local systems are now able to start.\r\n *\r\n * @event Phaser.Core.Events#READY\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "READY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Ready Event.\r\rThis event is dispatched when the Phaser Game instance has finished booting, the Texture Manager is fully ready,\rand all local systems are now able to start.", "kind": "event", "name": "READY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Core.Events", "longname": "Phaser.Core.Events#event:READY", "scope": "instance", "___id": "T000002R003321", "___s": true }, { "comment": "/**\r\n * The Game Resume Event.\r\n *\r\n * This event is dispatched when the game loop leaves a paused state and resumes running.\r\n *\r\n * @event Phaser.Core.Events#RESUME\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {number} pauseDuration - The duration, in ms, that the game was paused for, or 0 if {@link Phaser.Game#resume} was called.\r\n */", "meta": { "filename": "RESUME_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Resume Event.\r\rThis event is dispatched when the game loop leaves a paused state and resumes running.", "kind": "event", "name": "RESUME", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration, in ms, that the game was paused for, or 0 if {@link Phaser.Game#resume} was called.", "name": "pauseDuration" } ], "memberof": "Phaser.Core.Events", "longname": "Phaser.Core.Events#event:RESUME", "scope": "instance", "___id": "T000002R003323", "___s": true }, { "comment": "/**\r\n * The Game Step Event.\r\n *\r\n * This event is dispatched after the Game Pre-Step and before the Scene Manager steps.\r\n * Hook into it from plugins or systems that need to update before the Scene Manager does, but after the core Systems have.\r\n *\r\n * @event Phaser.Core.Events#STEP\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.\r\n * @param {number} delta - The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.\r\n */", "meta": { "filename": "STEP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Step Event.\r\rThis event is dispatched after the Game Pre-Step and before the Scene Manager steps.\rHook 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003325", "___s": true }, { "comment": "/**\r\n * This event is dispatched when the Scene Manager has created the System Scene,\r\n * which other plugins and systems may use to initialize themselves.\r\n *\r\n * This event is dispatched just once by the Game instance.\r\n *\r\n * @event Phaser.Core.Events#SYSTEM_READY\r\n * @type {string}\r\n * @since 3.70.0\r\n *\r\n * @param {Phaser.Scenes.Systems} sys - A reference to the Scene Systems class of the Scene that emitted this event.\r\n */", "meta": { "filename": "SYSTEM_READY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "This event is dispatched when the Scene Manager has created the System Scene,\rwhich other plugins and systems may use to initialize themselves.\r\rThis event is dispatched just once by the Game instance.", "kind": "event", "name": "SYSTEM_READY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.70.0", "params": [ { "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "description": "A reference to the Scene Systems class of the Scene that emitted this event.", "name": "sys" } ], "memberof": "Phaser.Core.Events", "longname": "Phaser.Core.Events#event:SYSTEM_READY", "scope": "instance", "___id": "T000002R003327", "___s": true }, { "comment": "/**\r\n * The Game Visible Event.\r\n *\r\n * This event is dispatched by the Game Visibility Handler when the document in which the Game instance is embedded\r\n * enters a visible state, previously having been hidden.\r\n *\r\n * Only browsers that support the Visibility API will cause this event to be emitted.\r\n *\r\n * @event Phaser.Core.Events#VISIBLE\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "VISIBLE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\events", "code": {} }, "description": "The Game Visible Event.\r\rThis event is dispatched by the Game Visibility Handler when the document in which the Game instance is embedded\renters a visible state, previously having been hidden.\r\rOnly browsers that support the Visibility API will cause this event to be emitted.", "kind": "event", "name": "VISIBLE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Core.Events", "longname": "Phaser.Core.Events#event:VISIBLE", "scope": "instance", "___id": "T000002R003329", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Phaser.Game instance is the main controller for the entire Phaser game. It is responsible\r\n * for handling the boot process, parsing the configuration values, creating the renderer,\r\n * and setting-up all of the global Phaser systems, such as sound and input.\r\n * Once that is complete it will start the Scene Manager and then begin the main game loop.\r\n *\r\n * You should generally avoid accessing any of the systems created by Game, and instead use those\r\n * made available to you via the Phaser.Scene Systems class instead.\r\n *\r\n * @class Game\r\n * @memberof Phaser\r\n * @constructor\r\n * @fires Phaser.Core.Events#BLUR\r\n * @fires Phaser.Core.Events#FOCUS\r\n * @fires Phaser.Core.Events#HIDDEN\r\n * @fires Phaser.Core.Events#VISIBLE\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Core.GameConfig} [config] - The configuration object for your Phaser Game instance.\r\n */", "meta": { "filename": "Game.js", "lineno": 36, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "classdesc": "The Phaser.Game instance is the main controller for the entire Phaser game. It is responsible\rfor handling the boot process, parsing the configuration values, creating the renderer,\rand setting-up all of the global Phaser systems, such as sound and input.\rOnce that is complete it will start the Scene Manager and then begin the main game loop.\r\rYou should generally avoid accessing any of the systems created by Game, and instead use those\rmade 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.GameConfig" } }, "optional": true, "description": "The configuration object for your Phaser Game instance.", "name": "config" } ], "scope": "static", "longname": "Phaser.Game", "___id": "T000002R003355", "___s": true }, { "comment": "/**\r\n * The parsed Game Configuration object.\r\n *\r\n * The values stored within this object are read-only and should not be changed at run-time.\r\n *\r\n * @name Phaser.Game#config\r\n * @type {Phaser.Core.Config}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The parsed Game Configuration object.\r\rThe values stored within this object are read-only and should not be changed at run-time.", "name": "config", "type": { "names": [ "Phaser.Core.Config" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Core.Config" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#config", "scope": "instance", "kind": "member", "___id": "T000002R003358", "___s": true }, { "comment": "/**\r\n * A reference to either the Canvas or WebGL Renderer that this Game is using.\r\n *\r\n * @name Phaser.Game#renderer\r\n * @type {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.Canvas.CanvasRenderer" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } ] } }, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#renderer", "scope": "instance", "kind": "member", "___id": "T000002R003360", "___s": true }, { "comment": "/**\r\n * A reference to an HTML Div Element used as the DOM Element Container.\r\n *\r\n * Only set if `createDOMContainer` is `true` in the game config (by default it is `false`) and\r\n * if you provide a parent element to insert the Phaser Game inside.\r\n *\r\n * See the DOM Element Game Object for more details.\r\n *\r\n * @name Phaser.Game#domContainer\r\n * @type {HTMLDivElement}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Game.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "A reference to an HTML Div Element used as the DOM Element Container.\r\rOnly set if `createDOMContainer` is `true` in the game config (by default it is `false`) and\rif you provide a parent element to insert the Phaser Game inside.\r\rSee the DOM Element Game Object for more details.", "name": "domContainer", "type": { "names": [ "HTMLDivElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLDivElement" } }, "since": "3.17.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#domContainer", "scope": "instance", "kind": "member", "___id": "T000002R003362", "___s": true }, { "comment": "/**\r\n * A reference to the HTML Canvas Element that Phaser uses to render the game.\r\n * This is created automatically by Phaser unless you provide a `canvas` property\r\n * in your Game Config.\r\n *\r\n * @name Phaser.Game#canvas\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "A reference to the HTML Canvas Element that Phaser uses to render the game.\rThis is created automatically by Phaser unless you provide a `canvas` property\rin your Game Config.", "name": "canvas", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#canvas", "scope": "instance", "kind": "member", "___id": "T000002R003364", "___s": true }, { "comment": "/**\r\n * A reference to the Rendering Context belonging to the Canvas Element this game is rendering to.\r\n * If the game is running under Canvas it will be a 2d Canvas Rendering Context.\r\n * If the game is running under WebGL it will be a WebGL Rendering Context.\r\n * This context is created automatically by Phaser unless you provide a `context` property\r\n * in your Game Config.\r\n *\r\n * @name Phaser.Game#context\r\n * @type {(CanvasRenderingContext2D|WebGLRenderingContext)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 109, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "A reference to the Rendering Context belonging to the Canvas Element this game is rendering to.\rIf the game is running under Canvas it will be a 2d Canvas Rendering Context.\rIf the game is running under WebGL it will be a WebGL Rendering Context.\rThis context is created automatically by Phaser unless you provide a `context` property\rin your Game Config.", "name": "context", "type": { "names": [ "CanvasRenderingContext2D", "WebGLRenderingContext" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "CanvasRenderingContext2D" }, { "type": "NameExpression", "name": "WebGLRenderingContext" } ] } }, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#context", "scope": "instance", "kind": "member", "___id": "T000002R003366", "___s": true }, { "comment": "/**\r\n * A flag indicating when this Game instance has finished its boot process.\r\n *\r\n * @name Phaser.Game#isBooted\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "A flag indicating when this Game instance has finished its boot process.", "name": "isBooted", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#isBooted", "scope": "instance", "kind": "member", "___id": "T000002R003368", "___s": true }, { "comment": "/**\r\n * A flag indicating if this Game is currently running its game step or not.\r\n *\r\n * @name Phaser.Game#isRunning\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "A flag indicating if this Game is currently running its game step or not.", "name": "isRunning", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#isRunning", "scope": "instance", "kind": "member", "___id": "T000002R003370", "___s": true }, { "comment": "/**\r\n * An Event Emitter which is used to broadcast game-level events from the global systems.\r\n *\r\n * @name Phaser.Game#events\r\n * @type {Phaser.Events.EventEmitter}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "An Event Emitter which is used to broadcast game-level events from the global systems.", "name": "events", "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#events", "scope": "instance", "kind": "member", "___id": "T000002R003372", "___s": true }, { "comment": "/**\r\n * An instance of the Animation Manager.\r\n *\r\n * The Animation Manager is a global system responsible for managing all animations used within your game.\r\n *\r\n * @name Phaser.Game#anims\r\n * @type {Phaser.Animations.AnimationManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "An instance of the Animation Manager.\r\rThe Animation Manager is a global system responsible for managing all animations used within your game.", "name": "anims", "type": { "names": [ "Phaser.Animations.AnimationManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationManager" } }, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#anims", "scope": "instance", "kind": "member", "___id": "T000002R003374", "___s": true }, { "comment": "/**\r\n * An instance of the Texture Manager.\r\n *\r\n * The Texture Manager is a global system responsible for managing all textures being used by your game.\r\n *\r\n * @name Phaser.Game#textures\r\n * @type {Phaser.Textures.TextureManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "An instance of the Texture Manager.\r\rThe Texture Manager is a global system responsible for managing all textures being used by your game.", "name": "textures", "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#textures", "scope": "instance", "kind": "member", "___id": "T000002R003376", "___s": true }, { "comment": "/**\r\n * An instance of the Cache Manager.\r\n *\r\n * The Cache Manager is a global system responsible for caching, accessing and releasing external game assets.\r\n *\r\n * @name Phaser.Game#cache\r\n * @type {Phaser.Cache.CacheManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 173, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "An instance of the Cache Manager.\r\rThe Cache Manager is a global system responsible for caching, accessing and releasing external game assets.", "name": "cache", "type": { "names": [ "Phaser.Cache.CacheManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.CacheManager" } }, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#cache", "scope": "instance", "kind": "member", "___id": "T000002R003378", "___s": true }, { "comment": "/**\r\n * An instance of the Data Manager. This is a global manager, available from any Scene\r\n * and allows you to share and exchange your own game-level data or events without having\r\n * to use an internal event system.\r\n *\r\n * @name Phaser.Game#registry\r\n * @type {Phaser.Data.DataManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 184, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "An instance of the Data Manager. This is a global manager, available from any Scene\rand allows you to share and exchange your own game-level data or events without having\rto use an internal event system.", "name": "registry", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#registry", "scope": "instance", "kind": "member", "___id": "T000002R003380", "___s": true }, { "comment": "/**\r\n * An instance of the Input Manager.\r\n *\r\n * The Input Manager is a global system responsible for the capture of browser-level input events.\r\n *\r\n * @name Phaser.Game#input\r\n * @type {Phaser.Input.InputManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "An instance of the Input Manager.\r\rThe Input Manager is a global system responsible for the capture of browser-level input events.", "name": "input", "type": { "names": [ "Phaser.Input.InputManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputManager" } }, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#input", "scope": "instance", "kind": "member", "___id": "T000002R003382", "___s": true }, { "comment": "/**\r\n * An instance of the Scene Manager.\r\n *\r\n * The Scene Manager is a global system responsible for creating, modifying and updating the Scenes in your game.\r\n *\r\n * @name Phaser.Game#scene\r\n * @type {Phaser.Scenes.SceneManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "An instance of the Scene Manager.\r\rThe Scene Manager is a global system responsible for creating, modifying and updating the Scenes in your game.", "name": "scene", "type": { "names": [ "Phaser.Scenes.SceneManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.SceneManager" } }, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#scene", "scope": "instance", "kind": "member", "___id": "T000002R003384", "___s": true }, { "comment": "/**\r\n * A reference to the Device inspector.\r\n *\r\n * Contains information about the device running this game, such as OS, browser vendor and feature support.\r\n * Used by various systems to determine capabilities and code paths.\r\n *\r\n * @name Phaser.Game#device\r\n * @type {Phaser.DeviceConf}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 217, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "A reference to the Device inspector.\r\rContains information about the device running this game, such as OS, browser vendor and feature support.\rUsed by various systems to determine capabilities and code paths.", "name": "device", "type": { "names": [ "Phaser.DeviceConf" ], "parsedType": { "type": "NameExpression", "name": "Phaser.DeviceConf" } }, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#device", "scope": "instance", "kind": "member", "___id": "T000002R003386", "___s": true }, { "comment": "/**\r\n * An instance of the Scale Manager.\r\n *\r\n * The Scale Manager is a global system responsible for handling scaling of the game canvas.\r\n *\r\n * @name Phaser.Game#scale\r\n * @type {Phaser.Scale.ScaleManager}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Game.js", "lineno": 229, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "An instance of the Scale Manager.\r\rThe Scale Manager is a global system responsible for handling scaling of the game canvas.", "name": "scale", "type": { "names": [ "Phaser.Scale.ScaleManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.ScaleManager" } }, "since": "3.16.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#scale", "scope": "instance", "kind": "member", "___id": "T000002R003388", "___s": true }, { "comment": "/**\r\n * An instance of the base Sound Manager.\r\n *\r\n * The Sound Manager is a global system responsible for the playback and updating of all audio in your game.\r\n *\r\n * You can disable the inclusion of the Sound Manager in your build by toggling the webpack `FEATURE_SOUND` flag.\r\n *\r\n * @name Phaser.Game#sound\r\n * @type {(Phaser.Sound.NoAudioSoundManager|Phaser.Sound.HTML5AudioSoundManager|Phaser.Sound.WebAudioSoundManager)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 240, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "An instance of the base Sound Manager.\r\rThe Sound Manager is a global system responsible for the playback and updating of all audio in your game.\r\rYou 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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Sound.NoAudioSoundManager" }, { "type": "NameExpression", "name": "Phaser.Sound.HTML5AudioSoundManager" }, { "type": "NameExpression", "name": "Phaser.Sound.WebAudioSoundManager" } ] } }, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#sound", "scope": "instance", "kind": "member", "___id": "T000002R003390", "___s": true }, { "comment": "/**\r\n * An instance of the Time Step.\r\n *\r\n * The Time Step is a global system responsible for setting-up and responding to the browser frame events, processing\r\n * them and calculating delta values. It then automatically calls the game step.\r\n *\r\n * @name Phaser.Game#loop\r\n * @type {Phaser.Core.TimeStep}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 258, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "An instance of the Time Step.\r\rThe Time Step is a global system responsible for setting-up and responding to the browser frame events, processing\rthem and calculating delta values. It then automatically calls the game step.", "name": "loop", "type": { "names": [ "Phaser.Core.TimeStep" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Core.TimeStep" } }, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#loop", "scope": "instance", "kind": "member", "___id": "T000002R003393", "___s": true }, { "comment": "/**\r\n * An instance of the Plugin Manager.\r\n *\r\n * The Plugin Manager is a global system that allows plugins to register themselves with it, and can then install\r\n * those plugins into Scenes as required.\r\n *\r\n * @name Phaser.Game#plugins\r\n * @type {Phaser.Plugins.PluginManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 270, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "An instance of the Plugin Manager.\r\rThe Plugin Manager is a global system that allows plugins to register themselves with it, and can then install\rthose plugins into Scenes as required.", "name": "plugins", "type": { "names": [ "Phaser.Plugins.PluginManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Plugins.PluginManager" } }, "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#plugins", "scope": "instance", "kind": "member", "___id": "T000002R003395", "___s": true }, { "comment": "/**\r\n * Does the window the game is running in currently have focus or not?\r\n * This is modified by the VisibilityHandler.\r\n *\r\n * @name Phaser.Game#hasFocus\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.9.0\r\n */", "meta": { "filename": "Game.js", "lineno": 313, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Does the window the game is running in currently have focus or not?\rThis is modified by the VisibilityHandler.", "name": "hasFocus", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.9.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#hasFocus", "scope": "instance", "kind": "member", "___id": "T000002R003403", "___s": true }, { "comment": "/**\r\n * Is the Game currently paused? This will stop everything from updating,\r\n * except the `TimeStep` and related RequestAnimationFrame or setTimeout.\r\n * Those will continue stepping, but the core Game step will be skipped.\r\n *\r\n * @name Phaser.Game#isPaused\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Game.js", "lineno": 324, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Is the Game currently paused? This will stop everything from updating,\rexcept the `TimeStep` and related RequestAnimationFrame or setTimeout.\rThose will continue stepping, but the core Game step will be skipped.", "name": "isPaused", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#isPaused", "scope": "instance", "kind": "member", "___id": "T000002R003405", "___s": true }, { "comment": "/**\r\n * This method is called automatically when the DOM is ready. It is responsible for creating the renderer,\r\n * displaying the Debug Header, adding the game canvas to the DOM and emitting the 'boot' event.\r\n * It listens for a 'ready' event from the base systems and once received it will call `Game.start`.\r\n *\r\n * @method Phaser.Game#boot\r\n * @protected\r\n * @fires Phaser.Core.Events#BOOT\r\n * @listens Phaser.Textures.Events#READY\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 339, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "This method is called automatically when the DOM is ready. It is responsible for creating the renderer,\rdisplaying the Debug Header, adding the game canvas to the DOM and emitting the 'boot' event.\rIt listens for a 'ready' event from the base systems and once received it will call `Game.start`.", "kind": "function", "name": "boot", "access": "protected", "fires": [ "Phaser.Core.Events#event:BOOT" ], "listens": [ "Phaser.Textures.Events#event:READY" ], "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#boot", "scope": "instance", "___id": "T000002R003407", "___s": true }, { "comment": "/**\r\n * Called automatically by Game.boot once all of the global systems have finished setting themselves up.\r\n * By this point the Game is now ready to start the main loop running.\r\n * It will also enable the Visibility Handler.\r\n *\r\n * @method Phaser.Game#start\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 401, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Called automatically by Game.boot once all of the global systems have finished setting themselves up.\rBy this point the Game is now ready to start the main loop running.\rIt will also enable the Visibility Handler.", "kind": "function", "name": "start", "access": "protected", "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#start", "scope": "instance", "___id": "T000002R003413", "___s": true }, { "comment": "/**\r\n * The main Game Step. Called automatically by the Time Step, once per browser frame (typically as a result of\r\n * Request Animation Frame, or Set Timeout on very old browsers.)\r\n *\r\n * The step will update the global managers first, then proceed to update each Scene in turn, via the Scene Manager.\r\n *\r\n * It will then render each Scene in turn, via the Renderer. This process emits `prerender` and `postrender` events.\r\n *\r\n * @method Phaser.Game#step\r\n * @fires Phaser.Core.Events#PRE_STEP\r\n * @fires Phaser.Core.Events#STEP\r\n * @fires Phaser.Core.Events#POST_STEP\r\n * @fires Phaser.Core.Events#PRE_RENDER\r\n * @fires Phaser.Core.Events#POST_RENDER\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.\r\n * @param {number} delta - The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.\r\n */", "meta": { "filename": "Game.js", "lineno": 435, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The main Game Step. Called automatically by the Time Step, once per browser frame (typically as a result of\rRequest Animation Frame, or Set Timeout on very old browsers.)\r\rThe step will update the global managers first, then proceed to update each Scene in turn, via the Scene Manager.\r\rIt 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", "Phaser.Core.Events#event:STEP", "Phaser.Core.Events#event:POST_STEP", "Phaser.Core.Events#event:PRE_RENDER", "Phaser.Core.Events#event:POST_RENDER" ], "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003417", "___s": true }, { "comment": "/**\r\n * A special version of the Game Step for the HEADLESS renderer only.\r\n *\r\n * The main Game Step. Called automatically by the Time Step, once per browser frame (typically as a result of\r\n * Request Animation Frame, or Set Timeout on very old browsers.)\r\n *\r\n * The step will update the global managers first, then proceed to update each Scene in turn, via the Scene Manager.\r\n *\r\n * This process emits `prerender` and `postrender` events, even though nothing actually displays.\r\n *\r\n * @method Phaser.Game#headlessStep\r\n * @fires Phaser.Core.Events#PRE_RENDER\r\n * @fires Phaser.Core.Events#POST_RENDER\r\n * @since 3.2.0\r\n *\r\n * @param {number} time - The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.\r\n * @param {number} delta - The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.\r\n */", "meta": { "filename": "Game.js", "lineno": 505, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "A special version of the Game Step for the HEADLESS renderer only.\r\rThe main Game Step. Called automatically by the Time Step, once per browser frame (typically as a result of\rRequest Animation Frame, or Set Timeout on very old browsers.)\r\rThe step will update the global managers first, then proceed to update each Scene in turn, via the Scene Manager.\r\rThis process emits `prerender` and `postrender` events, even though nothing actually displays.", "kind": "function", "name": "headlessStep", "fires": [ "Phaser.Core.Events#event:PRE_RENDER", "Phaser.Core.Events#event:POST_RENDER" ], "since": "3.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003421", "___s": true }, { "comment": "/**\r\n * Called automatically by the Visibility Handler.\r\n * This will pause the main loop and then emit a pause event.\r\n *\r\n * @method Phaser.Game#onHidden\r\n * @protected\r\n * @fires Phaser.Core.Events#PAUSE\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 561, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Called automatically by the Visibility Handler.\rThis will pause the main loop and then emit a pause event.", "kind": "function", "name": "onHidden", "access": "protected", "fires": [ "Phaser.Core.Events#event:PAUSE" ], "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#onHidden", "scope": "instance", "___id": "T000002R003425", "___s": true }, { "comment": "/**\r\n * This will pause the entire game and emit a `PAUSE` event.\r\n *\r\n * All of Phaser's internal systems will be paused and the game will not re-render.\r\n *\r\n * Note that it does not pause any Loader requests that are currently in-flight.\r\n *\r\n * @method Phaser.Game#pause\r\n * @fires Phaser.Core.Events#PAUSE\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Game.js", "lineno": 577, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "This will pause the entire game and emit a `PAUSE` event.\r\rAll of Phaser's internal systems will be paused and the game will not re-render.\r\rNote that it does not pause any Loader requests that are currently in-flight.", "kind": "function", "name": "pause", "fires": [ "Phaser.Core.Events#event:PAUSE" ], "since": "3.60.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#pause", "scope": "instance", "___id": "T000002R003427", "___s": true }, { "comment": "/**\r\n * Called automatically by the Visibility Handler.\r\n * This will resume the main loop and then emit a resume event.\r\n *\r\n * @method Phaser.Game#onVisible\r\n * @protected\r\n * @fires Phaser.Core.Events#RESUME\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 600, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Called automatically by the Visibility Handler.\rThis will resume the main loop and then emit a resume event.", "kind": "function", "name": "onVisible", "access": "protected", "fires": [ "Phaser.Core.Events#event:RESUME" ], "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#onVisible", "scope": "instance", "___id": "T000002R003431", "___s": true }, { "comment": "/**\r\n * This will resume the entire game and emit a `RESUME` event.\r\n *\r\n * All of Phaser's internal systems will be resumed and the game will start rendering again.\r\n *\r\n * @method Phaser.Game#resume\r\n * @fires Phaser.Core.Events#RESUME\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Game.js", "lineno": 616, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "This will resume the entire game and emit a `RESUME` event.\r\rAll of Phaser's internal systems will be resumed and the game will start rendering again.", "kind": "function", "name": "resume", "fires": [ "Phaser.Core.Events#event:RESUME" ], "since": "3.60.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#resume", "scope": "instance", "___id": "T000002R003433", "___s": true }, { "comment": "/**\r\n * Called automatically by the Visibility Handler.\r\n * This will set the main loop into a 'blurred' state, which pauses it.\r\n *\r\n * @method Phaser.Game#onBlur\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 637, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Called automatically by the Visibility Handler.\rThis will set the main loop into a 'blurred' state, which pauses it.", "kind": "function", "name": "onBlur", "access": "protected", "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#onBlur", "scope": "instance", "___id": "T000002R003437", "___s": true }, { "comment": "/**\r\n * Called automatically by the Visibility Handler.\r\n * This will set the main loop into a 'focused' state, which resumes it.\r\n *\r\n * @method Phaser.Game#onFocus\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Game.js", "lineno": 652, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Called automatically by the Visibility Handler.\rThis will set the main loop into a 'focused' state, which resumes it.", "kind": "function", "name": "onFocus", "access": "protected", "since": "3.0.0", "memberof": "Phaser.Game", "longname": "Phaser.Game#onFocus", "scope": "instance", "___id": "T000002R003440", "___s": true }, { "comment": "/**\r\n * Returns the current game frame.\r\n *\r\n * When the game starts running, the frame is incremented every time Request Animation Frame, or Set Timeout, fires.\r\n *\r\n * @method Phaser.Game#getFrame\r\n * @since 3.16.0\r\n *\r\n * @return {number} The current game frame.\r\n */", "meta": { "filename": "Game.js", "lineno": 667, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Returns the current game frame.\r\rWhen 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current game frame." } ], "memberof": "Phaser.Game", "longname": "Phaser.Game#getFrame", "scope": "instance", "___id": "T000002R003443", "___s": true }, { "comment": "/**\r\n * Returns the time that the current game step started at, as based on `performance.now`.\r\n *\r\n * @method Phaser.Game#getTime\r\n * @since 3.16.0\r\n *\r\n * @return {number} The current game timestamp.\r\n */", "meta": { "filename": "Game.js", "lineno": 682, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current game timestamp." } ], "memberof": "Phaser.Game", "longname": "Phaser.Game#getTime", "scope": "instance", "___id": "T000002R003445", "___s": true }, { "comment": "/**\r\n * Flags this Game instance as needing to be destroyed on the _next frame_, making this an asynchronous operation.\r\n *\r\n * It will wait until the current frame has completed and then call `runDestroy` internally.\r\n *\r\n * If you need to react to the game's eventual destruction, listen for the `DESTROY` event.\r\n *\r\n * If 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\r\n * memory being held by the core Phaser plugins. If you do need to create another game instance on the same page, leave this as `false`.\r\n *\r\n * @method Phaser.Game#destroy\r\n * @fires Phaser.Core.Events#DESTROY\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} removeCanvas - Set to `true` if you would like the parent canvas element removed from the DOM, or `false` to leave it in place.\r\n * @param {boolean} [noReturn=false] - 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.\r\n */", "meta": { "filename": "Game.js", "lineno": 695, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Flags this Game instance as needing to be destroyed on the _next frame_, making this an asynchronous operation.\r\rIt will wait until the current frame has completed and then call `runDestroy` internally.\r\rIf you need to react to the game's eventual destruction, listen for the `DESTROY` event.\r\rIf 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\rmemory 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003447", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Core\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "kind": "namespace", "name": "Core", "memberof": "Phaser", "longname": "Phaser.Core", "scope": "static", "___id": "T000002R003457", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The core runner class that Phaser uses to handle the game loop. It can use either Request Animation Frame,\r\n * or SetTimeout, based on browser support and config settings, to create a continuous loop within the browser.\r\n *\r\n * Each time the loop fires, `TimeStep.step` is called and this is then passed onto the core Game update loop,\r\n * it is the core heartbeat of your game. It will fire as often as Request Animation Frame is capable of handling\r\n * on the target device.\r\n *\r\n * Note that there are lots of situations where a browser will stop updating your game. Such as if the player\r\n * switches tabs, or covers up the browser window with another application. In these cases, the 'heartbeat'\r\n * of your game will pause, and only resume when focus is returned to it by the player. There is no way to avoid\r\n * this situation, all you can do is use the visibility events the browser, and Phaser, provide to detect when\r\n * it has happened and then gracefully recover.\r\n *\r\n * @class TimeStep\r\n * @memberof Phaser.Core\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser.Game instance that owns this Time Step.\r\n * @param {Phaser.Types.Core.FPSConfig} config - The FPS configuration object, as parsed by the Game Config.\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "classdesc": "The core runner class that Phaser uses to handle the game loop. It can use either Request Animation Frame,\ror SetTimeout, based on browser support and config settings, to create a continuous loop within the browser.\r\rEach time the loop fires, `TimeStep.step` is called and this is then passed onto the core Game update loop,\rit is the core heartbeat of your game. It will fire as often as Request Animation Frame is capable of handling\ron the target device.\r\rNote that there are lots of situations where a browser will stop updating your game. Such as if the player\rswitches tabs, or covers up the browser window with another application. In these cases, the 'heartbeat'\rof your game will pause, and only resume when focus is returned to it by the player. There is no way to avoid\rthis situation, all you can do is use the visibility events the browser, and Phaser, provide to detect when\rit has happened and then gracefully recover.", "kind": "class", "name": "TimeStep", "memberof": "Phaser.Core", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "A reference to the Phaser.Game instance that owns this Time Step.", "name": "game" }, { "type": { "names": [ "Phaser.Types.Core.FPSConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.FPSConfig" } }, "description": "The FPS configuration object, as parsed by the Game Config.", "name": "config" } ], "scope": "static", "longname": "Phaser.Core.TimeStep", "___id": "T000002R003469", "___s": true }, { "comment": "/**\r\n * A reference to the Phaser.Game instance.\r\n *\r\n * @name Phaser.Core.TimeStep#game\r\n * @type {Phaser.Game}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 43, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "A reference to the Phaser.Game instance.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#game", "scope": "instance", "kind": "member", "___id": "T000002R003472", "___s": true }, { "comment": "/**\r\n * The Request Animation Frame DOM Event handler.\r\n *\r\n * @name Phaser.Core.TimeStep#raf\r\n * @type {Phaser.DOM.RequestAnimationFrame}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The Request Animation Frame DOM Event handler.", "name": "raf", "type": { "names": [ "Phaser.DOM.RequestAnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.DOM.RequestAnimationFrame" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#raf", "scope": "instance", "kind": "member", "___id": "T000002R003474", "___s": true }, { "comment": "/**\r\n * A flag that is set once the TimeStep has started running and toggled when it stops.\r\n *\r\n * @name Phaser.Core.TimeStep#started\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "A flag that is set once the TimeStep has started running and toggled when it stops.", "name": "started", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#started", "scope": "instance", "kind": "member", "___id": "T000002R003476", "___s": true }, { "comment": "/**\r\n * A flag that is set once the TimeStep has started running and toggled when it stops.\r\n * The difference between this value and `started` is that `running` is toggled when\r\n * the TimeStep is sent to sleep, where-as `started` remains `true`, only changing if\r\n * the TimeStep is actually stopped, not just paused.\r\n *\r\n * @name Phaser.Core.TimeStep#running\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "A flag that is set once the TimeStep has started running and toggled when it stops.\rThe difference between this value and `started` is that `running` is toggled when\rthe TimeStep is sent to sleep, where-as `started` remains `true`, only changing if\rthe TimeStep is actually stopped, not just paused.", "name": "running", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#running", "scope": "instance", "kind": "member", "___id": "T000002R003478", "___s": true }, { "comment": "/**\r\n * The minimum fps rate you want the Time Step to run at.\r\n *\r\n * Setting this cannot guarantee the browser runs at this rate, it merely influences\r\n * the internal timing values to help the Timestep know when it has gone out of sync.\r\n *\r\n * @name Phaser.Core.TimeStep#minFps\r\n * @type {number}\r\n * @default 5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The minimum fps rate you want the Time Step to run at.\r\rSetting this cannot guarantee the browser runs at this rate, it merely influences\rthe internal timing values to help the Timestep know when it has gone out of sync.", "name": "minFps", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "5", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#minFps", "scope": "instance", "kind": "member", "___id": "T000002R003480", "___s": true }, { "comment": "/**\r\n * The target fps rate for the Time Step to run at.\r\n *\r\n * Setting this value will not actually change the speed at which the browser runs, that is beyond\r\n * the control of Phaser. Instead, it allows you to determine performance issues and if the Time Step\r\n * is spiraling out of control.\r\n *\r\n * @name Phaser.Core.TimeStep#targetFps\r\n * @type {number}\r\n * @default 60\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 101, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The target fps rate for the Time Step to run at.\r\rSetting this value will not actually change the speed at which the browser runs, that is beyond\rthe control of Phaser. Instead, it allows you to determine performance issues and if the Time Step\ris spiraling out of control.", "name": "targetFps", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "60", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#targetFps", "scope": "instance", "kind": "member", "___id": "T000002R003482", "___s": true }, { "comment": "/**\r\n * Enforce a frame rate limit. This forces how often the Game step will run. By default it is zero,\r\n * which means it will run at whatever limit the browser (via RequestAnimationFrame) can handle, which\r\n * is the optimum rate for fast-action or responsive games.\r\n *\r\n * However, if you are building a non-game app, like a graphics generator, or low-intensity game that doesn't\r\n * require 60fps, then you can lower the step rate via this Game Config value:\r\n *\r\n * ```js\r\n * fps: {\r\n * limit: 30\r\n * }\r\n * ```\r\n *\r\n * Setting this _beyond_ the rate of RequestAnimationFrame will make no difference at all.\r\n *\r\n * Use it purely to _restrict_ updates in low-intensity situations only.\r\n *\r\n * You can change the FPS limit at any time by calling\r\n * `TimeStep.setFPSLimit(limit)`.\r\n * This will update the `fpsLimit`, `hasFpsLimit` and `_limitRate` properties.\r\n *\r\n * @name Phaser.Core.TimeStep#fpsLimit\r\n * @type {number}\r\n * @default 0\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Enforce a frame rate limit. This forces how often the Game step will run. By default it is zero,\rwhich means it will run at whatever limit the browser (via RequestAnimationFrame) can handle, which\ris the optimum rate for fast-action or responsive games.\r\rHowever, if you are building a non-game app, like a graphics generator, or low-intensity game that doesn't\rrequire 60fps, then you can lower the step rate via this Game Config value:\r\r```js\rfps: {\r limit: 30\r}\r```\r\rSetting this _beyond_ the rate of RequestAnimationFrame will make no difference at all.\r\rUse it purely to _restrict_ updates in low-intensity situations only.\r\rYou can change the FPS limit at any time by calling\r`TimeStep.setFPSLimit(limit)`.\rThis will update the `fpsLimit`, `hasFpsLimit` and `_limitRate` properties.", "name": "fpsLimit", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "readonly": true, "since": "3.60.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#fpsLimit", "scope": "instance", "kind": "member", "___id": "T000002R003484", "___s": true }, { "comment": "/**\r\n * Is the FPS rate limited?\r\n *\r\n * This is set by setting the Game Config `limit` value to a value above zero.\r\n *\r\n * Consider this property as read-only.\r\n *\r\n * @name Phaser.Core.TimeStep#hasFpsLimit\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Is the FPS rate limited?\r\rThis is set by setting the Game Config `limit` value to a value above zero.\r\rConsider this property as read-only.", "name": "hasFpsLimit", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "3.60.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#hasFpsLimit", "scope": "instance", "kind": "member", "___id": "T000002R003486", "___s": true }, { "comment": "/**\r\n * An exponential moving average of the frames per second.\r\n *\r\n * @name Phaser.Core.TimeStep#actualFps\r\n * @type {number}\r\n * @readonly\r\n * @default 60\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "An exponential moving average of the frames per second.", "name": "actualFps", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "60", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#actualFps", "scope": "instance", "kind": "member", "___id": "T000002R003494", "___s": true }, { "comment": "/**\r\n * The time at which the next fps rate update will take place.\r\n *\r\n * When an fps update happens, the `framesThisSecond` value is reset.\r\n *\r\n * @name Phaser.Core.TimeStep#nextFpsUpdate\r\n * @type {number}\r\n * @readonly\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The time at which the next fps rate update will take place.\r\rWhen an fps update happens, the `framesThisSecond` value is reset.", "name": "nextFpsUpdate", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#nextFpsUpdate", "scope": "instance", "kind": "member", "___id": "T000002R003496", "___s": true }, { "comment": "/**\r\n * The number of frames processed this second.\r\n *\r\n * @name Phaser.Core.TimeStep#framesThisSecond\r\n * @type {number}\r\n * @readonly\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 219, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The number of frames processed this second.", "name": "framesThisSecond", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#framesThisSecond", "scope": "instance", "kind": "member", "___id": "T000002R003498", "___s": true }, { "comment": "/**\r\n * A callback to be invoked each time the TimeStep steps.\r\n *\r\n * @name Phaser.Core.TimeStep#callback\r\n * @type {Phaser.Types.Core.TimeStepCallback}\r\n * @default NOOP\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 230, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "A callback to be invoked each time the TimeStep steps.", "name": "callback", "type": { "names": [ "Phaser.Types.Core.TimeStepCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.TimeStepCallback" } }, "defaultvalue": "NOOP", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#callback", "scope": "instance", "kind": "member", "___id": "T000002R003500", "___s": true }, { "comment": "/**\r\n * You can force the TimeStep to use SetTimeOut instead of Request Animation Frame by setting\r\n * the `forceSetTimeOut` property to `true` in the Game Configuration object. It cannot be changed at run-time.\r\n *\r\n * @name Phaser.Core.TimeStep#forceSetTimeOut\r\n * @type {boolean}\r\n * @readonly\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 240, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "You can force the TimeStep to use SetTimeOut instead of Request Animation Frame by setting\rthe `forceSetTimeOut` property to `true` in the Game Configuration object. It cannot be changed at run-time.", "name": "forceSetTimeOut", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#forceSetTimeOut", "scope": "instance", "kind": "member", "___id": "T000002R003502", "___s": true }, { "comment": "/**\r\n * The time, updated each step by adding the elapsed delta time to the previous value.\r\n *\r\n * This differs from the `TimeStep.now` value, which is the high resolution time value\r\n * as provided by Request Animation Frame.\r\n *\r\n * @name Phaser.Core.TimeStep#time\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 252, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The time, updated each step by adding the elapsed delta time to the previous value.\r\rThis differs from the `TimeStep.now` value, which is the high resolution time value\ras provided by Request Animation Frame.", "name": "time", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#time", "scope": "instance", "kind": "member", "___id": "T000002R003504", "___s": true }, { "comment": "/**\r\n * The time at which the game started running.\r\n *\r\n * This value is adjusted if the game is then paused and resumes.\r\n *\r\n * @name Phaser.Core.TimeStep#startTime\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 265, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The time at which the game started running.\r\rThis value is adjusted if the game is then paused and resumes.", "name": "startTime", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#startTime", "scope": "instance", "kind": "member", "___id": "T000002R003506", "___s": true }, { "comment": "/**\r\n * The time of the previous step.\r\n *\r\n * This is typically a high resolution timer value, as provided by Request Animation Frame.\r\n *\r\n * @name Phaser.Core.TimeStep#lastTime\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 277, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The time of the previous step.\r\rThis is typically a high resolution timer value, as provided by Request Animation Frame.", "name": "lastTime", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#lastTime", "scope": "instance", "kind": "member", "___id": "T000002R003508", "___s": true }, { "comment": "/**\r\n * The current frame the game is on. This counter is incremented once every game step, regardless of how much\r\n * time has passed and is unaffected by delta smoothing.\r\n *\r\n * @name Phaser.Core.TimeStep#frame\r\n * @type {number}\r\n * @readonly\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The current frame the game is on. This counter is incremented once every game step, regardless of how much\rtime has passed and is unaffected by delta smoothing.", "name": "frame", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#frame", "scope": "instance", "kind": "member", "___id": "T000002R003510", "___s": true }, { "comment": "/**\r\n * Is the browser currently considered in focus by the Page Visibility API?\r\n *\r\n * This value is set in the `blur` method, which is called automatically by the Game instance.\r\n *\r\n * @name Phaser.Core.TimeStep#inFocus\r\n * @type {boolean}\r\n * @readonly\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 301, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Is the browser currently considered in focus by the Page Visibility API?\r\rThis value is set in the `blur` method, which is called automatically by the Game instance.", "name": "inFocus", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#inFocus", "scope": "instance", "kind": "member", "___id": "T000002R003512", "___s": true }, { "comment": "/**\r\n * The duration of the most recent game pause, if any, in ms.\r\n *\r\n * @name Phaser.Core.TimeStep#pauseDuration\r\n * @type {number}\r\n * @readonly\r\n * @default 0\r\n * @since 3.85.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 314, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The duration of the most recent game pause, if any, in ms.", "name": "pauseDuration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0", "since": "3.85.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#pauseDuration", "scope": "instance", "kind": "member", "___id": "T000002R003514", "___s": true }, { "comment": "/**\r\n * The delta time, in ms, since the last game step. This is a clamped and smoothed average value.\r\n *\r\n * @name Phaser.Core.TimeStep#delta\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 347, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The delta time, in ms, since the last game step. This is a clamped and smoothed average value.", "name": "delta", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#delta", "scope": "instance", "kind": "member", "___id": "T000002R003520", "___s": true }, { "comment": "/**\r\n * Internal index of the delta history position.\r\n *\r\n * @name Phaser.Core.TimeStep#deltaIndex\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 357, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Internal index of the delta history position.", "name": "deltaIndex", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#deltaIndex", "scope": "instance", "kind": "member", "___id": "T000002R003522", "___s": true }, { "comment": "/**\r\n * Internal array holding the previous delta values, used for delta smoothing.\r\n *\r\n * @name Phaser.Core.TimeStep#deltaHistory\r\n * @type {number[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 367, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Internal array holding the previous delta values, used for delta smoothing.", "name": "deltaHistory", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#deltaHistory", "scope": "instance", "kind": "member", "___id": "T000002R003524", "___s": true }, { "comment": "/**\r\n * The maximum number of delta values that are retained in order to calculate a smoothed moving average.\r\n *\r\n * This can be changed in the Game Config via the `fps.deltaHistory` property. The default is 10.\r\n *\r\n * @name Phaser.Core.TimeStep#deltaSmoothingMax\r\n * @type {number}\r\n * @default 10\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 376, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The maximum number of delta values that are retained in order to calculate a smoothed moving average.\r\rThis can be changed in the Game Config via the `fps.deltaHistory` property. The default is 10.", "name": "deltaSmoothingMax", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "10", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#deltaSmoothingMax", "scope": "instance", "kind": "member", "___id": "T000002R003526", "___s": true }, { "comment": "/**\r\n * The number of frames that the cooldown is set to after the browser panics over the FPS rate, usually\r\n * as a result of switching tabs and regaining focus.\r\n *\r\n * This can be changed in the Game Config via the `fps.panicMax` property. The default is 120.\r\n *\r\n * @name Phaser.Core.TimeStep#panicMax\r\n * @type {number}\r\n * @default 120\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 388, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The number of frames that the cooldown is set to after the browser panics over the FPS rate, usually\ras a result of switching tabs and regaining focus.\r\rThis can be changed in the Game Config via the `fps.panicMax` property. The default is 120.", "name": "panicMax", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "120", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#panicMax", "scope": "instance", "kind": "member", "___id": "T000002R003528", "___s": true }, { "comment": "/**\r\n * The actual elapsed time in ms between one update and the next.\r\n *\r\n * Unlike with `delta`, no smoothing, capping, or averaging is applied to this value.\r\n * So please be careful when using this value in math calculations.\r\n *\r\n * @name Phaser.Core.TimeStep#rawDelta\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The actual elapsed time in ms between one update and the next.\r\rUnlike with `delta`, no smoothing, capping, or averaging is applied to this value.\rSo please be careful when using this value in math calculations.", "name": "rawDelta", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#rawDelta", "scope": "instance", "kind": "member", "___id": "T000002R003530", "___s": true }, { "comment": "/**\r\n * The time, set at the start of the current step.\r\n *\r\n * This is typically a high resolution timer value, as provided by Request Animation Frame.\r\n *\r\n * This can differ from the `time` value in that it isn't calculated based on the delta value.\r\n *\r\n * @name Phaser.Core.TimeStep#now\r\n * @type {number}\r\n * @default 0\r\n * @since 3.18.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 414, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The time, set at the start of the current step.\r\rThis is typically a high resolution timer value, as provided by Request Animation Frame.\r\rThis can differ from the `time` value in that it isn't calculated based on the delta value.", "name": "now", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.18.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#now", "scope": "instance", "kind": "member", "___id": "T000002R003532", "___s": true }, { "comment": "/**\r\n * Apply smoothing to the delta value used within Phaser's internal calculations?\r\n *\r\n * This can be changed in the Game Config via the `fps.smoothStep` property. The default is `true`.\r\n *\r\n * Smoothing helps settle down the delta values after browser tab switches, or other situations\r\n * which could cause significant delta spikes or dips. By default it has been enabled in Phaser 3\r\n * since the first version, but is now exposed under this property (and the corresponding game config\r\n * `smoothStep` value), to allow you to easily disable it, should you require.\r\n *\r\n * @name Phaser.Core.TimeStep#smoothStep\r\n * @type {boolean}\r\n * @since 3.22.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 428, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Apply smoothing to the delta value used within Phaser's internal calculations?\r\rThis can be changed in the Game Config via the `fps.smoothStep` property. The default is `true`.\r\rSmoothing helps settle down the delta values after browser tab switches, or other situations\rwhich could cause significant delta spikes or dips. By default it has been enabled in Phaser 3\rsince the first version, but is now exposed under this property (and the corresponding game config\r`smoothStep` value), to allow you to easily disable it, should you require.", "name": "smoothStep", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.22.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#smoothStep", "scope": "instance", "kind": "member", "___id": "T000002R003534", "___s": true }, { "comment": "/**\r\n * Called by the Game instance when the DOM window.onBlur event triggers.\r\n *\r\n * @method Phaser.Core.TimeStep#blur\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 445, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "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", "___id": "T000002R003536", "___s": true }, { "comment": "/**\r\n * Called by the Game instance when the DOM window.onFocus event triggers.\r\n *\r\n * @method Phaser.Core.TimeStep#focus\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "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", "___id": "T000002R003539", "___s": true }, { "comment": "/**\r\n * Called when the visibility API says the game is 'hidden' (tab switch out of view, etc)\r\n *\r\n * @method Phaser.Core.TimeStep#pause\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 469, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "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", "___id": "T000002R003542", "___s": true }, { "comment": "/**\r\n * Called when the visibility API says the game is 'visible' again (tab switch back into view, etc)\r\n *\r\n * @method Phaser.Core.TimeStep#resume\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 480, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "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", "___id": "T000002R003545", "___s": true }, { "comment": "/**\r\n * Resets the time, lastTime, fps averages and delta history.\r\n * Called automatically when a browser sleeps then resumes.\r\n *\r\n * @method Phaser.Core.TimeStep#resetDelta\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Resets the time, lastTime, fps averages and delta history.\rCalled automatically when a browser sleeps then resumes.", "kind": "function", "name": "resetDelta", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#resetDelta", "scope": "instance", "___id": "T000002R003549", "___s": true }, { "comment": "/**\r\n * Starts the Time Step running, if it is not already doing so.\r\n * Called automatically by the Game Boot process.\r\n *\r\n * @method Phaser.Core.TimeStep#start\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Core.TimeStepCallback} callback - The callback to be invoked each time the Time Step steps.\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Starts the Time Step running, if it is not already doing so.\rCalled automatically by the Game Boot process.", "kind": "function", "name": "start", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Core.TimeStepCallback" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003561", "___s": true }, { "comment": "/**\r\n * Takes the delta value and smooths it based on the previous frames.\r\n *\r\n * Called automatically as part of the step.\r\n *\r\n * @method Phaser.Core.TimeStep#smoothDelta\r\n * @since 3.60.0\r\n *\r\n * @param {number} delta - The delta value for this step.\r\n *\r\n * @return {number} The smoothed delta value.\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 558, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Takes the delta value and smooths it based on the previous frames.\r\rCalled automatically as part of the step.", "kind": "function", "name": "smoothDelta", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value for this step.", "name": "delta" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The smoothed delta value." } ], "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#smoothDelta", "scope": "instance", "___id": "T000002R003570", "___s": true }, { "comment": "/**\r\n * Update the estimate of the frame rate, `fps`. Every second, the number\r\n * of frames that occurred in that second are included in an exponential\r\n * moving average of all frames per second, with an alpha of 0.25. This\r\n * means that more recent seconds affect the estimated frame rate more than\r\n * older seconds.\r\n *\r\n * When a browser window is NOT minimized, but is covered up (i.e. you're using\r\n * another app which has spawned a window over the top of the browser), then it\r\n * will start to throttle the raf callback time. It waits for a while, and then\r\n * starts to drop the frame rate at 1 frame per second until it's down to just over 1fps.\r\n * So if the game was running at 60fps, and the player opens a new window, then\r\n * after 60 seconds (+ the 'buffer time') it'll be down to 1fps, firing at just 1Hz.\r\n *\r\n * When they make the game visible again, the frame rate is increased at a rate of\r\n * approx. 8fps, back up to 60fps (or the max it can obtain)\r\n *\r\n * There is no easy way to determine if this drop in frame rate is because the\r\n * browser is throttling raf, or because the game is struggling with performance\r\n * because you're asking it to do too much on the device.\r\n *\r\n * Compute the new exponential moving average with an alpha of 0.25.\r\n *\r\n * @method Phaser.Core.TimeStep#updateFPS\r\n * @since 3.60.0\r\n *\r\n * @param {number} time - The timestamp passed in from RequestAnimationFrame or setTimeout.\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Update the estimate of the frame rate, `fps`. Every second, the number\rof frames that occurred in that second are included in an exponential\rmoving average of all frames per second, with an alpha of 0.25. This\rmeans that more recent seconds affect the estimated frame rate more than\rolder seconds.\r\rWhen a browser window is NOT minimized, but is covered up (i.e. you're using\ranother app which has spawned a window over the top of the browser), then it\rwill start to throttle the raf callback time. It waits for a while, and then\rstarts to drop the frame rate at 1 frame per second until it's down to just over 1fps.\rSo if the game was running at 60fps, and the player opens a new window, then\rafter 60 seconds (+ the 'buffer time') it'll be down to 1fps, firing at just 1Hz.\r\rWhen they make the game visible again, the frame rate is increased at a rate of\rapprox. 8fps, back up to 60fps (or the max it can obtain)\r\rThere is no easy way to determine if this drop in frame rate is because the\rbrowser is throttling raf, or because the game is struggling with performance\rbecause you're asking it to do too much on the device.\r\rCompute the new exponential moving average with an alpha of 0.25.", "kind": "function", "name": "updateFPS", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The timestamp passed in from RequestAnimationFrame or setTimeout.", "name": "time" } ], "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#updateFPS", "scope": "instance", "___id": "T000002R003584", "___s": true }, { "comment": "/**\r\n * The main step method with an fps limiter. This is called each time the browser updates, either by Request Animation Frame,\r\n * or by Set Timeout. It is responsible for calculating the delta values, frame totals, cool down history and more.\r\n * You generally should never call this method directly.\r\n *\r\n * @method Phaser.Core.TimeStep#stepLimitFPS\r\n * @since 3.60.0\r\n *\r\n * @param {number} time - The timestamp passed in from RequestAnimationFrame or setTimeout.\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 657, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The main step method with an fps limiter. This is called each time the browser updates, either by Request Animation Frame,\ror by Set Timeout. It is responsible for calculating the delta values, frame totals, cool down history and more.\rYou generally should never call this method directly.", "kind": "function", "name": "stepLimitFPS", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The timestamp passed in from RequestAnimationFrame or setTimeout.", "name": "time" } ], "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#stepLimitFPS", "scope": "instance", "___id": "T000002R003589", "___s": true }, { "comment": "/**\r\n * The main step method. This is called each time the browser updates, either by Request Animation Frame,\r\n * or by Set Timeout. It is responsible for calculating the delta values, frame totals, cool down history and more.\r\n * You generally should never call this method directly.\r\n *\r\n * @method Phaser.Core.TimeStep#step\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The timestamp passed in from RequestAnimationFrame or setTimeout.\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 708, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The main step method. This is called each time the browser updates, either by Request Animation Frame,\ror by Set Timeout. It is responsible for calculating the delta values, frame totals, cool down history and more.\rYou generally should never call this method directly.", "kind": "function", "name": "step", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The timestamp passed in from RequestAnimationFrame or setTimeout.", "name": "time" } ], "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#step", "scope": "instance", "___id": "T000002R003599", "___s": true }, { "comment": "/**\r\n * Manually advances the TimeStep by one step, using the current timestamp from `window.performance.now`.\r\n * Calls `TimeStep.stepLimitFPS` if an FPS limit is active, otherwise calls `TimeStep.step`.\r\n *\r\n * @method Phaser.Core.TimeStep#tick\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 754, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Manually advances the TimeStep by one step, using the current timestamp from `window.performance.now`.\rCalls `TimeStep.stepLimitFPS` if an FPS limit is active, otherwise calls `TimeStep.step`.", "kind": "function", "name": "tick", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#tick", "scope": "instance", "___id": "T000002R003608", "___s": true }, { "comment": "/**\r\n * Sends the TimeStep to sleep, stopping Request Animation Frame (or SetTimeout) and toggling the `running` flag to false.\r\n *\r\n * @method Phaser.Core.TimeStep#sleep\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 775, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "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", "___id": "T000002R003611", "___s": true }, { "comment": "/**\r\n * Wakes-up the TimeStep, restarting Request Animation Frame (or SetTimeout) and toggling the `running` flag to true.\r\n * The `seamless` argument controls if the wake-up should adjust the start time or not.\r\n *\r\n * @method Phaser.Core.TimeStep#wake\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [seamless=false] - Adjust the startTime based on the lastTime values.\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 791, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Wakes-up the TimeStep, restarting Request Animation Frame (or SetTimeout) and toggling the `running` flag to true.\rThe `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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003614", "___s": true }, { "comment": "/**\r\n * Gets the duration which the game has been running, in seconds.\r\n *\r\n * @method Phaser.Core.TimeStep#getDuration\r\n * @since 3.17.0\r\n *\r\n * @return {number} The duration in seconds.\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 828, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Gets the duration which the game has been running, in seconds.", "kind": "function", "name": "getDuration", "since": "3.17.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration in seconds." } ], "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#getDuration", "scope": "instance", "___id": "T000002R003624", "___s": true }, { "comment": "/**\r\n * Gets the duration which the game has been running, in ms.\r\n *\r\n * @method Phaser.Core.TimeStep#getDurationMS\r\n * @since 3.17.0\r\n *\r\n * @return {number} The duration in ms.\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 841, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Gets the duration which the game has been running, in ms.", "kind": "function", "name": "getDurationMS", "since": "3.17.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration in ms." } ], "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#getDurationMS", "scope": "instance", "___id": "T000002R003626", "___s": true }, { "comment": "/**\r\n * Sets the FPS limit (`fpsLimit` property) and related properties.\r\n *\r\n * Use this method to set the FPS limit at runtime, rather than setting the\r\n * `fpsLimit` property directly, to ensure the related properties are\r\n * updated correctly. If the TimeStep is running, it will be stopped and\r\n * restarted with the new FPS limit.\r\n *\r\n * If you just want a constant limit, use the Game Config `fps: { limit: 30 }` value instead.\r\n *\r\n * @method Phaser.Core.TimeStep#setFPSLimit\r\n * @since 4.2.0\r\n *\r\n * @param {number} limit - The FPS limit to set. Set to 0 to remove the FPS limit.\r\n *\r\n * @return {this} The TimeStep object.\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 854, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Sets the FPS limit (`fpsLimit` property) and related properties.\r\rUse this method to set the FPS limit at runtime, rather than setting the\r`fpsLimit` property directly, to ensure the related properties are\rupdated correctly. If the TimeStep is running, it will be stopped and\rrestarted with the new FPS limit.\r\rIf you just want a constant limit, use the Game Config `fps: { limit: 30 }` value instead.", "kind": "function", "name": "setFPSLimit", "since": "4.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The FPS limit to set. Set to 0 to remove the FPS limit.", "name": "limit" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The TimeStep object." } ], "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#setFPSLimit", "scope": "instance", "___id": "T000002R003628", "___s": true }, { "comment": "/**\r\n * Stops the TimeStep running.\r\n *\r\n * @method Phaser.Core.TimeStep#stop\r\n * @since 3.0.0\r\n *\r\n * @return {this} The TimeStep object.\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 887, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Stops the TimeStep running.", "kind": "function", "name": "stop", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The TimeStep object." } ], "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#stop", "scope": "instance", "___id": "T000002R003634", "___s": true }, { "comment": "/**\r\n * Destroys the TimeStep. This will stop Request Animation Frame, stop the step, clear the callbacks and null\r\n * any objects.\r\n *\r\n * @method Phaser.Core.TimeStep#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TimeStep.js", "lineno": 905, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "Destroys the TimeStep. This will stop Request Animation Frame, stop the step, clear the callbacks and null\rany objects.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Core.TimeStep", "longname": "Phaser.Core.TimeStep#destroy", "scope": "instance", "___id": "T000002R003638", "___s": true }, { "comment": "/**\r\n * Config object containing various sound settings.\r\n *\r\n * @typedef {object} Phaser.Types.Core.AudioConfig\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} [disableWebAudio=false] - Use HTML5 Audio instead of Web Audio.\r\n * @property {AudioContext} [context] - An existing Web Audio context.\r\n * @property {boolean} [noAudio=false] - Disable all audio output.\r\n *\r\n * @see Phaser.Sound.SoundManagerCreator\r\n */", "meta": { "filename": "AudioConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "description": "Config object containing various sound settings.", "kind": "typedef", "name": "AudioConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Use HTML5 Audio instead of Web Audio.", "name": "disableWebAudio" }, { "type": { "names": [ "AudioContext" ], "parsedType": { "type": "NameExpression", "name": "AudioContext" } }, "optional": true, "description": "An existing Web Audio context.", "name": "context" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003644", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.BannerConfig\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} [hidePhaser=false] - Omit Phaser's name and version from the banner.\r\n * @property {string} [text='#ffffff'] - The color of the banner text.\r\n * @property {string[]} [background] - The background colors of the banner.\r\n */", "meta": { "filename": "BannerConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "BannerConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Omit Phaser's name and version from the banner.", "name": "hidePhaser" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'#ffffff'", "description": "The color of the banner text.", "name": "text" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "optional": true, "description": "The background colors of the banner.", "name": "background" } ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.BannerConfig", "scope": "static", "___id": "T000002R003645", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Core.BootCallback\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - The game.\r\n */", "meta": { "filename": "BootCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "BootCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "The game.", "name": "game" } ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.BootCallback", "scope": "static", "___id": "T000002R003646", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.CallbacksConfig\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Types.Core.BootCallback} [preBoot=Phaser.Types.Core.NOOP] - A function to run at the start of the boot sequence.\r\n * @property {Phaser.Types.Core.BootCallback} [postBoot=Phaser.Types.Core.NOOP] - 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.\r\n */", "meta": { "filename": "CallbacksConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "CallbacksConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Types.Core.BootCallback" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003647", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.DOMContainerConfig\r\n * @since 3.12.0\r\n *\r\n * @property {boolean} [createContainer=false] - 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.\r\n * @property {boolean} [behindCanvas=false] - 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?\r\n * @property {string} [pointerEvents='none'] - The default `pointerEvents` attribute set on the DOM Container.\r\n */", "meta": { "filename": "DOMContainerConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "DOMContainerConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.12.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'none'", "description": "The default `pointerEvents` attribute set on the DOM Container.", "name": "pointerEvents" } ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.DOMContainerConfig", "scope": "static", "___id": "T000002R003648", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.FPSConfig\r\n * @since 3.0.0\r\n *\r\n * @property {number} [min=5] - The minimum acceptable rendering rate, in frames per second.\r\n * @property {number} [target=60] - The optimum rendering rate, in frames per second. This does not enforce the fps rate, it merely tells Phaser what rate is considered optimal for this game.\r\n * @property {number} [limit=0] - Enforces an fps rate limit that the game step will run at, regardless of browser frequency. 0 means 'no limit'. This is only useful for artificially dropping the frame rate to get a retro effect. The browser will never update the game faster than the display refresh rate.\r\n * @property {boolean} [forceSetTimeOut=false] - Use setTimeout instead of requestAnimationFrame to run the game loop.\r\n * @property {number} [deltaHistory=10] - Calculate the average frame delta from this many consecutive frame intervals.\r\n * @property {number} [panicMax=120] - The amount of frames the time step counts before we trust the delta values again.\r\n * @property {boolean} [smoothStep=true] - Apply delta smoothing during the game update to help avoid spikes?\r\n */", "meta": { "filename": "FPSConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "FPSConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 5, "description": "The minimum acceptable rendering rate, in frames per second.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 60, "description": "The optimum rendering rate, in frames per second. This does not enforce the fps rate, it merely tells Phaser what rate is considered optimal for this game.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Enforces an fps rate limit that the game step will run at, regardless of browser frequency. 0 means 'no limit'. This is only useful for artificially dropping the frame rate to get a retro effect. The browser will never update the game faster than the display refresh rate.", "name": "limit" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Use setTimeout instead of requestAnimationFrame to run the game loop.", "name": "forceSetTimeOut" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "Calculate the average frame delta from this many consecutive frame intervals.", "name": "deltaHistory" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003649", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.GameConfig\r\n * @since 3.0.0\r\n *\r\n * @property {(number|string)} [width=1024] - The width of the game, in game pixels.\r\n * @property {(number|string)} [height=768] - The height of the game, in game pixels.\r\n * @property {number} [zoom=1] - Simple scale applied to the game canvas. 2 is double size, 0.5 is half size, etc.\r\n * @property {number} [type=CONST.AUTO] - Which renderer to use. Phaser.AUTO, Phaser.CANVAS, Phaser.HEADLESS, or Phaser.WEBGL. AUTO picks WEBGL if available, otherwise CANVAS.\r\n * @property {(number|boolean)} [stableSort=-1] - `true` or `1` = Use the built-in StableSort (needed for older browsers), `false` or `0` = Rely on ES2019 Array.sort being stable (modern browsers only), or `-1` = Try and determine this automatically based on browser inspection (not guaranteed to work, errs on side of caution).\r\n * @property {(HTMLElement|string|null)} [parent=undefined] - 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 appended to the document body. If `null` no parent will be used and you are responsible for adding the canvas to the dom.\r\n * @property {HTMLCanvasElement} [canvas=null] - Provide your own Canvas element for Phaser to use instead of creating one.\r\n * @property {string} [canvasStyle=null] - CSS styles to apply to the game canvas instead of Phasers default styles.\r\n * @property {boolean}[customEnvironment=false] - 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`.\r\n * @property {CanvasRenderingContext2D} [context] - Provide your own Canvas Context for Phaser to use, instead of creating one.\r\n * @property {(Phaser.Types.Scenes.SceneType|Phaser.Types.Scenes.SceneType[])} [scene=null] - 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`.\r\n * @property {string[]} [seed] - Seed for the random number generator.\r\n * @property {string} [title=''] - The title of the game. Shown in the browser console.\r\n * @property {string} [url='https://phaser.io'] - The URL of the game. Shown in the browser console.\r\n * @property {string} [version=''] - The version of the game. Shown in the browser console.\r\n * @property {boolean} [autoFocus=true] - Automatically call window.focus() when the game boots. Usually necessary to capture input events if the game is in a separate frame.\r\n * @property {(boolean|Phaser.Types.Core.InputConfig)} [input] - Input configuration, or `false` to disable all game input.\r\n * @property {boolean} [disableContextMenu=false] - Disable the browser's default 'contextmenu' event (usually triggered by a right-button mouse click).\r\n * @property {(boolean|Phaser.Types.Core.BannerConfig)} [banner=false] - Configuration for the banner printed in the browser console when the game starts.\r\n * @property {Phaser.Types.Core.DOMContainerConfig} [dom] - The DOM Container configuration object.\r\n * @property {Phaser.Types.Core.FPSConfig} [fps] - Game loop configuration.\r\n * @property {Phaser.Types.Core.RenderConfig} [render] - Game renderer configuration.\r\n * @property {Phaser.Types.Core.CallbacksConfig} [callbacks] - Optional callbacks to run before or after game boot.\r\n * @property {Phaser.Types.Core.LoaderConfig} [loader] - Loader configuration.\r\n * @property {Phaser.Types.Core.ImagesConfig} [images] - Images configuration.\r\n * @property {Phaser.Types.Core.PhysicsConfig} [physics] - Physics configuration.\r\n * @property {Phaser.Types.Core.PluginObject|Phaser.Types.Core.PluginObjectItem[]} [plugins] - Plugins to install.\r\n * @property {Phaser.Types.Core.ScaleConfig} [scale] - The Scale Manager configuration.\r\n * @property {Phaser.Types.Core.AudioConfig} [audio] - The Audio Configuration object.\r\n * @property {(string|number)} [backgroundColor=0x000000] - The background color of the game canvas. The default is black.\r\n * @property {boolean} [antialias=true] - 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.\r\n * @property {boolean} [antialiasGL=true] - 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.\r\n * @property {boolean} [desynchronized=false] - 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.\r\n * @property {boolean} [pixelArt=false] - Sets `antialias` to false and `roundPixels` to true. This is the best setting for pixel-art games.\r\n * @property {boolean} [smoothPixelArt=false] - WebGL only. Sets `antialias` to true and `pixelArt` to false. Texture-based Game Objects use special shader setting that preserve blocky pixels, but smooth the edges between the pixels. This is only visible when objects are scaled up; otherwise, `antialias` is simpler.\r\n * @property {boolean} [roundPixels=false] - Draw texture-based Game Objects at only whole-integer positions. Game Objects without textures, like Graphics, ignore this property.\r\n * @property {boolean} [selfShadow=false] - On textured objects with lighting, this enables self-shadowing based on the diffuse map.\r\n * @property {number} [pathDetailThreshold=1] - Threshold for combining points into a single path in the WebGL renderer for Graphics objects. This can be overridden at the Graphics object level.\r\n * @property {boolean} [transparent=false] - 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.\r\n * @property {boolean} [clearBeforeRender=true] - Whether the game canvas will be cleared between each rendering frame.\r\n * @property {boolean} [preserveDrawingBuffer=false] - If the value is true the WebGL buffers will not be cleared and will preserve their values until cleared or overwritten by the author.\r\n * @property {boolean} [premultipliedAlpha=true] - In WebGL mode, the drawing buffer contains colors with pre-multiplied alpha.\r\n * @property {boolean} [skipUnreadyShaders=false] - Avert stuttering during shader compilation, by enabling parallel shader compilation, where supported. Objects which request a shader that is not yet ready will not be drawn. This prevents stutter, but may cause \"pop-in\" of objects unless you use a pre-touch strategy.\r\n * @property {boolean} [failIfMajorPerformanceCaveat=false] - Let the browser abort creating a WebGL context if it judges performance would be unacceptable.\r\n * @property {string} [powerPreference='default'] - \"high-performance\", \"low-power\" or \"default\". A hint to the browser on how much device power the game might use.\r\n * @property {number} [batchSize=16384] - The default WebGL batch size. Represents the number of _quads_ that can be added to a single batch.\r\n * @property {number} [maxLights=10] - The maximum number of lights allowed to be visible within range of a single Camera in the LightManager.\r\n * @property {number} [maxTextures=-1] - When in WebGL mode, this sets the maximum number of GPU Textures to use. The default, -1, will use all available units. The WebGL1 spec says all browsers should provide a minimum of 8.\r\n * @property {string} [mipmapFilter='LINEAR'] - The mipmap magFilter to be used when creating WebGL textures.\r\n * @property {boolean} [mipmapRegeneration=false] - Whether to regenerate mipmaps for framebuffers.\r\n * @property {boolean} [autoMobileTextures=true] - If iOS or Android detected, automatically restrict WebGL to use 1 texture per batch. This can help performance on some devices.\r\n * @property {boolean} [expandParent=true] - Is the Scale Manager allowed to adjust the CSS height property of the parent and/or document body to be 100%?\r\n * @property {Phaser.Scale.ScaleModeType} [mode=Phaser.Scale.ScaleModes.NONE] - The scale mode.\r\n * @property {WidthHeight} [min] - The minimum width and height the canvas can be scaled down to.\r\n * @property {WidthHeight} [max] - The maximum width the canvas can be scaled up to.\r\n * @property {boolean} [autoRound=false] - Automatically round the display and style sizes of the canvas. This can help with performance in lower-powered devices.\r\n * @property {Phaser.Scale.CenterType} [autoCenter=Phaser.Scale.Center.NO_CENTER] - Automatically center the canvas within the parent?\r\n * @property {number} [resizeInterval=500] - How many ms should elapse before checking if the browser size has changed?\r\n * @property {?(HTMLElement|string)} [fullscreenTarget] - 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.\r\n */", "meta": { "filename": "GameConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "GameConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "defaultvalue": 1024, "description": "The width of the game, in game pixels.", "name": "width" }, { "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "defaultvalue": 768, "description": "The height of the game, in game pixels.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "boolean" } ] } }, "optional": true, "defaultvalue": -1, "description": "`true` or `1` = Use the built-in StableSort (needed for older browsers), `false` or `0` = Rely on ES2019 Array.sort being stable (modern browsers only), or `-1` = Try and determine this automatically based on browser inspection (not guaranteed to work, errs on side of caution).", "name": "stableSort" }, { "type": { "names": [ "HTMLElement", "string", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLElement" }, { "type": "NameExpression", "name": "string" }, { "type": "NullLiteral" } ] } }, "optional": 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 appended to the document body. If `null` no parent will be used and you are responsible for adding the canvas to the dom.", "name": "parent" }, { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "optional": true, "defaultvalue": null, "description": "Provide your own Canvas element for Phaser to use instead of creating one.", "name": "canvas" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": null, "description": "CSS styles to apply to the game canvas instead of Phasers default styles.", "name": "canvasStyle" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "optional": true, "description": "Provide your own Canvas Context for Phaser to use, instead of creating one.", "name": "context" }, { "type": { "names": [ "Phaser.Types.Scenes.SceneType", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Scenes.SceneType" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Scenes.SceneType", "type": "NameExpression" } ] } ] } }, "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "optional": true, "description": "Seed for the random number generator.", "name": "seed" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "''", "description": "The title of the game. Shown in the browser console.", "name": "title" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'https://phaser.io'", "description": "The URL of the game. Shown in the browser console.", "name": "url" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "''", "description": "The version of the game. Shown in the browser console.", "name": "version" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "Phaser.Types.Core.InputConfig" } ] } }, "optional": true, "description": "Input configuration, or `false` to disable all game input.", "name": "input" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "Phaser.Types.Core.BannerConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.DOMContainerConfig" } }, "optional": true, "description": "The DOM Container configuration object.", "name": "dom" }, { "type": { "names": [ "Phaser.Types.Core.FPSConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.FPSConfig" } }, "optional": true, "description": "Game loop configuration.", "name": "fps" }, { "type": { "names": [ "Phaser.Types.Core.RenderConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.RenderConfig" } }, "optional": true, "description": "Game renderer configuration.", "name": "render" }, { "type": { "names": [ "Phaser.Types.Core.CallbacksConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.CallbacksConfig" } }, "optional": true, "description": "Optional callbacks to run before or after game boot.", "name": "callbacks" }, { "type": { "names": [ "Phaser.Types.Core.LoaderConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.LoaderConfig" } }, "optional": true, "description": "Loader configuration.", "name": "loader" }, { "type": { "names": [ "Phaser.Types.Core.ImagesConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.ImagesConfig" } }, "optional": true, "description": "Images configuration.", "name": "images" }, { "type": { "names": [ "Phaser.Types.Core.PhysicsConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.PhysicsConfig" } }, "optional": true, "description": "Physics configuration.", "name": "physics" }, { "type": { "names": [ "Phaser.Types.Core.PluginObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Core.PluginObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Core.PluginObjectItem", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Plugins to install.", "name": "plugins" }, { "type": { "names": [ "Phaser.Types.Core.ScaleConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.ScaleConfig" } }, "optional": true, "description": "The Scale Manager configuration.", "name": "scale" }, { "type": { "names": [ "Phaser.Types.Core.AudioConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Core.AudioConfig" } }, "optional": true, "description": "The Audio Configuration object.", "name": "audio" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The background color of the game canvas. The default is black.", "name": "backgroundColor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Sets `antialias` to false and `roundPixels` to true. This is the best setting for pixel-art games.", "name": "pixelArt" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "WebGL only. Sets `antialias` to true and `pixelArt` to false. Texture-based Game Objects use special shader setting that preserve blocky pixels, but smooth the edges between the pixels. This is only visible when objects are scaled up; otherwise, `antialias` is simpler.", "name": "smoothPixelArt" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "On textured objects with lighting, this enables self-shadowing based on the diffuse map.", "name": "selfShadow" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Threshold for combining points into a single path in the WebGL renderer for Graphics objects. This can be overridden at the Graphics object level.", "name": "pathDetailThreshold" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether the game canvas will be cleared between each rendering frame.", "name": "clearBeforeRender" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If the value is true the WebGL buffers will not be cleared and will preserve their values until cleared or overwritten by the author.", "name": "preserveDrawingBuffer" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "In WebGL mode, the drawing buffer contains colors with pre-multiplied alpha.", "name": "premultipliedAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Avert stuttering during shader compilation, by enabling parallel shader compilation, where supported. Objects which request a shader that is not yet ready will not be drawn. This prevents stutter, but may cause \"pop-in\" of objects unless you use a pre-touch strategy.", "name": "skipUnreadyShaders" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 16384, "description": "The default WebGL batch size. Represents the number of _quads_ that can be added to a single batch.", "name": "batchSize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": -1, "description": "When in WebGL mode, this sets the maximum number of GPU Textures to use. The default, -1, will use all available units. The WebGL1 spec says all browsers should provide a minimum of 8.", "name": "maxTextures" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'LINEAR'", "description": "The mipmap magFilter to be used when creating WebGL textures.", "name": "mipmapFilter" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to regenerate mipmaps for framebuffers.", "name": "mipmapRegeneration" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If iOS or Android detected, automatically restrict WebGL to use 1 texture per batch. This can help performance on some devices.", "name": "autoMobileTextures" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.ScaleModeType" } }, "optional": true, "defaultvalue": "Phaser.Scale.ScaleModes.NONE", "description": "The scale mode.", "name": "mode" }, { "type": { "names": [ "WidthHeight" ], "parsedType": { "type": "NameExpression", "name": "WidthHeight" } }, "optional": true, "description": "The minimum width and height the canvas can be scaled down to.", "name": "min" }, { "type": { "names": [ "WidthHeight" ], "parsedType": { "type": "NameExpression", "name": "WidthHeight" } }, "optional": true, "description": "The maximum width the canvas can be scaled up to.", "name": "max" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.CenterType" } }, "optional": true, "defaultvalue": "Phaser.Scale.Center.NO_CENTER", "description": "Automatically center the canvas within the parent?", "name": "autoCenter" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 500, "description": "How many ms should elapse before checking if the browser size has changed?", "name": "resizeInterval" }, { "type": { "names": [ "HTMLElement", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLElement" }, { "type": "NameExpression", "name": "string" } ], "nullable": true } }, "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.GameConfig", "scope": "static", "___id": "T000002R003650", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.GamepadInputConfig\r\n * @since 3.0.0\r\n *\r\n * @property {*} [target=window] - Where the Gamepad Manager listens for gamepad input events.\r\n */", "meta": { "filename": "GamepadInputConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "GamepadInputConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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", "___id": "T000002R003651", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.ImagesConfig\r\n * @since 3.0.0\r\n *\r\n * @property {(string|undefined|null)} [default] - A base64 encoded image file to use as the 'default' texture.\r\n * @property {(string|undefined|null)} [missing] - A base64 encoded image file to use as the 'missing' texture.\r\n * @property {(string|undefined|null)} [white] - A base64 encoded image file to use as the 'white' texture.\r\n */", "meta": { "filename": "ImagesConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "ImagesConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string", "undefined", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" }, { "type": "NullLiteral" } ] } }, "optional": true, "description": "A base64 encoded image file to use as the 'default' texture.", "name": "default" }, { "type": { "names": [ "string", "undefined", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" }, { "type": "NullLiteral" } ] } }, "optional": true, "description": "A base64 encoded image file to use as the 'missing' texture.", "name": "missing" }, { "type": { "names": [ "string", "undefined", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" }, { "type": "NullLiteral" } ] } }, "optional": true, "description": "A base64 encoded image file to use as the 'white' texture.", "name": "white" } ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.ImagesConfig", "scope": "static", "___id": "T000002R003652", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Core\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "namespace", "name": "Core", "memberof": "Phaser.Types", "longname": "Phaser.Types.Core", "scope": "static", "___id": "T000002R003653", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.InputConfig\r\n * @since 3.0.0\r\n *\r\n * @property {(boolean|Phaser.Types.Core.KeyboardInputConfig)} [keyboard=true] - Keyboard input configuration. `true` uses the default configuration and `false` disables keyboard input.\r\n * @property {(boolean|Phaser.Types.Core.MouseInputConfig)} [mouse=true] - Mouse input configuration. `true` uses the default configuration and `false` disables mouse input.\r\n * @property {(boolean|Phaser.Types.Core.TouchInputConfig)} [touch=true] - Touch input configuration. `true` uses the default configuration and `false` disables touch input.\r\n * @property {(boolean|Phaser.Types.Core.GamepadInputConfig)} [gamepad=false] - Gamepad input configuration. `true` enables gamepad input.\r\n * @property {number} [activePointers=1] - The maximum number of touch pointers. See {@link Phaser.Input.InputManager#pointers}.\r\n * @property {number} [smoothFactor=0] - The smoothing factor to apply during Pointer movement. See {@link Phaser.Input.Pointer#smoothFactor}.\r\n * @property {boolean} [windowEvents=true] - Should Phaser listen for input events on the Window? If you disable this, events like 'POINTER_UP_OUTSIDE' will no longer fire.\r\n */", "meta": { "filename": "InputConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "InputConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean", "Phaser.Types.Core.KeyboardInputConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "Phaser.Types.Core.GamepadInputConfig" } ] } }, "optional": true, "defaultvalue": false, "description": "Gamepad input configuration. `true` enables gamepad input.", "name": "gamepad" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The maximum number of touch pointers. See {@link Phaser.Input.InputManager#pointers}.", "name": "activePointers" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003654", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.KeyboardInputConfig\r\n * @since 3.0.0\r\n *\r\n * @property {*} [target=window] - Where the Keyboard Manager listens for keyboard input events.\r\n * @property {?number[]} [capture] - `preventDefault` will be called on every non-modified key which has a key code in this array. By default it is empty.\r\n */", "meta": { "filename": "KeyboardInputConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "KeyboardInputConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "defaultvalue": "window", "description": "Where the Keyboard Manager listens for keyboard input events.", "name": "target" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ], "nullable": true } }, "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", "___id": "T000002R003655", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.LoaderConfig\r\n * @since 3.0.0\r\n *\r\n * @property {string} [baseURL] - A URL used to resolve paths given to the loader. Example: 'http://labs.phaser.io/assets/'.\r\n * @property {string} [path] - A URL path used to resolve relative paths given to the loader. Example: 'images/sprites/'.\r\n * @property {number} [maxParallelDownloads=32] - The maximum number of resources the loader will start loading at once.\r\n * @property {(string|undefined)} [crossOrigin=undefined] - '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}.\r\n * @property {string} [responseType] - The response type of the XHR request, e.g. `blob`, `text`, etc.\r\n * @property {boolean} [async=true] - Should the XHR request use async or not?\r\n * @property {string} [user] - Optional username for all XHR requests.\r\n * @property {string} [password] - Optional password for all XHR requests.\r\n * @property {number} [timeout=0] - Optional XHR timeout value, in ms.\r\n * @property {string[]} [localScheme] - An optional array of schemes that the Loader considers as being 'local' files. Defaults to: `[ 'file://', 'capacitor://' ]` if not specified.\r\n * @property {boolean} [withCredentials=false] - Optional XHR withCredentials value.\r\n * @property {string} [imageLoadType='XHR'] - Optional load type for image, `XHR` is default, or `HTMLImageElement` for a lightweight way.\r\n * @property {number} [maxRetries=2] - The number of times to retry the file load if it fails.\r\n */", "meta": { "filename": "LoaderConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "LoaderConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "A URL path used to resolve relative paths given to the loader. Example: 'images/sprites/'.", "name": "path" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The maximum number of resources the loader will start loading at once.", "name": "maxParallelDownloads" }, { "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The response type of the XHR request, e.g. `blob`, `text`, etc.", "name": "responseType" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the XHR request use async or not?", "name": "async" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional username for all XHR requests.", "name": "user" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional password for all XHR requests.", "name": "password" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional XHR timeout value, in ms.", "name": "timeout" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of schemes that the Loader considers as being 'local' files. Defaults to: `[ 'file://', 'capacitor://' ]` if not specified.", "name": "localScheme" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optional XHR withCredentials value.", "name": "withCredentials" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'XHR'", "description": "Optional load type for image, `XHR` is default, or `HTMLImageElement` for a lightweight way.", "name": "imageLoadType" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "The number of times to retry the file load if it fails.", "name": "maxRetries" } ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.LoaderConfig", "scope": "static", "___id": "T000002R003656", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.MouseInputConfig\r\n * @since 3.0.0\r\n *\r\n * @property {*} [target=null] - Where the Mouse Manager listens for mouse input events. The default is the game canvas.\r\n * @property {boolean} [preventDefaultDown=true] - If `true` the DOM `mousedown` event will have `preventDefault` set.\r\n * @property {boolean} [preventDefaultUp=true] - If `true` the DOM `mouseup` event will have `preventDefault` set.\r\n * @property {boolean} [preventDefaultMove=true] - If `true` the DOM `mousemove` event will have `preventDefault` set.\r\n * @property {boolean} [preventDefaultWheel=true] - If `true` the DOM `wheel` event will have `preventDefault` set.\r\n */", "meta": { "filename": "MouseInputConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "MouseInputConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If `true` the DOM `mousedown` event will have `preventDefault` set.", "name": "preventDefaultDown" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If `true` the DOM `mouseup` event will have `preventDefault` set.", "name": "preventDefaultUp" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If `true` the DOM `mousemove` event will have `preventDefault` set.", "name": "preventDefaultMove" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If `true` the DOM `wheel` event will have `preventDefault` set.", "name": "preventDefaultWheel" } ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.MouseInputConfig", "scope": "static", "___id": "T000002R003657", "___s": true }, { "comment": "/**\r\n * This callback type is completely empty, a no-operation.\r\n *\r\n * @callback Phaser.Types.Core.NOOP\r\n * @since 3.0.0\r\n */", "meta": { "filename": "NOOP.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "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", "___id": "T000002R003658", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.PhysicsConfig\r\n * @since 3.0.0\r\n *\r\n * @property {string} [default] - The default physics system. It will be started for each scene. Phaser provides 'arcade', 'impact', and 'matter'.\r\n * @property {Phaser.Types.Physics.Arcade.ArcadeWorldConfig} [arcade] - Arcade Physics configuration.\r\n * @property {Phaser.Types.Physics.Matter.MatterWorldConfig} [matter] - Matter Physics configuration.\r\n */", "meta": { "filename": "PhysicsConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "PhysicsConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Arcade.ArcadeWorldConfig" } }, "optional": true, "description": "Arcade Physics configuration.", "name": "arcade" }, { "type": { "names": [ "Phaser.Types.Physics.Matter.MatterWorldConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Physics.Matter.MatterWorldConfig" } }, "optional": true, "description": "Matter Physics configuration.", "name": "matter" } ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.PhysicsConfig", "scope": "static", "___id": "T000002R003659", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.PluginObject\r\n * @since 3.8.0\r\n *\r\n * @property {?Phaser.Types.Core.PluginObjectItem[]} [global] - Global plugins to install.\r\n * @property {?Phaser.Types.Core.PluginObjectItem[]} [scene] - Scene plugins to install.\r\n * @property {string[]} [default] - The default set of scene plugins (names).\r\n * @property {string[]} [defaultMerge] - Plugins to *add* to the default set of scene plugins.\r\n */", "meta": { "filename": "PluginObject.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "PluginObject", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.8.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Core.PluginObjectItem", "type": "NameExpression" } ], "nullable": true } }, "optional": true, "nullable": true, "description": "Global plugins to install.", "name": "global" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Core.PluginObjectItem", "type": "NameExpression" } ], "nullable": true } }, "optional": true, "nullable": true, "description": "Scene plugins to install.", "name": "scene" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "optional": true, "description": "The default set of scene plugins (names).", "name": "default" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "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", "___id": "T000002R003660", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.PluginObjectItem\r\n * @since 3.8.0\r\n *\r\n * @property {string} [key] - A key to identify the plugin in the Plugin Manager.\r\n * @property {*} [plugin] - The plugin itself. Usually a class/constructor.\r\n * @property {boolean} [start] - Whether the plugin should be started automatically.\r\n * @property {string} [systemKey] - For a scene plugin, add the plugin to the scene's systems object under this key (`this.sys.KEY`, from the scene).\r\n * @property {string} [sceneKey] - For a scene plugin, add the plugin to the scene object under this key (`this.KEY`, from the scene).\r\n * @property {string} [mapping] - If this plugin is to be injected into the Scene Systems, this is the property key map used.\r\n * @property {*} [data] - Arbitrary data passed to the plugin's init() method.\r\n *\r\n * @example\r\n * // Global plugin\r\n * { key: 'BankPlugin', plugin: BankPluginV3, start: true, data: { gold: 5000 } }\r\n * @example\r\n * // Scene plugin\r\n * { key: 'WireFramePlugin', plugin: WireFramePlugin, systemKey: 'wireFramePlugin', sceneKey: 'wireframe' }\r\n */", "meta": { "filename": "PluginObjectItem.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "PluginObjectItem", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.8.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "A key to identify the plugin in the Plugin Manager.", "name": "key" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The plugin itself. Usually a class/constructor.", "name": "plugin" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether the plugin should be started automatically.", "name": "start" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "Arbitrary data passed to the plugin's init() method.", "name": "data" } ], "examples": [ "// Global plugin\r{ key: 'BankPlugin', plugin: BankPluginV3, start: true, data: { gold: 5000 } }", "// Scene plugin\r{ key: 'WireFramePlugin', plugin: WireFramePlugin, systemKey: 'wireFramePlugin', sceneKey: 'wireframe' }" ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.PluginObjectItem", "scope": "static", "___id": "T000002R003661", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.RenderConfig\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} [antialias=true] - 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.\r\n * @property {boolean} [antialiasGL=true] - 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.\r\n * @property {boolean} [desynchronized=false] - 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.\r\n * @property {boolean} [pixelArt=false] - Sets `antialias` to false and `roundPixels` to true. This is the best setting for pixel-art games.\r\n * @property {boolean} [smoothPixelArt=false] - WebGL only. Sets `antialias` to true and `pixelArt` to false. Texture-based Game Objects use special shader setting that preserve blocky pixels, but smooth the edges between the pixels. This is only visible when objects are scaled up; otherwise, `antialias` is simpler.\r\n * @property {boolean} [roundPixels=false] - Draw texture-based Game Objects at only whole-integer positions. Game Objects without textures, like Graphics, ignore this property.\r\n * @property {boolean} [selfShadow=false] - On textured objects with lighting, this enables self-shadowing based on the diffuse map.\r\n * @property {number} [pathDetailThreshold=1] - Threshold for combining points into a single path in the WebGL renderer for Graphics objects. This can be overridden at the Graphics object level.\r\n * @property {boolean} [transparent=false] - 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.\r\n * @property {'keep'|'dither'|number} [alphaStrategy='keep'] - The default alpha strategy to use when rendering transparent objects with compatible shaders. Strategies other than `keep` will discard fragments instead of turning them transparent, which creates a very grainy look.\r\n * @property {boolean} [stencil=true] - Whether to enable stencil testing. Disabling this will prevent creation of stencil buffers, which can save framebuffer memory. Disabling stencil prevents the use of stencil-based rendering.\r\n * @property {'keep'|'dither'|number} [stencilAlphaStrategy='dither'] - The default alpha strategy to use when rendering stencils. Keeping transparent pixels still creates opaque stencil, which is usually not what you want.\r\n * @property {boolean} [clearBeforeRender=true] - Whether the game canvas will be cleared between each rendering frame.\r\n * @property {boolean} [preserveDrawingBuffer=false] - If the value is true the WebGL buffers will not be cleared and will preserve their values until cleared or overwritten by the author.\r\n * @property {boolean} [premultipliedAlpha=true] - In WebGL mode, the drawing buffer contains colors with pre-multiplied alpha.\r\n * @property {boolean} [skipUnreadyShaders=false] - Avert stuttering during shader compilation, by enabling parallel shader compilation, where supported. Objects which request a shader that is not yet ready will not be drawn. This prevents stutter, but may cause \"pop-in\" of objects unless you use a pre-touch strategy.\r\n * @property {boolean} [failIfMajorPerformanceCaveat=false] - Let the browser abort creating a WebGL context if it judges performance would be unacceptable.\r\n * @property {string} [powerPreference='default'] - \"high-performance\", \"low-power\" or \"default\". A hint to the browser on how much device power the game might use.\r\n * @property {number} [batchSize=16384] - The default WebGL batch size. Represents the number of _quads_ that can be added to a single batch.\r\n * @property {number} [maxLights=10] - The maximum number of lights allowed to be visible within range of a single Camera in the LightManager.\r\n * @property {number} [maxTextures=-1] - When in WebGL mode, this sets the maximum number of GPU Textures to use. The default, -1, will use all available units. The WebGL1 spec says all browsers should provide a minimum of 8.\r\n * @property {string} [mipmapFilter=''] - The mipmap magFilter to be used when creating WebGL textures. Don't set unless you wish to create mipmaps. Set to one of the following: 'NEAREST', 'LINEAR', 'NEAREST_MIPMAP_NEAREST', 'LINEAR_MIPMAP_NEAREST', 'NEAREST_MIPMAP_LINEAR' or 'LINEAR_MIPMAP_LINEAR'.\r\n * @property {boolean} [mipmapRegeneration=false] - Whether to regenerate mipmaps for framebuffers. If this is false, framebuffers will not use mipmaps. If this is true, framebuffers will use the `mipmapFilter` setting, and regenerate mipmaps if redrawn. This affects filters and DynamicTextures. Mipmap generation is expensive (10 microseconds or more per texture), so be careful with this setting.\r\n * @property {boolean} [autoMobileTextures=true] - If iOS or Android detected, automatically restrict WebGL to use 1 texture per batch. This can help performance on some devices.\r\n * @property {Object} [renderNodes] - A map of custom Render Nodes to be added to the WebGL Renderer. The values will be added to the RenderNodeManager, using the keys as the names.\r\n */", "meta": { "filename": "RenderConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "RenderConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Sets `antialias` to false and `roundPixels` to true. This is the best setting for pixel-art games.", "name": "pixelArt" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "WebGL only. Sets `antialias` to true and `pixelArt` to false. Texture-based Game Objects use special shader setting that preserve blocky pixels, but smooth the edges between the pixels. This is only visible when objects are scaled up; otherwise, `antialias` is simpler.", "name": "smoothPixelArt" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "On textured objects with lighting, this enables self-shadowing based on the diffuse map.", "name": "selfShadow" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Threshold for combining points into a single path in the WebGL renderer for Graphics objects. This can be overridden at the Graphics object level.", "name": "pathDetailThreshold" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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": [ "'keep'", "'dither'", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "'keep'" }, { "type": "NameExpression", "name": "'dither'" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": "'keep'", "description": "The default alpha strategy to use when rendering transparent objects with compatible shaders. Strategies other than `keep` will discard fragments instead of turning them transparent, which creates a very grainy look.", "name": "alphaStrategy" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether to enable stencil testing. Disabling this will prevent creation of stencil buffers, which can save framebuffer memory. Disabling stencil prevents the use of stencil-based rendering.", "name": "stencil" }, { "type": { "names": [ "'keep'", "'dither'", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "'keep'" }, { "type": "NameExpression", "name": "'dither'" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": "'dither'", "description": "The default alpha strategy to use when rendering stencils. Keeping transparent pixels still creates opaque stencil, which is usually not what you want.", "name": "stencilAlphaStrategy" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether the game canvas will be cleared between each rendering frame.", "name": "clearBeforeRender" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If the value is true the WebGL buffers will not be cleared and will preserve their values until cleared or overwritten by the author.", "name": "preserveDrawingBuffer" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "In WebGL mode, the drawing buffer contains colors with pre-multiplied alpha.", "name": "premultipliedAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Avert stuttering during shader compilation, by enabling parallel shader compilation, where supported. Objects which request a shader that is not yet ready will not be drawn. This prevents stutter, but may cause \"pop-in\" of objects unless you use a pre-touch strategy.", "name": "skipUnreadyShaders" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 16384, "description": "The default WebGL batch size. Represents the number of _quads_ that can be added to a single batch.", "name": "batchSize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": -1, "description": "When in WebGL mode, this sets the maximum number of GPU Textures to use. The default, -1, will use all available units. The WebGL1 spec says all browsers should provide a minimum of 8.", "name": "maxTextures" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "''", "description": "The mipmap magFilter to be used when creating WebGL textures. Don't set unless you wish to create mipmaps. Set to one of the following: 'NEAREST', 'LINEAR', 'NEAREST_MIPMAP_NEAREST', 'LINEAR_MIPMAP_NEAREST', 'NEAREST_MIPMAP_LINEAR' or 'LINEAR_MIPMAP_LINEAR'.", "name": "mipmapFilter" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to regenerate mipmaps for framebuffers. If this is false, framebuffers will not use mipmaps. If this is true, framebuffers will use the `mipmapFilter` setting, and regenerate mipmaps if redrawn. This affects filters and DynamicTextures. Mipmap generation is expensive (10 microseconds or more per texture), so be careful with this setting.", "name": "mipmapRegeneration" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If iOS or Android detected, automatically restrict WebGL to use 1 texture per batch. This can help performance on some devices.", "name": "autoMobileTextures" }, { "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "Phaser.Types.Core.RenderNodesConfig" } ] } }, "optional": true, "description": "A map of custom Render Nodes to be added to the WebGL Renderer. The values will be added to the RenderNodeManager, using the keys as the names.", "name": "renderNodes" } ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.RenderConfig", "scope": "static", "___id": "T000002R003662", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.RenderNodesConfig\r\n * @since 4.0.0\r\n *\r\n * @property {string} [key] - A key to be used as the name of the RenderNode.\r\n * @property {*} [function] - The Render Node function itself.\r\n */", "meta": { "filename": "RenderNodesConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "RenderNodesConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "A key to be used as the name of the RenderNode.", "name": "key" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The Render Node function itself.", "name": "function" } ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.RenderNodesConfig", "scope": "static", "___id": "T000002R003663", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.ScaleConfig\r\n * @since 3.16.0\r\n *\r\n * @property {(number|string)} [width=1024] - 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.\r\n * @property {(number|string)} [height=768] - 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.\r\n * @property {(Phaser.Scale.ZoomType|number)} [zoom=1] - The zoom value of the game canvas.\r\n * @property {?(HTMLElement|string)} [parent] - 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.\r\n * @property {boolean} [expandParent=true] - Is the Scale Manager allowed to adjust the CSS height property of the parent and/or document body to be 100%?\r\n * @property {Phaser.Scale.ScaleModeType} [mode=Phaser.Scale.ScaleModes.NONE] - The scale mode.\r\n * @property {WidthHeight} [min] - The minimum width and height the canvas can be scaled down to.\r\n * @property {WidthHeight} [max] - The maximum width the canvas can be scaled up to.\r\n * @property {WidthHeight} [snap] - Set the snapping values used by the Scale Manager when resizing the canvas. See `ScaleManager.setSnap` for details.\r\n * @property {boolean} [autoRound=false] - Automatically round the display and style sizes of the canvas. This can help with performance in lower-powered devices.\r\n * @property {Phaser.Scale.CenterType} [autoCenter=Phaser.Scale.Center.NO_CENTER] - Automatically center the canvas within the parent?\r\n * @property {number} [resizeInterval=500] - How many ms should elapse before checking if the browser size has changed?\r\n * @property {?(HTMLElement|string)} [fullscreenTarget] - 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.\r\n */", "meta": { "filename": "ScaleConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "ScaleConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.16.0", "properties": [ { "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "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": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "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", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Scale.ZoomType" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": 1, "description": "The zoom value of the game canvas.", "name": "zoom" }, { "type": { "names": [ "HTMLElement", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLElement" }, { "type": "NameExpression", "name": "string" } ], "nullable": true } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.ScaleModeType" } }, "optional": true, "defaultvalue": "Phaser.Scale.ScaleModes.NONE", "description": "The scale mode.", "name": "mode" }, { "type": { "names": [ "WidthHeight" ], "parsedType": { "type": "NameExpression", "name": "WidthHeight" } }, "optional": true, "description": "The minimum width and height the canvas can be scaled down to.", "name": "min" }, { "type": { "names": [ "WidthHeight" ], "parsedType": { "type": "NameExpression", "name": "WidthHeight" } }, "optional": true, "description": "The maximum width the canvas can be scaled up to.", "name": "max" }, { "type": { "names": [ "WidthHeight" ], "parsedType": { "type": "NameExpression", "name": "WidthHeight" } }, "optional": true, "description": "Set the snapping values used by the Scale Manager when resizing the canvas. See `ScaleManager.setSnap` for details.", "name": "snap" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.CenterType" } }, "optional": true, "defaultvalue": "Phaser.Scale.Center.NO_CENTER", "description": "Automatically center the canvas within the parent?", "name": "autoCenter" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 500, "description": "How many ms should elapse before checking if the browser size has changed?", "name": "resizeInterval" }, { "type": { "names": [ "HTMLElement", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLElement" }, { "type": "NameExpression", "name": "string" } ], "nullable": true } }, "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", "___id": "T000002R003664", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Core.TimeStepCallback\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.\r\n * @param {number} average - The Delta average.\r\n */", "meta": { "filename": "TimeStepCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "TimeStepCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Delta average.", "name": "average" } ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.TimeStepCallback", "scope": "static", "___id": "T000002R003665", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.TouchInputConfig\r\n * @since 3.0.0\r\n *\r\n * @property {*} [target=null] - Where the Touch Manager listens for touch input events. The default is the game canvas.\r\n * @property {boolean} [capture=true] - Whether touch input events have preventDefault() called on them.\r\n */", "meta": { "filename": "TouchInputConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "TouchInputConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003666", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Core.WidthHeight\r\n * @since 3.16.0\r\n *\r\n * @property {number} [width=0] - The width.\r\n * @property {number} [height=0] - The height.\r\n */", "meta": { "filename": "WidthHeight.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core\\typedefs", "code": {} }, "kind": "typedef", "name": "WidthHeight", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.16.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The width.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The height.", "name": "height" } ], "memberof": "Phaser.Types.Core", "longname": "Phaser.Types.Core.WidthHeight", "scope": "static", "___id": "T000002R003667", "___s": true }, { "comment": "/**\r\n * The Visibility Handler is responsible for listening for document-level visibility change events and\r\n * window blur/focus events, then re-emitting them through the Game's Event Emitter so that the rest of\r\n * the framework can respond appropriately — for example, pausing the game loop when the player switches\r\n * tabs or minimizes the browser window, and resuming it when they return.\r\n *\r\n * It listens for the standard `visibilitychange` event where supported, and falls back to vendor-prefixed\r\n * equivalents (`webkitvisibilitychange`, `mozvisibilitychange`, `msvisibilitychange`) for older browsers.\r\n * Window-level `blur` and `focus` events are also captured to handle cases where the tab remains visible\r\n * but the window loses focus.\r\n *\r\n * If the game configuration has `autoFocus` enabled, the handler will also call `window.focus()` during\r\n * setup to ensure the game captures keyboard input immediately on load.\r\n *\r\n * @function Phaser.Core.VisibilityHandler\r\n * @fires Phaser.Core.Events#BLUR\r\n * @fires Phaser.Core.Events#FOCUS\r\n * @fires Phaser.Core.Events#HIDDEN\r\n * @fires Phaser.Core.Events#VISIBLE\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - The Game instance this Visibility Handler is working on.\r\n */", "meta": { "filename": "VisibilityHandler.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\core", "code": {} }, "description": "The Visibility Handler is responsible for listening for document-level visibility change events and\rwindow blur/focus events, then re-emitting them through the Game's Event Emitter so that the rest of\rthe framework can respond appropriately — for example, pausing the game loop when the player switches\rtabs or minimizes the browser window, and resuming it when they return.\r\rIt listens for the standard `visibilitychange` event where supported, and falls back to vendor-prefixed\requivalents (`webkitvisibilitychange`, `mozvisibilitychange`, `msvisibilitychange`) for older browsers.\rWindow-level `blur` and `focus` events are also captured to handle cases where the tab remains visible\rbut the window loses focus.\r\rIf the game configuration has `autoFocus` enabled, the handler will also call `window.focus()` during\rsetup to ensure the game captures keyboard input immediately on load.", "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "The Game instance this Visibility Handler is working on.", "name": "game" } ], "memberof": "Phaser.Core", "longname": "Phaser.Core.VisibilityHandler", "scope": "static", "___id": "T000002R003669", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Cubic Bézier curve is a smooth parametric curve defined by four points: a start point (`p0`),\r\n * two control points (`p1` and `p2`) that shape the curvature, and an end point (`p3`). The curve\r\n * passes through `p0` and `p3` but is only pulled toward the control points, allowing you to create\r\n * a wide variety of smooth, flowing shapes.\r\n *\r\n * Cubic Bézier curves are commonly used in Phaser for defining movement paths, animating objects\r\n * along arcs, and building complex `Path` objects. You can sample any position along the curve\r\n * using a normalised `t` value from 0 (start) to 1 (end), or use the inherited helper methods such\r\n * as `getPoints` and `getSpacedPoints` to obtain evenly distributed coordinates for rendering or\r\n * movement.\r\n *\r\n * @class CubicBezier\r\n * @extends Phaser.Curves.Curve\r\n * @memberof Phaser.Curves\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|Phaser.Math.Vector2[])} p0 - Start point, or an array of point pairs.\r\n * @param {Phaser.Math.Vector2} p1 - Control Point 1.\r\n * @param {Phaser.Math.Vector2} p2 - Control Point 2.\r\n * @param {Phaser.Math.Vector2} p3 - End Point.\r\n */", "meta": { "filename": "CubicBezierCurve.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "classdesc": "A Cubic Bézier curve is a smooth parametric curve defined by four points: a start point (`p0`),\rtwo control points (`p1` and `p2`) that shape the curvature, and an end point (`p3`). The curve\rpasses through `p0` and `p3` but is only pulled toward the control points, allowing you to create\ra wide variety of smooth, flowing shapes.\r\rCubic Bézier curves are commonly used in Phaser for defining movement paths, animating objects\ralong arcs, and building complex `Path` objects. You can sample any position along the curve\rusing a normalised `t` value from 0 (start) to 1 (end), or use the inherited helper methods such\ras `getPoints` and `getSpacedPoints` to obtain evenly distributed coordinates for rendering or\rmovement.", "kind": "class", "name": "CubicBezier", "augments": [ "Phaser.Curves.Curve" ], "memberof": "Phaser.Curves", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } ] } }, "description": "Start point, or an array of point pairs.", "name": "p0" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "Control Point 1.", "name": "p1" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "Control Point 2.", "name": "p2" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "End Point.", "name": "p3" } ], "scope": "static", "longname": "Phaser.Curves.CubicBezier", "___id": "T000002R003685", "___s": true }, { "comment": "/**\r\n * The start point of this curve.\r\n *\r\n * @name Phaser.Curves.CubicBezier#p0\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CubicBezierCurve.js", "lineno": 56, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The start point of this curve.", "name": "p0", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Curves.CubicBezier", "longname": "Phaser.Curves.CubicBezier#p0", "scope": "instance", "kind": "member", "___id": "T000002R003693", "___s": true }, { "comment": "/**\r\n * The first control point of this curve.\r\n *\r\n * @name Phaser.Curves.CubicBezier#p1\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CubicBezierCurve.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The first control point of this curve.", "name": "p1", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Curves.CubicBezier", "longname": "Phaser.Curves.CubicBezier#p1", "scope": "instance", "kind": "member", "___id": "T000002R003695", "___s": true }, { "comment": "/**\r\n * The second control point of this curve.\r\n *\r\n * @name Phaser.Curves.CubicBezier#p2\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CubicBezierCurve.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The second control point of this curve.", "name": "p2", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Curves.CubicBezier", "longname": "Phaser.Curves.CubicBezier#p2", "scope": "instance", "kind": "member", "___id": "T000002R003697", "___s": true }, { "comment": "/**\r\n * The end point of this curve.\r\n *\r\n * @name Phaser.Curves.CubicBezier#p3\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CubicBezierCurve.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The end point of this curve.", "name": "p3", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Curves.CubicBezier", "longname": "Phaser.Curves.CubicBezier#p3", "scope": "instance", "kind": "member", "___id": "T000002R003699", "___s": true }, { "comment": "/**\r\n * Gets the starting point on the curve.\r\n *\r\n * @method Phaser.Curves.CubicBezier#getStartPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.\r\n */", "meta": { "filename": "CubicBezierCurve.js", "lineno": 93, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Gets the starting point on the curve.", "kind": "function", "name": "getStartPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003701", "___s": true }, { "comment": "/**\r\n * Returns the resolution of this curve, which is the number of points used to approximate it when calculating lengths or sampling. For a Cubic Bézier, the resolution is equal to the number of divisions requested.\r\n *\r\n * @method Phaser.Curves.CubicBezier#getResolution\r\n * @since 3.0.0\r\n *\r\n * @param {number} divisions - The amount of divisions used by this curve.\r\n *\r\n * @return {number} The resolution of the curve.\r\n */", "meta": { "filename": "CubicBezierCurve.js", "lineno": 112, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Returns the resolution of this curve, which is the number of points used to approximate it when calculating lengths or sampling. For a Cubic Bézier, the resolution is equal to the number of divisions requested.", "kind": "function", "name": "getResolution", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of divisions used by this curve.", "name": "divisions" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resolution of the curve." } ], "memberof": "Phaser.Curves.CubicBezier", "longname": "Phaser.Curves.CubicBezier#getResolution", "scope": "instance", "___id": "T000002R003704", "___s": true }, { "comment": "/**\r\n * Calculates the coordinates of the point at the given normalised position (`t`) along this curve using cubic Bézier interpolation.\r\n *\r\n * @method Phaser.Curves.CubicBezier#getPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} t - The position along the curve to return. Where 0 is the start and 1 is the end.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.\r\n */", "meta": { "filename": "CubicBezierCurve.js", "lineno": 127, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Calculates the coordinates of the point at the given normalised position (`t`) along this curve using cubic Bézier interpolation.", "kind": "function", "name": "getPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003706", "___s": true }, { "comment": "/**\r\n * Draws this curve to the specified graphics object.\r\n *\r\n * @method Phaser.Curves.CubicBezier#draw\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.Graphics} G - [graphics,$return]\r\n *\r\n * @param {Phaser.GameObjects.Graphics} graphics - The graphics object this curve should be drawn to.\r\n * @param {number} [pointsTotal=32] - The number of intermediary points that make up this curve. A higher number of points will result in a smoother curve.\r\n *\r\n * @return {Phaser.GameObjects.Graphics} The graphics object this curve was drawn to. Useful for method chaining.\r\n */", "meta": { "filename": "CubicBezierCurve.js", "lineno": 152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Draws this curve to the specified graphics object.", "kind": "function", "name": "draw", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.Graphics} G - [graphics,$return]", "value": "{Phaser.GameObjects.Graphics} G - [graphics,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The graphics object this curve should be drawn to.", "name": "graphics" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003713", "___s": true }, { "comment": "/**\r\n * Returns a JSON object that describes this curve.\r\n *\r\n * @method Phaser.Curves.CubicBezier#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.Curves.JSONCurve} The JSON object containing this curve data.\r\n */", "meta": { "filename": "CubicBezierCurve.js", "lineno": 185, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Returns a JSON object that describes this curve.", "kind": "function", "name": "toJSON", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.Curves.JSONCurve" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Curves.JSONCurve" } }, "description": "The JSON object containing this curve data." } ], "memberof": "Phaser.Curves.CubicBezier", "longname": "Phaser.Curves.CubicBezier#toJSON", "scope": "instance", "___id": "T000002R003718", "___s": true }, { "comment": "/**\r\n * Generates a curve from a JSON object.\r\n *\r\n * @function Phaser.Curves.CubicBezier.fromJSON\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Curves.JSONCurve} data - The JSON object containing this curve data.\r\n *\r\n * @return {Phaser.Curves.CubicBezier} The curve generated from the JSON object.\r\n */", "meta": { "filename": "CubicBezierCurve.js", "lineno": 208, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Generates a curve from a JSON object.", "kind": "function", "name": "fromJSON", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Curves.JSONCurve" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Curves.JSONCurve" } }, "description": "The JSON object containing this curve data.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Curves.CubicBezier" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Curves.CubicBezier" } }, "description": "The curve generated from the JSON object." } ], "memberof": "Phaser.Curves.CubicBezier", "longname": "Phaser.Curves.CubicBezier.fromJSON", "scope": "static", "___id": "T000002R003722", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Base Curve class, which all other curve types extend.\r\n *\r\n * A Curve represents a mathematical path through 2D space and provides methods for\r\n * sampling points, calculating arc lengths, and obtaining tangent vectors along it.\r\n * Curves are the building blocks of `Phaser.Curves.Path`, which allows Game Objects\r\n * to follow complex routes through a scene.\r\n *\r\n * This class is not intended to be instantiated directly. Instead, use one of the\r\n * concrete subclasses in the `Phaser.Curves` namespace, such as `LineCurve`,\r\n * `QuadraticBezier`, `CubicBezier`, `EllipseCurve`, or `SplineCurve`.\r\n *\r\n * Based on the three.js Curve classes created by [zz85](http://www.lab4games.net/zz85/blog)\r\n *\r\n * @class Curve\r\n * @memberof Phaser.Curves\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {string} type - The curve type.\r\n */", "meta": { "filename": "Curve.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "classdesc": "A Base Curve class, which all other curve types extend.\r\rA Curve represents a mathematical path through 2D space and provides methods for\rsampling points, calculating arc lengths, and obtaining tangent vectors along it.\rCurves are the building blocks of `Phaser.Curves.Path`, which allows Game Objects\rto follow complex routes through a scene.\r\rThis class is not intended to be instantiated directly. Instead, use one of the\rconcrete subclasses in the `Phaser.Curves` namespace, such as `LineCurve`,\r`QuadraticBezier`, `CubicBezier`, `EllipseCurve`, or `SplineCurve`.\r\rBased 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The curve type.", "name": "type" } ], "scope": "static", "longname": "Phaser.Curves.Curve", "___id": "T000002R003734", "___s": true }, { "comment": "/**\r\n * String based identifier for the type of curve.\r\n *\r\n * @name Phaser.Curves.Curve#type\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Curve.js", "lineno": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "String based identifier for the type of curve.", "name": "type", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#type", "scope": "instance", "kind": "member", "___id": "T000002R003737", "___s": true }, { "comment": "/**\r\n * The default number of divisions within the curve.\r\n *\r\n * @name Phaser.Curves.Curve#defaultDivisions\r\n * @type {number}\r\n * @default 5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Curve.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The default number of divisions within the curve.", "name": "defaultDivisions", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "5", "since": "3.0.0", "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#defaultDivisions", "scope": "instance", "kind": "member", "___id": "T000002R003739", "___s": true }, { "comment": "/**\r\n * The quantity of arc length divisions within the curve.\r\n *\r\n * @name Phaser.Curves.Curve#arcLengthDivisions\r\n * @type {number}\r\n * @default 100\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Curve.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The quantity of arc length divisions within the curve.", "name": "arcLengthDivisions", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "100", "since": "3.0.0", "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#arcLengthDivisions", "scope": "instance", "kind": "member", "___id": "T000002R003741", "___s": true }, { "comment": "/**\r\n * An array of cached arc length values.\r\n *\r\n * @name Phaser.Curves.Curve#cacheArcLengths\r\n * @type {number[]}\r\n * @default []\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Curve.js", "lineno": 69, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "An array of cached arc length values.", "name": "cacheArcLengths", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#cacheArcLengths", "scope": "instance", "kind": "member", "___id": "T000002R003743", "___s": true }, { "comment": "/**\r\n * Does the data of this curve need updating?\r\n *\r\n * @name Phaser.Curves.Curve#needsUpdate\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Curve.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Does the data of this curve need updating?", "name": "needsUpdate", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#needsUpdate", "scope": "instance", "kind": "member", "___id": "T000002R003745", "___s": true }, { "comment": "/**\r\n * For a curve on a Path, `false` means the Path will ignore this curve.\r\n *\r\n * @name Phaser.Curves.Curve#active\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Curve.js", "lineno": 89, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "For a curve on a Path, `false` means the Path will ignore this curve.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#active", "scope": "instance", "kind": "member", "___id": "T000002R003747", "___s": true }, { "comment": "/**\r\n * Draws this curve on the given Graphics object.\r\n *\r\n * The curve is drawn using `Graphics.strokePoints` so will be drawn at whatever the present Graphics stroke color is.\r\n * The Graphics object is not cleared before the draw, so the curve will appear on-top of anything else already rendered to it.\r\n *\r\n * @method Phaser.Curves.Curve#draw\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.Graphics} G - [graphics,$return]\r\n *\r\n * @param {Phaser.GameObjects.Graphics} graphics - The Graphics instance onto which this curve will be drawn.\r\n * @param {number} [pointsTotal=32] - The resolution of the curve. The higher the value the smoother it will render, at the cost of rendering performance.\r\n *\r\n * @return {Phaser.GameObjects.Graphics} The Graphics object to which the curve was drawn.\r\n */", "meta": { "filename": "Curve.js", "lineno": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Draws this curve on the given Graphics object.\r\rThe curve is drawn using `Graphics.strokePoints` so will be drawn at whatever the present Graphics stroke color is.\rThe 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.Graphics} G - [graphics,$return]", "value": "{Phaser.GameObjects.Graphics} G - [graphics,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics instance onto which this curve will be drawn.", "name": "graphics" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object to which the curve was drawn." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#draw", "scope": "instance", "___id": "T000002R003753", "___s": true }, { "comment": "/**\r\n * Returns a Rectangle where the position and dimensions match the bounds of this Curve.\r\n *\r\n * You can control the accuracy of the bounds. The value given is used to work out how many points\r\n * to plot across the curve. Higher values are more accurate at the cost of calculation speed.\r\n *\r\n * @method Phaser.Curves.Curve#getBounds\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} [out] - The Rectangle to store the bounds in. If falsey a new object will be created.\r\n * @param {number} [accuracy=16] - The accuracy of the bounds calculations.\r\n *\r\n * @return {Phaser.Geom.Rectangle} A Rectangle object holding the bounds of this curve. If `out` was given it will be this object.\r\n */", "meta": { "filename": "Curve.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Returns a Rectangle where the position and dimensions match the bounds of this Curve.\r\rYou can control the accuracy of the bounds. The value given is used to work out how many points\rto 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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 16, "description": "The accuracy of the bounds calculations.", "name": "accuracy" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003756", "___s": true }, { "comment": "/**\r\n * Returns an array of points, spaced out X distance pixels apart.\r\n * The smaller the distance, the larger the array will be.\r\n *\r\n * @method Phaser.Curves.Curve#getDistancePoints\r\n * @since 3.0.0\r\n *\r\n * @param {number} distance - The distance, in pixels, between each point along the curve.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An Array of Vector2 objects.\r\n */", "meta": { "filename": "Curve.js", "lineno": 178, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Returns an array of points, spaced out X distance pixels apart.\rThe smaller the distance, the larger the array will be.", "kind": "function", "name": "getDistancePoints", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance, in pixels, between each point along the curve.", "name": "distance" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An Array of Vector2 objects." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getDistancePoints", "scope": "instance", "___id": "T000002R003763", "___s": true }, { "comment": "/**\r\n * Get a point at the end of the curve.\r\n *\r\n * @method Phaser.Curves.Curve#getEndPoint\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector2} [out] - Optional Vector object to store the result in.\r\n *\r\n * @return {Phaser.Math.Vector2} Vector2 containing the coordinates of the curve's end point.\r\n */", "meta": { "filename": "Curve.js", "lineno": 198, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get a point at the end of the curve.", "kind": "function", "name": "getEndPoint", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "Optional Vector object to store the result in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "Vector2 containing the coordinates of the curve's end point." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getEndPoint", "scope": "instance", "___id": "T000002R003767", "___s": true }, { "comment": "/**\r\n * Returns the total arc length of the curve, in pixels. The length is calculated by summing the distances between sampled points along the curve.\r\n *\r\n * @method Phaser.Curves.Curve#getLength\r\n * @since 3.0.0\r\n *\r\n * @return {number} The total length of the curve.\r\n */", "meta": { "filename": "Curve.js", "lineno": 215, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Returns the total arc length of the curve, in pixels. The length is calculated by summing the distances between sampled points along the curve.", "kind": "function", "name": "getLength", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total length of the curve." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getLength", "scope": "instance", "___id": "T000002R003770", "___s": true }, { "comment": "/**\r\n * Get a list of cumulative segment lengths.\r\n *\r\n * These lengths are calculated and cached the first time this method is called.\r\n *\r\n * - [0] 0\r\n * - [1] The first segment\r\n * - [2] The first and second segment\r\n * - ...\r\n * - [divisions] All segments\r\n *\r\n * @method Phaser.Curves.Curve#getLengths\r\n * @since 3.0.0\r\n *\r\n * @param {number} [divisions] - The number of divisions or segments.\r\n *\r\n * @return {number[]} An array of cumulative lengths.\r\n */", "meta": { "filename": "Curve.js", "lineno": 231, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get a list of cumulative segment lengths.\r\rThese lengths are calculated and cached the first time this method is called.\r\r- [0] 0\r- [1] The first segment\r- [2] The first and second segment\r- ...\r- [divisions] All segments", "kind": "function", "name": "getLengths", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The number of divisions or segments.", "name": "divisions" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array of cumulative lengths." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getLengths", "scope": "instance", "___id": "T000002R003773", "___s": true }, { "comment": "/**\r\n * Get a point at a relative position on the curve, by arc length.\r\n *\r\n * @method Phaser.Curves.Curve#getPointAt\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} u - The relative position, [0..1].\r\n * @param {Phaser.Math.Vector2} [out] - A point to store the result in.\r\n *\r\n * @return {Phaser.Math.Vector2} The point.\r\n */", "meta": { "filename": "Curve.js", "lineno": 287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get a point at a relative position on the curve, by arc length.", "kind": "function", "name": "getPointAt", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The relative position, [0..1].", "name": "u" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A point to store the result in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getPointAt", "scope": "instance", "___id": "T000002R003785", "___s": true }, { "comment": "/**\r\n * Get a sequence of evenly spaced points from the curve.\r\n *\r\n * You can pass `divisions`, `stepRate`, or neither.\r\n *\r\n * The number of divisions will be\r\n *\r\n * 1. `divisions`, if `divisions` > 0; or\r\n * 2. `this.getLength / stepRate`, if `stepRate` > 0; or\r\n * 3. `this.defaultDivisions`\r\n *\r\n * `1 + divisions` points will be returned.\r\n *\r\n * @method Phaser.Curves.Curve#getPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2[]} O - [out,$return]\r\n *\r\n * @param {number} [divisions] - The number of divisions to make.\r\n * @param {number} [stepRate] - The curve distance between points, implying `divisions`.\r\n * @param {Phaser.Math.Vector2[]} [out] - An optional array to store the points in.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2 points from the curve.\r\n */", "meta": { "filename": "Curve.js", "lineno": 309, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get a sequence of evenly spaced points from the curve.\r\rYou can pass `divisions`, `stepRate`, or neither.\r\rThe number of divisions will be\r\r1. `divisions`, if `divisions` > 0; or\r2. `this.getLength / stepRate`, if `stepRate` > 0; or\r3. `this.defaultDivisions`\r\r`1 + divisions` points will be returned.", "kind": "function", "name": "getPoints", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [out,$return]", "value": "{Phaser.Math.Vector2[]} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The number of divisions to make.", "name": "divisions" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The curve distance between points, implying `divisions`.", "name": "stepRate" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array to store the points in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2 points from the curve." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getPoints", "scope": "instance", "___id": "T000002R003788", "___s": true }, { "comment": "/**\r\n * Get a random point from the curve.\r\n *\r\n * @method Phaser.Curves.Curve#getRandomPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [out] - A point object to store the result in.\r\n *\r\n * @return {Phaser.Math.Vector2} The point.\r\n */", "meta": { "filename": "Curve.js", "lineno": 358, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get a random point from the curve.", "kind": "function", "name": "getRandomPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A point object to store the result in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getRandomPoint", "scope": "instance", "___id": "T000002R003794", "___s": true }, { "comment": "/**\r\n * Get a sequence of equally spaced points (by arc distance) from the curve.\r\n *\r\n * `1 + divisions` points will be returned.\r\n *\r\n * @method Phaser.Curves.Curve#getSpacedPoints\r\n * @since 3.0.0\r\n *\r\n * @param {number} [divisions=this.defaultDivisions] - The number of divisions to make.\r\n * @param {number} [stepRate] - Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.\r\n * @param {Phaser.Math.Vector2[]} [out] - An optional array to store the points in.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2 points.\r\n */", "meta": { "filename": "Curve.js", "lineno": 379, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get a sequence of equally spaced points (by arc distance) from the curve.\r\r`1 + divisions` points will be returned.", "kind": "function", "name": "getSpacedPoints", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.defaultDivisions", "description": "The number of divisions to make.", "name": "divisions" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array to store the points in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2 points." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getSpacedPoints", "scope": "instance", "___id": "T000002R003797", "___s": true }, { "comment": "/**\r\n * Get a point at the start of the curve.\r\n *\r\n * @method Phaser.Curves.Curve#getStartPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [out] - A point to store the result in.\r\n *\r\n * @return {Phaser.Math.Vector2} The point.\r\n */", "meta": { "filename": "Curve.js", "lineno": 420, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get a point at the start of the curve.", "kind": "function", "name": "getStartPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A point to store the result in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getStartPoint", "scope": "instance", "___id": "T000002R003804", "___s": true }, { "comment": "/**\r\n * Get a unit vector tangent at a relative position on the curve.\r\n * If a subclass does not override this method with an analytic tangent derivation,\r\n * the tangent is approximated by sampling two points a small delta apart and\r\n * computing the normalized direction vector between them.\r\n *\r\n * @method Phaser.Curves.Curve#getTangent\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} t - The relative position on the curve, [0..1].\r\n * @param {Phaser.Math.Vector2} [out] - A vector to store the result in.\r\n *\r\n * @return {Phaser.Math.Vector2} Vector approximating the tangent line at the point t (delta +/- 0.0001)\r\n */", "meta": { "filename": "Curve.js", "lineno": 439, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get a unit vector tangent at a relative position on the curve.\rIf a subclass does not override this method with an analytic tangent derivation,\rthe tangent is approximated by sampling two points a small delta apart and\rcomputing the normalized direction vector between them.", "kind": "function", "name": "getTangent", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The relative position on the curve, [0..1].", "name": "t" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A vector to store the result in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003807", "___s": true }, { "comment": "/**\r\n * Get a unit vector tangent at a relative position on the curve, by arc length.\r\n *\r\n * @method Phaser.Curves.Curve#getTangentAt\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} u - The relative position on the curve, [0..1].\r\n * @param {Phaser.Math.Vector2} [out] - A vector to store the result in.\r\n *\r\n * @return {Phaser.Math.Vector2} The tangent vector.\r\n */", "meta": { "filename": "Curve.js", "lineno": 481, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get a unit vector tangent at a relative position on the curve, by arc length.", "kind": "function", "name": "getTangentAt", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The relative position on the curve, [0..1].", "name": "u" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A vector to store the result in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The tangent vector." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getTangentAt", "scope": "instance", "___id": "T000002R003815", "___s": true }, { "comment": "/**\r\n * Given a distance in pixels along the curve, returns the corresponding t parameter value that can be used with `getPoint()` to find the position at that distance. This gives you equidistant points along the curve.\r\n *\r\n * @method Phaser.Curves.Curve#getTFromDistance\r\n * @since 3.0.0\r\n *\r\n * @param {number} distance - The distance, in pixels.\r\n * @param {number} [divisions] - Optional amount of divisions.\r\n *\r\n * @return {number} The t value (between 0 and 1) at the given distance along the curve.\r\n */", "meta": { "filename": "Curve.js", "lineno": 501, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Given a distance in pixels along the curve, returns the corresponding t parameter value that can be used with `getPoint()` to find the position at that distance. This gives you equidistant points along the curve.", "kind": "function", "name": "getTFromDistance", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance, in pixels.", "name": "distance" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional amount of divisions.", "name": "divisions" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The t value (between 0 and 1) at the given distance along the curve." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getTFromDistance", "scope": "instance", "___id": "T000002R003818", "___s": true }, { "comment": "/**\r\n * Maps a uniform parameter u (0 to 1, distributed evenly by arc length) to the raw curve parameter t. This mapping ensures that points sampled at regular intervals of u will be equidistant along the curve, unlike the raw t parameter which may produce uneven spacing.\r\n *\r\n * @method Phaser.Curves.Curve#getUtoTmapping\r\n * @since 3.0.0\r\n *\r\n * @param {number} u - A float between 0 and 1.\r\n * @param {number} distance - The distance, in pixels.\r\n * @param {number} [divisions] - Optional amount of divisions.\r\n *\r\n * @return {number} The equidistant value.\r\n */", "meta": { "filename": "Curve.js", "lineno": 522, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Maps a uniform parameter u (0 to 1, distributed evenly by arc length) to the raw curve parameter t. This mapping ensures that points sampled at regular intervals of u will be equidistant along the curve, unlike the raw t parameter which may produce uneven spacing.", "kind": "function", "name": "getUtoTmapping", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A float between 0 and 1.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance, in pixels.", "name": "distance" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional amount of divisions.", "name": "divisions" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The equidistant value." } ], "memberof": "Phaser.Curves.Curve", "longname": "Phaser.Curves.Curve#getUtoTmapping", "scope": "instance", "___id": "T000002R003820", "___s": true }, { "comment": "/**\r\n * Calculate and cache the arc lengths.\r\n *\r\n * @method Phaser.Curves.Curve#updateArcLengths\r\n * @since 3.0.0\r\n *\r\n * @see Phaser.Curves.Curve#getLengths()\r\n */", "meta": { "filename": "Curve.js", "lineno": 603, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "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", "___id": "T000002R003841", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An Ellipse Curve is a smooth curve that describes the path of an ellipse. It can be used\r\n * to move Game Objects along an elliptical path, generate points distributed around an ellipse,\r\n * or draw elliptical arcs as part of a Path or Graphics object.\r\n *\r\n * You can control the center position, horizontal and vertical radii, start and end angles,\r\n * rotation, and whether the curve runs clockwise or anti-clockwise. Passing only `xRadius`\r\n * will create a circle (both radii are equal by default).\r\n *\r\n * This curve extends the base `Phaser.Curves.Curve` class and can be used anywhere a Curve\r\n * is accepted in Phaser, such as `Phaser.Curves.Path` or a `PathFollower` Game Object.\r\n *\r\n * See https://en.wikipedia.org/wiki/Ellipse for more details.\r\n *\r\n * @class Ellipse\r\n * @extends Phaser.Curves.Curve\r\n * @memberof Phaser.Curves\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {(number|Phaser.Types.Curves.EllipseCurveConfig)} [x=0] - The x coordinate of the ellipse, or an Ellipse Curve configuration object.\r\n * @param {number} [y=0] - The y coordinate of the ellipse.\r\n * @param {number} [xRadius=0] - The horizontal radius of ellipse.\r\n * @param {number} [yRadius=0] - The vertical radius of ellipse.\r\n * @param {number} [startAngle=0] - The start angle of the ellipse, in degrees.\r\n * @param {number} [endAngle=360] - The end angle of the ellipse, in degrees.\r\n * @param {boolean} [clockwise=false] - Whether the ellipse angles are given as clockwise (`true`) or counter-clockwise (`false`).\r\n * @param {number} [rotation=0] - The rotation of the ellipse, in degrees.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "classdesc": "An Ellipse Curve is a smooth curve that describes the path of an ellipse. It can be used\rto move Game Objects along an elliptical path, generate points distributed around an ellipse,\ror draw elliptical arcs as part of a Path or Graphics object.\r\rYou can control the center position, horizontal and vertical radii, start and end angles,\rrotation, and whether the curve runs clockwise or anti-clockwise. Passing only `xRadius`\rwill create a circle (both radii are equal by default).\r\rThis curve extends the base `Phaser.Curves.Curve` class and can be used anywhere a Curve\ris accepted in Phaser, such as `Phaser.Curves.Path` or a `PathFollower` Game Object.\r\rSee https://en.wikipedia.org/wiki/Ellipse 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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the ellipse.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal radius of ellipse.", "name": "xRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical radius of ellipse.", "name": "yRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The start angle of the ellipse, in degrees.", "name": "startAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 360, "description": "The end angle of the ellipse, in degrees.", "name": "endAngle" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether the ellipse angles are given as clockwise (`true`) or counter-clockwise (`false`).", "name": "clockwise" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of the ellipse, in degrees.", "name": "rotation" } ], "scope": "static", "longname": "Phaser.Curves.Ellipse", "___id": "T000002R003851", "___s": true }, { "comment": "/**\r\n * The center point of the ellipse. Used for calculating rotation.\r\n *\r\n * @name Phaser.Curves.Ellipse#p0\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The center point of the ellipse. Used for calculating rotation.", "name": "p0", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#p0", "scope": "instance", "kind": "member", "___id": "T000002R003869", "___s": true }, { "comment": "/**\r\n * Gets the starting point on the curve.\r\n *\r\n * @method Phaser.Curves.Ellipse#getStartPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Gets the starting point on the curve.", "kind": "function", "name": "getStartPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003883", "___s": true }, { "comment": "/**\r\n * Returns the resolution of this curve, which is the number of points used to approximate it. For an Ellipse, this is double the requested divisions to provide accurate arc length calculations.\r\n *\r\n * @method Phaser.Curves.Ellipse#getResolution\r\n * @since 3.0.0\r\n *\r\n * @param {number} divisions - Optional divisions value.\r\n *\r\n * @return {number} The curve resolution.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 171, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Returns the resolution of this curve, which is the number of points used to approximate it. For an Ellipse, this is double the requested divisions to provide accurate arc length calculations.", "kind": "function", "name": "getResolution", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Optional divisions value.", "name": "divisions" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The curve resolution." } ], "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#getResolution", "scope": "instance", "___id": "T000002R003886", "___s": true }, { "comment": "/**\r\n * Returns the point on this curve at the given normalized position `t`, where 0 is the start and 1 is the end. The result accounts for the start angle, end angle, clockwise direction, and rotation of the ellipse.\r\n *\r\n * @method Phaser.Curves.Ellipse#getPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} t - The position along the curve to return. Where 0 is the start and 1 is the end.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 186, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Returns the point on this curve at the given normalized position `t`, where 0 is the start and 1 is the end. The result accounts for the start angle, end angle, clockwise direction, and rotation of the ellipse.", "kind": "function", "name": "getPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R003888", "___s": true }, { "comment": "/**\r\n * Sets the horizontal radius of this curve.\r\n *\r\n * @method Phaser.Curves.Ellipse#setXRadius\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The horizontal radius of this curve.\r\n *\r\n * @return {this} This curve object.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Sets the horizontal radius of this curve.", "kind": "function", "name": "setXRadius", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal radius of this curve.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This curve object." } ], "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#setXRadius", "scope": "instance", "___id": "T000002R003909", "___s": true }, { "comment": "/**\r\n * Sets the vertical radius of this curve.\r\n *\r\n * @method Phaser.Curves.Ellipse#setYRadius\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The vertical radius of this curve.\r\n *\r\n * @return {this} This curve object.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 279, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Sets the vertical radius of this curve.", "kind": "function", "name": "setYRadius", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical radius of this curve.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This curve object." } ], "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#setYRadius", "scope": "instance", "___id": "T000002R003912", "___s": true }, { "comment": "/**\r\n * Sets the width of this curve. The horizontal radius (`xRadius`) is set to half the given value.\r\n *\r\n * @method Phaser.Curves.Ellipse#setWidth\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The width of this curve.\r\n *\r\n * @return {this} This curve object.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 296, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Sets the width of this curve. The horizontal radius (`xRadius`) is set to half the given value.", "kind": "function", "name": "setWidth", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this curve.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This curve object." } ], "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#setWidth", "scope": "instance", "___id": "T000002R003915", "___s": true }, { "comment": "/**\r\n * Sets the height of this curve. The vertical radius (`yRadius`) is set to half the given value.\r\n *\r\n * @method Phaser.Curves.Ellipse#setHeight\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The height of this curve.\r\n *\r\n * @return {this} This curve object.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 313, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Sets the height of this curve. The vertical radius (`yRadius`) is set to half the given value.", "kind": "function", "name": "setHeight", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this curve.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This curve object." } ], "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#setHeight", "scope": "instance", "___id": "T000002R003918", "___s": true }, { "comment": "/**\r\n * Sets the start angle of this curve.\r\n *\r\n * @method Phaser.Curves.Ellipse#setStartAngle\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The start angle of this curve, in degrees.\r\n *\r\n * @return {this} This curve object.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Sets the start angle of this curve.", "kind": "function", "name": "setStartAngle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The start angle of this curve, in degrees.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This curve object." } ], "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#setStartAngle", "scope": "instance", "___id": "T000002R003921", "___s": true }, { "comment": "/**\r\n * Sets the end angle of this curve.\r\n *\r\n * @method Phaser.Curves.Ellipse#setEndAngle\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The end angle of this curve, in degrees.\r\n *\r\n * @return {this} This curve object.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 347, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Sets the end angle of this curve.", "kind": "function", "name": "setEndAngle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The end angle of this curve, in degrees.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This curve object." } ], "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#setEndAngle", "scope": "instance", "___id": "T000002R003924", "___s": true }, { "comment": "/**\r\n * Sets if this curve extends clockwise or anti-clockwise.\r\n *\r\n * @method Phaser.Curves.Ellipse#setClockwise\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - The clockwise state of this curve.\r\n *\r\n * @return {this} This curve object.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 364, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Sets if this curve extends clockwise or anti-clockwise.", "kind": "function", "name": "setClockwise", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The clockwise state of this curve.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This curve object." } ], "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#setClockwise", "scope": "instance", "___id": "T000002R003927", "___s": true }, { "comment": "/**\r\n * Sets the rotation of this curve.\r\n *\r\n * @method Phaser.Curves.Ellipse#setRotation\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The rotation of this curve, in radians.\r\n *\r\n * @return {this} This curve object.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 381, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Sets the rotation of this curve.", "kind": "function", "name": "setRotation", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rotation of this curve, in radians.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This curve object." } ], "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#setRotation", "scope": "instance", "___id": "T000002R003930", "___s": true }, { "comment": "/**\r\n * The x coordinate of the center of the ellipse.\r\n *\r\n * @name Phaser.Curves.Ellipse#x\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 398, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The x coordinate of the center of the ellipse.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#x", "scope": "instance", "kind": "member", "___id": "T000002R003933", "___s": true }, { "comment": "/**\r\n * The y coordinate of the center of the ellipse.\r\n *\r\n * @name Phaser.Curves.Ellipse#y\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 419, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The y coordinate of the center of the ellipse.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#y", "scope": "instance", "kind": "member", "___id": "T000002R003938", "___s": true }, { "comment": "/**\r\n * The horizontal radius of the ellipse.\r\n *\r\n * @name Phaser.Curves.Ellipse#xRadius\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 440, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The horizontal radius of the ellipse.", "name": "xRadius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#xRadius", "scope": "instance", "kind": "member", "___id": "T000002R003943", "___s": true }, { "comment": "/**\r\n * The vertical radius of the ellipse.\r\n *\r\n * @name Phaser.Curves.Ellipse#yRadius\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 461, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The vertical radius of the ellipse.", "name": "yRadius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#yRadius", "scope": "instance", "kind": "member", "___id": "T000002R003948", "___s": true }, { "comment": "/**\r\n * The start angle of the ellipse in degrees.\r\n *\r\n * @name Phaser.Curves.Ellipse#startAngle\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 482, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The start angle of the ellipse in degrees.", "name": "startAngle", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#startAngle", "scope": "instance", "kind": "member", "___id": "T000002R003953", "___s": true }, { "comment": "/**\r\n * The end angle of the ellipse in degrees.\r\n *\r\n * @name Phaser.Curves.Ellipse#endAngle\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 503, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The end angle of the ellipse in degrees.", "name": "endAngle", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#endAngle", "scope": "instance", "kind": "member", "___id": "T000002R003958", "___s": true }, { "comment": "/**\r\n * `true` if the ellipse rotation is clockwise or `false` if anti-clockwise.\r\n *\r\n * @name Phaser.Curves.Ellipse#clockwise\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 524, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "`true` if the ellipse rotation is clockwise or `false` if anti-clockwise.", "name": "clockwise", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#clockwise", "scope": "instance", "kind": "member", "___id": "T000002R003963", "___s": true }, { "comment": "/**\r\n * The rotation of the ellipse, relative to the center, in degrees.\r\n *\r\n * @name Phaser.Curves.Ellipse#angle\r\n * @type {number}\r\n * @since 3.14.0\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 545, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The rotation of the ellipse, relative to the center, in degrees.", "name": "angle", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.14.0", "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#angle", "scope": "instance", "kind": "member", "___id": "T000002R003968", "___s": true }, { "comment": "/**\r\n * The rotation of the ellipse, relative to the center, in radians.\r\n *\r\n * @name Phaser.Curves.Ellipse#rotation\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 566, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The rotation of the ellipse, relative to the center, in radians.", "name": "rotation", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#rotation", "scope": "instance", "kind": "member", "___id": "T000002R003973", "___s": true }, { "comment": "/**\r\n * JSON serialization of the curve.\r\n *\r\n * @method Phaser.Curves.Ellipse#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.Curves.JSONEllipseCurve} The JSON object containing this curve data.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "JSON serialization of the curve.", "kind": "function", "name": "toJSON", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.Curves.JSONEllipseCurve" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Curves.JSONEllipseCurve" } }, "description": "The JSON object containing this curve data." } ], "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse#toJSON", "scope": "instance", "___id": "T000002R003978", "___s": true }, { "comment": "/**\r\n * Creates a curve from the provided Ellipse Curve Configuration object.\r\n *\r\n * @function Phaser.Curves.Ellipse.fromJSON\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Curves.JSONEllipseCurve} data - The JSON object containing this curve data.\r\n *\r\n * @return {Phaser.Curves.Ellipse} The ellipse curve constructed from the configuration object.\r\n */", "meta": { "filename": "EllipseCurve.js", "lineno": 612, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Curves.JSONEllipseCurve" } }, "description": "The JSON object containing this curve data.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Curves.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Curves.Ellipse" } }, "description": "The ellipse curve constructed from the configuration object." } ], "memberof": "Phaser.Curves.Ellipse", "longname": "Phaser.Curves.Ellipse.fromJSON", "scope": "static", "___id": "T000002R003989", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Curves\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "kind": "namespace", "name": "Curves", "memberof": "Phaser", "longname": "Phaser.Curves", "scope": "static", "___id": "T000002R003992", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A LineCurve is a straight line segment defined by exactly two endpoints. Despite being called a\r\n * \"curve\", it implements the full `Phaser.Curves.Curve` interface, meaning it can be used anywhere\r\n * a curve is expected — for example, as part of a `Phaser.Curves.Path` or as a motion path for a\r\n * Tween. Because the line is perfectly straight, arc length calculations are exact and efficient,\r\n * making LineCurve the most performant curve type. You can construct one from two `Vector2` points\r\n * or from a flat array of four numbers `[x0, y0, x1, y1]`.\r\n *\r\n * @class Line\r\n * @extends Phaser.Curves.Curve\r\n * @memberof Phaser.Curves\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|number[])} p0 - The first endpoint.\r\n * @param {Phaser.Math.Vector2} [p1] - The second endpoint.\r\n */", "meta": { "filename": "LineCurve.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "classdesc": "A LineCurve is a straight line segment defined by exactly two endpoints. Despite being called a\r\"curve\", it implements the full `Phaser.Curves.Curve` interface, meaning it can be used anywhere\ra curve is expected — for example, as part of a `Phaser.Curves.Path` or as a motion path for a\rTween. Because the line is perfectly straight, arc length calculations are exact and efficient,\rmaking LineCurve the most performant curve type. You can construct one from two `Vector2` points\ror from a flat array of four numbers `[x0, y0, x1, y1]`.", "kind": "class", "name": "Line", "augments": [ "Phaser.Curves.Curve" ], "memberof": "Phaser.Curves", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "description": "The first endpoint.", "name": "p0" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "The second endpoint.", "name": "p1" } ], "scope": "static", "longname": "Phaser.Curves.Line", "___id": "T000002R004007", "___s": true }, { "comment": "/**\r\n * The first endpoint.\r\n *\r\n * @name Phaser.Curves.Line#p0\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LineCurve.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The first endpoint.", "name": "p0", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Line", "longname": "Phaser.Curves.Line#p0", "scope": "instance", "kind": "member", "___id": "T000002R004013", "___s": true }, { "comment": "/**\r\n * The second endpoint.\r\n *\r\n * @name Phaser.Curves.Line#p1\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LineCurve.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The second endpoint.", "name": "p1", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Line", "longname": "Phaser.Curves.Line#p1", "scope": "instance", "kind": "member", "___id": "T000002R004015", "___s": true }, { "comment": "/**\r\n * The quantity of arc length divisions within the curve.\r\n *\r\n * @name Phaser.Curves.Line#arcLengthDivisions\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LineCurve.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The quantity of arc length divisions within the curve.", "name": "arcLengthDivisions", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Curves.Line", "longname": "Phaser.Curves.Line#arcLengthDivisions", "scope": "instance", "kind": "member", "overrides": "Phaser.Curves.Curve#arcLengthDivisions", "___id": "T000002R004017", "___s": true }, { "comment": "/**\r\n * Returns a Rectangle where the position and dimensions match the bounds of this Curve.\r\n *\r\n * @method Phaser.Curves.Line#getBounds\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} [out] - A Rectangle object to store the bounds in. If not given a new Rectangle will be created.\r\n *\r\n * @return {Phaser.Geom.Rectangle} A Rectangle object holding the bounds of this curve. If `out` was given it will be this object.\r\n */", "meta": { "filename": "LineCurve.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Returns a Rectangle where the position and dimensions match the bounds of this Curve.", "kind": "function", "name": "getBounds", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [out,$return]", "value": "{Phaser.Geom.Rectangle} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004019", "___s": true }, { "comment": "/**\r\n * Gets the starting point on the curve.\r\n *\r\n * @method Phaser.Curves.Line#getStartPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.\r\n */", "meta": { "filename": "LineCurve.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Gets the starting point on the curve.", "kind": "function", "name": "getStartPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004022", "___s": true }, { "comment": "/**\r\n * Returns the resolution of this curve. For a LineCurve the resolution is equal to the number of divisions requested, defaulting to 1 if none are provided.\r\n *\r\n * @method Phaser.Curves.Line#getResolution\r\n * @since 3.0.0\r\n *\r\n * @param {number} [divisions=1] - The number of divisions to consider.\r\n *\r\n * @return {number} The resolution. Equal to the number of divisions.\r\n */", "meta": { "filename": "LineCurve.js", "lineno": 119, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Returns the resolution of this curve. For a LineCurve the resolution is equal to the number of divisions requested, defaulting to 1 if none are provided.", "kind": "function", "name": "getResolution", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The number of divisions to consider.", "name": "divisions" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resolution. Equal to the number of divisions." } ], "memberof": "Phaser.Curves.Line", "longname": "Phaser.Curves.Line#getResolution", "scope": "instance", "___id": "T000002R004025", "___s": true }, { "comment": "/**\r\n * Gets a point at a relative position along the line, where 0 is the start point and 1 is the end point.\r\n *\r\n * @method Phaser.Curves.Line#getPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} t - The position along the curve to return. Where 0 is the start and 1 is the end.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.\r\n */", "meta": { "filename": "LineCurve.js", "lineno": 136, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Gets a point at a relative position along the line, where 0 is the start point and 1 is the end point.", "kind": "function", "name": "getPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004028", "___s": true }, { "comment": "/**\r\n * Gets a point at a given position on the line.\r\n *\r\n * @method Phaser.Curves.Line#getPointAt\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} u - The position along the curve to return. Where 0 is the start and 1 is the end.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.\r\n */", "meta": { "filename": "LineCurve.js", "lineno": 165, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Gets a point at a given position on the line.", "kind": "function", "name": "getPointAt", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004031", "___s": true }, { "comment": "/**\r\n * Gets the slope of the line as a unit vector.\r\n *\r\n * @method Phaser.Curves.Line#getTangent\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} [t] - The relative position on the line, [0..1].\r\n * @param {Phaser.Math.Vector2} [out] - A vector to store the result in.\r\n *\r\n * @return {Phaser.Math.Vector2} The tangent vector.\r\n */", "meta": { "filename": "LineCurve.js", "lineno": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Gets the slope of the line as a unit vector.", "kind": "function", "name": "getTangent", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The relative position on the line, [0..1].", "name": "t" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A vector to store the result in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The tangent vector." } ], "memberof": "Phaser.Curves.Line", "longname": "Phaser.Curves.Line#getTangent", "scope": "instance", "overrides": "Phaser.Curves.Curve#getTangent", "___id": "T000002R004033", "___s": true }, { "comment": "/**\r\n * Converts a distance-based position along the line into a normalized `t` value in the range 0 to 1.\r\n * If a `distance` is provided, the returned `t` represents that distance clamped to the line's total length.\r\n * If no distance is given, `u` is returned directly. This override exists because a straight line has\r\n * uniform arc length, so no iterative re-parameterization is needed.\r\n *\r\n * @method Phaser.Curves.Line#getUtoTmapping\r\n * @since 3.0.0\r\n *\r\n * @param {number} u - A float between 0 and 1.\r\n * @param {number} distance - The distance, in pixels.\r\n * @param {number} [divisions] - Optional amount of divisions.\r\n *\r\n * @return {number} The equidistant value.\r\n */", "meta": { "filename": "LineCurve.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Converts a distance-based position along the line into a normalized `t` value in the range 0 to 1.\rIf a `distance` is provided, the returned `t` represents that distance clamped to the line's total length.\rIf no distance is given, `u` is returned directly. This override exists because a straight line has\runiform arc length, so no iterative re-parameterization is needed.", "kind": "function", "name": "getUtoTmapping", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A float between 0 and 1.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance, in pixels.", "name": "distance" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional amount of divisions.", "name": "divisions" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The equidistant value." } ], "memberof": "Phaser.Curves.Line", "longname": "Phaser.Curves.Line#getUtoTmapping", "scope": "instance", "overrides": "Phaser.Curves.Curve#getUtoTmapping", "___id": "T000002R004036", "___s": true }, { "comment": "/**\r\n * Draws this curve on the given Graphics object.\r\n *\r\n * The curve is drawn using `Graphics.lineBetween` so will be drawn at whatever the present Graphics line color is.\r\n * The Graphics object is not cleared before the draw, so the curve will appear on-top of anything else already rendered to it.\r\n *\r\n * @method Phaser.Curves.Line#draw\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.Graphics} G - [graphics,$return]\r\n *\r\n * @param {Phaser.GameObjects.Graphics} graphics - The Graphics instance onto which this curve will be drawn.\r\n *\r\n * @return {Phaser.GameObjects.Graphics} The Graphics object to which the curve was drawn.\r\n */", "meta": { "filename": "LineCurve.js", "lineno": 244, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Draws this curve on the given Graphics object.\r\rThe curve is drawn using `Graphics.lineBetween` so will be drawn at whatever the present Graphics line color is.\rThe 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.Graphics} G - [graphics,$return]", "value": "{Phaser.GameObjects.Graphics} G - [graphics,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics instance onto which this curve will be drawn.", "name": "graphics" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004044", "___s": true }, { "comment": "/**\r\n * Gets a JSON representation of the line.\r\n *\r\n * @method Phaser.Curves.Line#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.Curves.JSONCurve} The JSON object containing this curve data.\r\n */", "meta": { "filename": "LineCurve.js", "lineno": 267, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Gets a JSON representation of the line.", "kind": "function", "name": "toJSON", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.Curves.JSONCurve" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Curves.JSONCurve" } }, "description": "The JSON object containing this curve data." } ], "memberof": "Phaser.Curves.Line", "longname": "Phaser.Curves.Line#toJSON", "scope": "instance", "___id": "T000002R004046", "___s": true }, { "comment": "/**\r\n * Configures this line from a JSON representation.\r\n *\r\n * @function Phaser.Curves.Line.fromJSON\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Curves.JSONCurve} data - The JSON object containing this curve data.\r\n *\r\n * @return {Phaser.Curves.Line} A new LineCurve object.\r\n */", "meta": { "filename": "LineCurve.js", "lineno": 288, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Configures this line from a JSON representation.", "kind": "function", "name": "fromJSON", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Curves.JSONCurve" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Curves.JSONCurve" } }, "description": "The JSON object containing this curve data.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Curves.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Curves.Line" } }, "description": "A new LineCurve object." } ], "memberof": "Phaser.Curves.Line", "longname": "Phaser.Curves.Line.fromJSON", "scope": "static", "___id": "T000002R004050", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A MoveTo Curve is a special curve type consisting of a single point. Unlike other curve types,\r\n * it does not draw anything — it simply repositions the current endpoint of a `Path`, analogous\r\n * to the SVG `moveto` command. Use it within a `Phaser.Curves.Path` to create a gap between\r\n * two sub-paths, or to begin drawing from a new position without connecting to the previous curve.\r\n *\r\n * @class MoveTo\r\n * @memberof Phaser.Curves\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - `x` pixel coordinate.\r\n * @param {number} [y=0] - `y` pixel coordinate.\r\n */", "meta": { "filename": "MoveTo.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "classdesc": "A MoveTo Curve is a special curve type consisting of a single point. Unlike other curve types,\rit does not draw anything — it simply repositions the current endpoint of a `Path`, analogous\rto the SVG `moveto` command. Use it within a `Phaser.Curves.Path` to create a gap between\rtwo sub-paths, or to begin drawing from a new position without connecting to the previous curve.", "kind": "class", "name": "MoveTo", "memberof": "Phaser.Curves", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "`x` pixel coordinate.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "`y` pixel coordinate.", "name": "y" } ], "scope": "static", "longname": "Phaser.Curves.MoveTo", "___id": "T000002R004058", "___s": true }, { "comment": "/**\r\n * A flag indicating that this curve is inactive and does not contribute to the bounds, length, or rendering of its parent Path. It is always `false` for a MoveTo, which marks it as a positional marker rather than a drawable segment.\r\n *\r\n * @name Phaser.Curves.MoveTo#active\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MoveTo.js", "lineno": 31, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "A flag indicating that this curve is inactive and does not contribute to the bounds, length, or rendering of its parent Path. It is always `false` for a MoveTo, which marks it as a positional marker rather than a drawable segment.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Curves.MoveTo", "longname": "Phaser.Curves.MoveTo#active", "scope": "instance", "kind": "member", "___id": "T000002R004061", "___s": true }, { "comment": "/**\r\n * The lone point which this curve consists of.\r\n *\r\n * @name Phaser.Curves.MoveTo#p0\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MoveTo.js", "lineno": 41, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "The lone point which this curve consists of.", "name": "p0", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Curves.MoveTo", "longname": "Phaser.Curves.MoveTo#p0", "scope": "instance", "kind": "member", "___id": "T000002R004063", "___s": true }, { "comment": "/**\r\n * Returns the single point that this MoveTo curve represents. Because a MoveTo has only one point, the value of `t` is ignored and `p0` is always returned.\r\n *\r\n * @method Phaser.Curves.MoveTo#getPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} t - The position along the curve to return. Where 0 is the start and 1 is the end.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.\r\n */", "meta": { "filename": "MoveTo.js", "lineno": 51, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Returns the single point that this MoveTo curve represents. Because a MoveTo has only one point, the value of `t` is ignored and `p0` is always returned.", "kind": "function", "name": "getPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004065", "___s": true }, { "comment": "/**\r\n * Retrieves the point at given position in the curve. This will always return this curve's only point.\r\n *\r\n * @method Phaser.Curves.MoveTo#getPointAt\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} u - The position in the path to retrieve, between 0 and 1. Not used.\r\n * @param {Phaser.Math.Vector2} [out] - An optional vector in which to store the point.\r\n *\r\n * @return {Phaser.Math.Vector2} The modified `out` vector, or a new `Vector2` if none was provided.\r\n */", "meta": { "filename": "MoveTo.js", "lineno": 71, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The position in the path to retrieve, between 0 and 1. Not used.", "name": "u" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "An optional vector in which to store the point.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004068", "___s": true }, { "comment": "/**\r\n * Gets the resolution of this curve.\r\n *\r\n * @method Phaser.Curves.MoveTo#getResolution\r\n * @since 3.0.0\r\n *\r\n * @return {number} The resolution of this curve. For a MoveTo the value is always 1.\r\n */", "meta": { "filename": "MoveTo.js", "lineno": 89, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Gets the resolution of this curve.", "kind": "function", "name": "getResolution", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004070", "___s": true }, { "comment": "/**\r\n * Gets the length of this curve.\r\n *\r\n * @method Phaser.Curves.MoveTo#getLength\r\n * @since 3.0.0\r\n *\r\n * @return {number} The length of this curve. For a MoveTo the value is always 0.\r\n */", "meta": { "filename": "MoveTo.js", "lineno": 102, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Gets the length of this curve.", "kind": "function", "name": "getLength", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004072", "___s": true }, { "comment": "/**\r\n * Converts this curve into a JSON-serializable object.\r\n *\r\n * @method Phaser.Curves.MoveTo#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.Curves.JSONCurve} A primitive object with the curve's type and only point.\r\n */", "meta": { "filename": "MoveTo.js", "lineno": 115, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Converts this curve into a JSON-serializable object.", "kind": "function", "name": "toJSON", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.Curves.JSONCurve" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004074", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Path combines multiple Curves into one continuous compound curve. It can contain any number of\r\n * Curves of any type, including Line, Bezier, Ellipse, and Spline Curves. Paths are commonly used\r\n * in Phaser to define routes for Game Objects to follow, either via the PathFollower component or\r\n * by sampling points along the Path to drive a Tween or custom movement logic.\r\n *\r\n * A Curve in a Path does not have to start where the previous Curve ends - that is to say, a Path does not\r\n * have to be an uninterrupted curve. Only the order of the Curves influences the actual points on the Path.\r\n *\r\n * @class Path\r\n * @memberof Phaser.Curves\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The X coordinate of the Path's starting point or a {@link Phaser.Types.Curves.JSONPath}.\r\n * @param {number} [y=0] - The Y coordinate of the Path's starting point.\r\n */", "meta": { "filename": "Path.js", "lineno": 21, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "classdesc": "A Path combines multiple Curves into one continuous compound curve. It can contain any number of\rCurves of any type, including Line, Bezier, Ellipse, and Spline Curves. Paths are commonly used\rin Phaser to define routes for Game Objects to follow, either via the PathFollower component or\rby sampling points along the Path to drive a Tween or custom movement logic.\r\rA Curve in a Path does not have to start where the previous Curve ends - that is to say, a Path does not\rhave 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The Y coordinate of the Path's starting point.", "name": "y" } ], "scope": "static", "longname": "Phaser.Curves.Path", "___id": "T000002R004090", "___s": true }, { "comment": "/**\r\n * The name of this Path.\r\n * Empty by default and never populated by Phaser, this is left for developers to use.\r\n *\r\n * @name Phaser.Curves.Path#name\r\n * @type {string}\r\n * @default ''\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Path.js", "lineno": 48, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "The name of this Path.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#name", "scope": "instance", "kind": "member", "___id": "T000002R004095", "___s": true }, { "comment": "/**\r\n * The default number of divisions within a curve.\r\n *\r\n * @name Phaser.Curves.Path#defaultDivisions\r\n * @type {number}\r\n * @default 12\r\n * @since 3.70.0\r\n */", "meta": { "filename": "Path.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "The default number of divisions within a curve.", "name": "defaultDivisions", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "12", "since": "3.70.0", "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#defaultDivisions", "scope": "instance", "kind": "member", "___id": "T000002R004097", "___s": true }, { "comment": "/**\r\n * The list of Curves which make up this Path.\r\n *\r\n * @name Phaser.Curves.Path#curves\r\n * @type {Phaser.Curves.Curve[]}\r\n * @default []\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Path.js", "lineno": 69, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "The list of Curves which make up this Path.", "name": "curves", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Curves.Curve", "type": "NameExpression" } ] } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#curves", "scope": "instance", "kind": "member", "___id": "T000002R004099", "___s": true }, { "comment": "/**\r\n * The cached length of each Curve in the Path.\r\n *\r\n * Used internally by {@link #getCurveLengths}.\r\n *\r\n * @name Phaser.Curves.Path#cacheLengths\r\n * @type {number[]}\r\n * @default []\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Path.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "The cached length of each Curve in the Path.\r\rUsed internally by {@link #getCurveLengths}.", "name": "cacheLengths", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#cacheLengths", "scope": "instance", "kind": "member", "___id": "T000002R004101", "___s": true }, { "comment": "/**\r\n * Automatically closes the path.\r\n *\r\n * @name Phaser.Curves.Path#autoClose\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Path.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Automatically closes the path.", "name": "autoClose", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#autoClose", "scope": "instance", "kind": "member", "___id": "T000002R004103", "___s": true }, { "comment": "/**\r\n * The starting point of the Path.\r\n *\r\n * This 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.\r\n *\r\n * @name Phaser.Curves.Path#startPoint\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Path.js", "lineno": 101, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "The starting point of the Path.\r\rThis 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#startPoint", "scope": "instance", "kind": "member", "___id": "T000002R004105", "___s": true }, { "comment": "/**\r\n * Appends a Curve to the end of the Path.\r\n *\r\n * The Curve does not have to start where the Path ends or, for an empty Path, at its defined starting point.\r\n *\r\n * @method Phaser.Curves.Path#add\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Curves.Curve} curve - The Curve to append.\r\n *\r\n * @return {this} This Path object.\r\n */", "meta": { "filename": "Path.js", "lineno": 142, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Appends a Curve to the end of the Path.\r\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Curves.Curve" } }, "description": "The Curve to append.", "name": "curve" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Path object." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#add", "scope": "instance", "___id": "T000002R004111", "___s": true }, { "comment": "/**\r\n * Creates a circular Ellipse Curve positioned at the end of the Path.\r\n *\r\n * @method Phaser.Curves.Path#circleTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} radius - The radius of the circle.\r\n * @param {boolean} [clockwise=false] - `true` to create a clockwise circle as opposed to a counter-clockwise circle.\r\n * @param {number} [rotation=0] - The rotation of the circle in degrees.\r\n *\r\n * @return {this} This Path object.\r\n */", "meta": { "filename": "Path.js", "lineno": 161, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the circle.", "name": "radius" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "`true` to create a clockwise circle as opposed to a counter-clockwise circle.", "name": "clockwise" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of the circle in degrees.", "name": "rotation" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Path object." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#circleTo", "scope": "instance", "___id": "T000002R004113", "___s": true }, { "comment": "/**\r\n * Ensures that the Path is closed.\r\n *\r\n * A 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.\r\n *\r\n * Calling this method on an empty Path will result in an error.\r\n *\r\n * @method Phaser.Curves.Path#closePath\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Path object.\r\n */", "meta": { "filename": "Path.js", "lineno": 180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Ensures that the Path is closed.\r\rA 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.\r\rCalling this method on an empty Path will result in an error.", "kind": "function", "name": "closePath", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Path object." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#closePath", "scope": "instance", "___id": "T000002R004116", "___s": true }, { "comment": "/**\r\n * Creates a cubic bezier curve starting at the previous end point and ending at p3, using p1 and p2 as control points.\r\n *\r\n * @method Phaser.Curves.Path#cubicBezierTo\r\n * @since 3.0.0\r\n *\r\n * @param {(number|Phaser.Math.Vector2)} x - The x coordinate of the end point. Or, if a Vector2, the p1 value.\r\n * @param {(number|Phaser.Math.Vector2)} y - The y coordinate of the end point. Or, if a Vector2, the p2 value.\r\n * @param {(number|Phaser.Math.Vector2)} control1X - The x coordinate of the first control point. Or, if a Vector2, the p3 value.\r\n * @param {number} [control1Y] - The y coordinate of the first control point. Not used if Vector2s are provided as the first 3 arguments.\r\n * @param {number} [control2X] - The x coordinate of the second control point. Not used if Vector2s are provided as the first 3 arguments.\r\n * @param {number} [control2Y] - The y coordinate of the second control point. Not used if Vector2s are provided as the first 3 arguments.\r\n *\r\n * @return {this} This Path object.\r\n */", "meta": { "filename": "Path.js", "lineno": 207, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Math.Vector2" } ] } }, "description": "The x coordinate of the first control point. Or, if a Vector2, the p3 value.", "name": "control1X" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Path object." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#cubicBezierTo", "scope": "instance", "___id": "T000002R004120", "___s": true }, { "comment": "/**\r\n * Creates a Quadratic Bezier Curve starting at the ending point of the Path.\r\n *\r\n * @method Phaser.Curves.Path#quadraticBezierTo\r\n * @since 3.2.0\r\n *\r\n * @param {(number|Phaser.Math.Vector2[])} x - The X coordinate of the second control point or, if it's a `Vector2`, the first control point.\r\n * @param {number} [y] - The Y coordinate of the second control point or, if `x` is a `Vector2`, the second control point.\r\n * @param {number} [controlX] - If `x` is not a `Vector2`, the X coordinate of the first control point.\r\n * @param {number} [controlY] - If `x` is not a `Vector2`, the Y coordinate of the first control point.\r\n *\r\n * @return {this} This Path object.\r\n */", "meta": { "filename": "Path.js", "lineno": 248, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } ] } }, "description": "The X coordinate of the second control point or, if it's a `Vector2`, the first control point.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If `x` is not a `Vector2`, the X coordinate of the first control point.", "name": "controlX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If `x` is not a `Vector2`, the Y coordinate of the first control point.", "name": "controlY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Path object." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#quadraticBezierTo", "scope": "instance", "___id": "T000002R004132", "___s": true }, { "comment": "/**\r\n * Draws all Curves in the Path to a Graphics Game Object.\r\n *\r\n * @method Phaser.Curves.Path#draw\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.Graphics} G - [out,$return]\r\n *\r\n * @param {Phaser.GameObjects.Graphics} graphics - The Graphics Game Object to draw to.\r\n * @param {number} [pointsTotal=32] - The number of points to draw for each Curve. Higher numbers result in a smoother curve but require more processing.\r\n *\r\n * @return {Phaser.GameObjects.Graphics} The Graphics object which was drawn to.\r\n */", "meta": { "filename": "Path.js", "lineno": 282, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Draws all Curves in the Path to a Graphics Game Object.", "kind": "function", "name": "draw", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.Graphics} G - [out,$return]", "value": "{Phaser.GameObjects.Graphics} G - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics Game Object to draw to.", "name": "graphics" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object which was drawn to." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#draw", "scope": "instance", "___id": "T000002R004141", "___s": true }, { "comment": "/**\r\n * Creates an ellipse curve positioned at the previous end point, using the given parameters.\r\n *\r\n * @method Phaser.Curves.Path#ellipseTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} [xRadius=0] - The horizontal radius of ellipse.\r\n * @param {number} [yRadius=0] - The vertical radius of ellipse.\r\n * @param {number} [startAngle=0] - The start angle of the ellipse, in degrees.\r\n * @param {number} [endAngle=360] - The end angle of the ellipse, in degrees.\r\n * @param {boolean} [clockwise=false] - Whether the ellipse angles are given as clockwise (`true`) or counter-clockwise (`false`).\r\n * @param {number} [rotation=0] - The rotation of the ellipse, in degrees.\r\n *\r\n * @return {this} This Path object.\r\n */", "meta": { "filename": "Path.js", "lineno": 312, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal radius of ellipse.", "name": "xRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical radius of ellipse.", "name": "yRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The start angle of the ellipse, in degrees.", "name": "startAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 360, "description": "The end angle of the ellipse, in degrees.", "name": "endAngle" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether the ellipse angles are given as clockwise (`true`) or counter-clockwise (`false`).", "name": "clockwise" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of the ellipse, in degrees.", "name": "rotation" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Path object." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#ellipseTo", "scope": "instance", "___id": "T000002R004145", "___s": true }, { "comment": "/**\r\n * Creates a Path from a Path Configuration object.\r\n *\r\n * The provided object should be a {@link Phaser.Types.Curves.JSONPath}, as returned by {@link #toJSON}. Providing a malformed object may cause errors.\r\n *\r\n * @method Phaser.Curves.Path#fromJSON\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Curves.JSONPath} data - The JSON object containing the Path data.\r\n *\r\n * @return {this} This Path object.\r\n */", "meta": { "filename": "Path.js", "lineno": 344, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Creates a Path from a Path Configuration object.\r\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Curves.JSONPath" } }, "description": "The JSON object containing the Path data.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Path object." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#fromJSON", "scope": "instance", "___id": "T000002R004152", "___s": true }, { "comment": "/**\r\n * Returns a Rectangle with a position and size matching the bounds of this Path.\r\n *\r\n * @method Phaser.Curves.Path#getBounds\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} [out] - The Rectangle to store the bounds in.\r\n * @param {number} [accuracy=16] - The accuracy of the bounds calculations. Higher values are more accurate at the cost of calculation speed.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The modified `out` Rectangle, or a new Rectangle if none was provided.\r\n */", "meta": { "filename": "Path.js", "lineno": 398, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Returns a Rectangle with a position and size matching the bounds of this Path.", "kind": "function", "name": "getBounds", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "optional": true, "description": "The Rectangle to store the bounds in.", "name": "out" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004159", "___s": true }, { "comment": "/**\r\n * Returns an array containing the length of the Path at the end of each Curve.\r\n *\r\n * The 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.\r\n *\r\n * @method Phaser.Curves.Path#getCurveLengths\r\n * @since 3.0.0\r\n *\r\n * @return {number[]} An array containing the length of the Path at the end of each one of its Curves.\r\n */", "meta": { "filename": "Path.js", "lineno": 447, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Returns an array containing the length of the Path at the end of each Curve.\r\rThe 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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "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", "___id": "T000002R004176", "___s": true }, { "comment": "/**\r\n * Returns the Curve that forms the Path at the given normalized location (between 0 and 1).\r\n *\r\n * @method Phaser.Curves.Path#getCurveAt\r\n * @since 3.60.0\r\n *\r\n * @param {number} t - The normalized location on the Path, between 0 and 1.\r\n *\r\n * @return {?Phaser.Curves.Curve} The Curve that is part of this Path at a given location, or `null` if no curve was found.\r\n */", "meta": { "filename": "Path.js", "lineno": 484, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Returns the Curve that forms the Path at the given normalized location (between 0 and 1).", "kind": "function", "name": "getCurveAt", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The normalized location on the Path, between 0 and 1.", "name": "t" } ], "returns": [ { "type": { "names": [ "Phaser.Curves.Curve" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Curves.Curve", "nullable": true } }, "nullable": true, "description": "The Curve that is part of this Path at a given location, or `null` if no curve was found." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#getCurveAt", "scope": "instance", "___id": "T000002R004183", "___s": true }, { "comment": "/**\r\n * Returns the ending point of the Path.\r\n *\r\n * A 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}.\r\n *\r\n * @method Phaser.Curves.Path#getEndPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [out] - The object to store the point in.\r\n *\r\n * @return {Phaser.Math.Vector2} The modified `out` object, or a new Vector2 if none was provided.\r\n */", "meta": { "filename": "Path.js", "lineno": 513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Returns the ending point of the Path.\r\rA 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "The object to store the point in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004188", "___s": true }, { "comment": "/**\r\n * Returns the total length of the Path.\r\n *\r\n * @see {@link #getCurveLengths}\r\n *\r\n * @method Phaser.Curves.Path#getLength\r\n * @since 3.0.0\r\n *\r\n * @return {number} The total length of the Path.\r\n */", "meta": { "filename": "Path.js", "lineno": 543, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Returns the total length of the Path.", "see": [ "{@link #getCurveLengths}" ], "kind": "function", "name": "getLength", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total length of the Path." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#getLength", "scope": "instance", "___id": "T000002R004191", "___s": true }, { "comment": "/**\r\n * Calculates the coordinates of the point at the given normalized location (between 0 and 1) on the Path.\r\n *\r\n * The 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.\r\n *\r\n * @method Phaser.Curves.Path#getPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} t - The location of the point to return, between 0 and 1.\r\n * @param {Phaser.Math.Vector2} [out] - The object in which to store the calculated point.\r\n *\r\n * @return {?Phaser.Math.Vector2} The modified `out` object, or a new `Vector2` if none was provided.\r\n */", "meta": { "filename": "Path.js", "lineno": 569, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Calculates the coordinates of the point at the given normalized location (between 0 and 1) on the Path.\r\rThe 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The location of the point to return, between 0 and 1.", "name": "t" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "The object in which to store the calculated point.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2", "nullable": true } }, "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", "___id": "T000002R004194", "___s": true }, { "comment": "/**\r\n * Get a sequence of points on the path.\r\n *\r\n * @method Phaser.Curves.Path#getPoints\r\n * @since 3.0.0\r\n *\r\n * @param {number} [divisions] - The number of divisions to make per resolution per curve.\r\n * @param {number} [stepRate] - The curve distance between points per curve, implying `divisions`.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2 objects containing the points along the Path.\r\n */", "meta": { "filename": "Path.js", "lineno": 612, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Get a sequence of points on the path.", "kind": "function", "name": "getPoints", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The number of divisions to make per resolution per curve.", "name": "divisions" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The curve distance between points per curve, implying `divisions`.", "name": "stepRate" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2 objects containing the points along the Path." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#getPoints", "scope": "instance", "___id": "T000002R004204", "___s": true }, { "comment": "/**\r\n * 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.\r\n *\r\n * When calling this method multiple times, the points are not guaranteed to be equally spaced spatially.\r\n *\r\n * @method Phaser.Curves.Path#getRandomPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [out] - `Vector2` instance that should be used for storing the result. If `undefined` a new `Vector2` will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} The modified `out` object, or a new `Vector2` if none was provided.\r\n */", "meta": { "filename": "Path.js", "lineno": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "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.\r\rWhen calling this method multiple times, the points are not guaranteed to be equally spaced spatially.", "kind": "function", "name": "getRandomPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004216", "___s": true }, { "comment": "/**\r\n * Divides this Path into a set of equally spaced points.\r\n *\r\n * The resulting points are equally spaced with respect to the points' position on the path, but not necessarily equally spaced spatially.\r\n *\r\n * @method Phaser.Curves.Path#getSpacedPoints\r\n * @since 3.0.0\r\n *\r\n * @param {number} [divisions=40] - The amount of points to divide this Path into.\r\n *\r\n * @return {Phaser.Math.Vector2[]} A list of the points this path was subdivided into.\r\n */", "meta": { "filename": "Path.js", "lineno": 692, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Divides this Path into a set of equally spaced points.\r\rThe 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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 40, "description": "The amount of points to divide this Path into.", "name": "divisions" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "A list of the points this path was subdivided into." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#getSpacedPoints", "scope": "instance", "___id": "T000002R004219", "___s": true }, { "comment": "/**\r\n * Returns the starting point of the Path.\r\n *\r\n * @method Phaser.Curves.Path#getStartPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [out] - `Vector2` instance that should be used for storing the result. If `undefined` a new `Vector2` will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} The modified `out` object, or a new Vector2 if none was provided.\r\n */", "meta": { "filename": "Path.js", "lineno": 723, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Returns the starting point of the Path.", "kind": "function", "name": "getStartPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004224", "___s": true }, { "comment": "/**\r\n * Gets a unit vector tangent at a relative position on the path.\r\n *\r\n * @method Phaser.Curves.Path#getTangent\r\n * @since 3.23.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} t - The relative position on the path, [0..1].\r\n * @param {Phaser.Math.Vector2} [out] - A vector to store the result in.\r\n *\r\n * @return {Phaser.Math.Vector2} Vector approximating the tangent line at the point t (delta +/- 0.0001)\r\n */", "meta": { "filename": "Path.js", "lineno": 742, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Gets a unit vector tangent at a relative position on the path.", "kind": "function", "name": "getTangent", "since": "3.23.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The relative position on the path, [0..1].", "name": "t" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A vector to store the result in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "Vector approximating the tangent line at the point t (delta +/- 0.0001)" } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#getTangent", "scope": "instance", "___id": "T000002R004227", "___s": true }, { "comment": "/**\r\n * Creates a line curve from the previous end point to x/y.\r\n *\r\n * @method Phaser.Curves.Path#lineTo\r\n * @since 3.0.0\r\n *\r\n * @param {(number|Phaser.Math.Vector2|Phaser.Types.Math.Vector2Like)} x - The X coordinate of the line's end point, or a `Vector2` / `Vector2Like` containing the entire end point.\r\n * @param {number} [y] - The Y coordinate of the line's end point, if a number was passed as the X parameter.\r\n *\r\n * @return {this} This Path object.\r\n */", "meta": { "filename": "Path.js", "lineno": 782, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "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", "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } ] } }, "description": "The X coordinate of the line's end point, or a `Vector2` / `Vector2Like` containing the entire end point.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Path object." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#lineTo", "scope": "instance", "___id": "T000002R004237", "___s": true }, { "comment": "/**\r\n * Creates a spline curve starting at the previous end point, using the given points on the curve.\r\n *\r\n * @method Phaser.Curves.Path#splineTo\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector2[]} points - The points the newly created spline curve should consist of.\r\n *\r\n * @return {this} This Path object.\r\n */", "meta": { "filename": "Path.js", "lineno": 813, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "The points the newly created spline curve should consist of.", "name": "points" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Path object." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#splineTo", "scope": "instance", "___id": "T000002R004240", "___s": true }, { "comment": "/**\r\n * Creates a \"gap\" in this path from the path's current end point to the given coordinates.\r\n *\r\n * After calling this function, this Path's end point will be equal to the given coordinates.\r\n *\r\n * @method Phaser.Curves.Path#moveTo\r\n * @since 3.0.0\r\n *\r\n * @param {(number|Phaser.Math.Vector2|Phaser.Types.Math.Vector2Like)} x - The X coordinate of the position to move the path's end point to, or a `Vector2` / `Vector2Like` containing the entire new end point.\r\n * @param {number} [y] - The Y coordinate of the position to move the path's end point to, if a number was passed as the X coordinate.\r\n *\r\n * @return {this} This Path object.\r\n */", "meta": { "filename": "Path.js", "lineno": 830, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Creates a \"gap\" in this path from the path's current end point to the given coordinates.\r\rAfter 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", "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } ] } }, "description": "The X coordinate of the position to move the path's end point to, or a `Vector2` / `Vector2Like` containing the entire new end point.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Path object." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#moveTo", "scope": "instance", "___id": "T000002R004242", "___s": true }, { "comment": "/**\r\n * Converts this Path to a JSON object containing the path information and its constituent curves.\r\n *\r\n * @method Phaser.Curves.Path#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.Curves.JSONPath} The JSON object containing this path's data.\r\n */", "meta": { "filename": "Path.js", "lineno": 855, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Curves.JSONPath" } }, "description": "The JSON object containing this path's data." } ], "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#toJSON", "scope": "instance", "___id": "T000002R004244", "___s": true }, { "comment": "/**\r\n * Clears the cached arc lengths and forces them to be recalculated on the next call to\r\n * {@link #getCurveLengths} or any method that depends on it. Call this if you have modified\r\n * a Curve within this Path in-place, since the cache is only automatically invalidated when\r\n * the number of Curves changes.\r\n *\r\n * @method Phaser.Curves.Path#updateArcLengths\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Path.js", "lineno": 881, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Clears the cached arc lengths and forces them to be recalculated on the next call to\r{@link #getCurveLengths} or any method that depends on it. Call this if you have modified\ra Curve within this Path in-place, since the cache is only automatically invalidated when\rthe number of Curves changes.", "kind": "function", "name": "updateArcLengths", "since": "3.0.0", "memberof": "Phaser.Curves.Path", "longname": "Phaser.Curves.Path#updateArcLengths", "scope": "instance", "___id": "T000002R004253", "___s": true }, { "comment": "/**\r\n * Disposes of this Path, clearing its internal references to objects so they can be garbage-collected.\r\n *\r\n * @method Phaser.Curves.Path#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Path.js", "lineno": 897, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "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", "___id": "T000002R004256", "___s": true }, { "comment": "/**\r\n * Creates a new Path Object.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#path\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal position of this Path.\r\n * @param {number} y - The vertical position of this Path.\r\n *\r\n * @return {Phaser.Curves.Path} The Path Object that was created.\r\n */", "meta": { "filename": "Path.js", "lineno": 912, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves\\path", "code": {} }, "description": "Creates a new Path Object.", "kind": "function", "name": "path", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Path.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Path.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Curves.Path" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Curves.Path" } }, "description": "The Path Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#path", "scope": "instance", "___id": "T000002R004261", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A quadratic Bézier curve constructed from three points: a start point, a single control\r\n * point, and an end point. This is a second-degree Bézier curve, where the control point\r\n * influences the curvature of the path between the start and end points.\r\n *\r\n * @class QuadraticBezier\r\n * @extends Phaser.Curves.Curve\r\n * @memberof Phaser.Curves\r\n * @constructor\r\n * @since 3.2.0\r\n *\r\n * @param {(Phaser.Math.Vector2|number[])} p0 - Start point, or an array of point pairs.\r\n * @param {Phaser.Math.Vector2} p1 - Control Point 1.\r\n * @param {Phaser.Math.Vector2} p2 - The end point of the curve.\r\n */", "meta": { "filename": "QuadraticBezierCurve.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "classdesc": "A quadratic Bézier curve constructed from three points: a start point, a single control\rpoint, and an end point. This is a second-degree Bézier curve, where the control point\rinfluences the curvature of the path between the start and end points.", "kind": "class", "name": "QuadraticBezier", "augments": [ "Phaser.Curves.Curve" ], "memberof": "Phaser.Curves", "since": "3.2.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "description": "Start point, or an array of point pairs.", "name": "p0" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "Control Point 1.", "name": "p1" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The end point of the curve.", "name": "p2" } ], "scope": "static", "longname": "Phaser.Curves.QuadraticBezier", "___id": "T000002R004267", "___s": true }, { "comment": "/**\r\n * The start point.\r\n *\r\n * @name Phaser.Curves.QuadraticBezier#p0\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.2.0\r\n */", "meta": { "filename": "QuadraticBezierCurve.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The start point.", "name": "p0", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.2.0", "memberof": "Phaser.Curves.QuadraticBezier", "longname": "Phaser.Curves.QuadraticBezier#p0", "scope": "instance", "kind": "member", "___id": "T000002R004274", "___s": true }, { "comment": "/**\r\n * The first control point.\r\n *\r\n * @name Phaser.Curves.QuadraticBezier#p1\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.2.0\r\n */", "meta": { "filename": "QuadraticBezierCurve.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The first control point.", "name": "p1", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.2.0", "memberof": "Phaser.Curves.QuadraticBezier", "longname": "Phaser.Curves.QuadraticBezier#p1", "scope": "instance", "kind": "member", "___id": "T000002R004276", "___s": true }, { "comment": "/**\r\n * The end point of the curve.\r\n *\r\n * @name Phaser.Curves.QuadraticBezier#p2\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.2.0\r\n */", "meta": { "filename": "QuadraticBezierCurve.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The end point of the curve.", "name": "p2", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.2.0", "memberof": "Phaser.Curves.QuadraticBezier", "longname": "Phaser.Curves.QuadraticBezier#p2", "scope": "instance", "kind": "member", "___id": "T000002R004278", "___s": true }, { "comment": "/**\r\n * Gets the starting point on the curve.\r\n *\r\n * @method Phaser.Curves.QuadraticBezier#getStartPoint\r\n * @since 3.2.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.\r\n */", "meta": { "filename": "QuadraticBezierCurve.js", "lineno": 73, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Gets the starting point on the curve.", "kind": "function", "name": "getStartPoint", "since": "3.2.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004280", "___s": true }, { "comment": "/**\r\n * Returns the resolution of this curve. For a Quadratic Bezier, the resolution is equal to the number of divisions requested.\r\n *\r\n * @method Phaser.Curves.QuadraticBezier#getResolution\r\n * @since 3.2.0\r\n *\r\n * @param {number} divisions - Optional divisions value.\r\n *\r\n * @return {number} The curve resolution.\r\n */", "meta": { "filename": "QuadraticBezierCurve.js", "lineno": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Returns the resolution of this curve. For a Quadratic Bezier, the resolution is equal to the number of divisions requested.", "kind": "function", "name": "getResolution", "since": "3.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Optional divisions value.", "name": "divisions" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The curve resolution." } ], "memberof": "Phaser.Curves.QuadraticBezier", "longname": "Phaser.Curves.QuadraticBezier#getResolution", "scope": "instance", "___id": "T000002R004283", "___s": true }, { "comment": "/**\r\n * Get point at relative position in curve according to length.\r\n *\r\n * @method Phaser.Curves.QuadraticBezier#getPoint\r\n * @since 3.2.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} t - The position along the curve to return. Where 0 is the start and 1 is the end.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.\r\n */", "meta": { "filename": "QuadraticBezierCurve.js", "lineno": 107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get point at relative position in curve according to length.", "kind": "function", "name": "getPoint", "since": "3.2.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004285", "___s": true }, { "comment": "/**\r\n * Draws this curve on the given Graphics object.\r\n *\r\n * The curve is drawn using `Graphics.strokePoints` so will be drawn at whatever the present Graphics stroke color is.\r\n * The Graphics object is not cleared before the draw, so the curve will appear on-top of anything else already rendered to it.\r\n *\r\n * @method Phaser.Curves.QuadraticBezier#draw\r\n * @since 3.2.0\r\n *\r\n * @generic {Phaser.GameObjects.Graphics} G - [graphics,$return]\r\n *\r\n * @param {Phaser.GameObjects.Graphics} graphics - `Graphics` object to draw onto.\r\n * @param {number} [pointsTotal=32] - Number of points to be used for drawing the curve. Higher numbers result in smoother curve but require more processing.\r\n *\r\n * @return {Phaser.GameObjects.Graphics} `Graphics` object that was drawn to.\r\n */", "meta": { "filename": "QuadraticBezierCurve.js", "lineno": 134, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Draws this curve on the given Graphics object.\r\rThe curve is drawn using `Graphics.strokePoints` so will be drawn at whatever the present Graphics stroke color is.\rThe 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.2.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.Graphics} G - [graphics,$return]", "value": "{Phaser.GameObjects.Graphics} G - [graphics,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "`Graphics` object to draw onto.", "name": "graphics" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004291", "___s": true }, { "comment": "/**\r\n * Converts the curve into a JSON compatible object.\r\n *\r\n * @method Phaser.Curves.QuadraticBezier#toJSON\r\n * @since 3.2.0\r\n *\r\n * @return {Phaser.Types.Curves.JSONCurve} The JSON object containing this curve data.\r\n */", "meta": { "filename": "QuadraticBezierCurve.js", "lineno": 170, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Converts the curve into a JSON compatible object.", "kind": "function", "name": "toJSON", "since": "3.2.0", "returns": [ { "type": { "names": [ "Phaser.Types.Curves.JSONCurve" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Curves.JSONCurve" } }, "description": "The JSON object containing this curve data." } ], "memberof": "Phaser.Curves.QuadraticBezier", "longname": "Phaser.Curves.QuadraticBezier#toJSON", "scope": "instance", "___id": "T000002R004296", "___s": true }, { "comment": "/**\r\n * Creates a curve from a JSON object, e.g. created by `toJSON`.\r\n *\r\n * @function Phaser.Curves.QuadraticBezier.fromJSON\r\n * @since 3.2.0\r\n *\r\n * @param {Phaser.Types.Curves.JSONCurve} data - The JSON object containing this curve data.\r\n *\r\n * @return {Phaser.Curves.QuadraticBezier} The created curve instance.\r\n */", "meta": { "filename": "QuadraticBezierCurve.js", "lineno": 192, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Curves.JSONCurve" } }, "description": "The JSON object containing this curve data.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Curves.QuadraticBezier" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Curves.QuadraticBezier" } }, "description": "The created curve instance." } ], "memberof": "Phaser.Curves.QuadraticBezier", "longname": "Phaser.Curves.QuadraticBezier.fromJSON", "scope": "static", "___id": "T000002R004300", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Spline Curve is a smooth curve that passes through a series of control points, using Catmull-Rom\r\n * interpolation to produce a natural-looking path. Unlike a Bezier curve, every control point is\r\n * visited exactly, making it easy to define a precise route for objects to follow.\r\n *\r\n * Use a Spline Curve when you need a smooth path through multiple waypoints, such as a camera\r\n * dolly track, a projectile flight path, or a patrol route for a game character. Points can be\r\n * added at construction time or incrementally via `addPoint` and `addPoints`.\r\n *\r\n * @class Spline\r\n * @extends Phaser.Curves.Curve\r\n * @memberof Phaser.Curves\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2[]|number[]|number[][])} [points] - The points that configure the curve.\r\n */", "meta": { "filename": "SplineCurve.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "classdesc": "A Spline Curve is a smooth curve that passes through a series of control points, using Catmull-Rom\rinterpolation to produce a natural-looking path. Unlike a Bezier curve, every control point is\rvisited exactly, making it easy to define a precise route for objects to follow.\r\rUse a Spline Curve when you need a smooth path through multiple waypoints, such as a camera\rdolly track, a projectile flight path, or a patrol route for a game character. Points can be\radded at construction time or incrementally via `addPoint` and `addPoints`.", "kind": "class", "name": "Spline", "augments": [ "Phaser.Curves.Curve" ], "memberof": "Phaser.Curves", "since": "3.0.0", "params": [ { "type": { "names": [ "Array.", "Array.", "Array.>" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } ] } }, "optional": true, "description": "The points that configure the curve.", "name": "points" } ], "scope": "static", "longname": "Phaser.Curves.Spline", "___id": "T000002R004311", "___s": true }, { "comment": "/**\r\n * The Vector2 points that configure the curve.\r\n *\r\n * @name Phaser.Curves.Spline#points\r\n * @type {Phaser.Math.Vector2[]}\r\n * @default []\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SplineCurve.js", "lineno": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "The Vector2 points that configure the curve.", "name": "points", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.Curves.Spline", "longname": "Phaser.Curves.Spline#points", "scope": "instance", "kind": "member", "___id": "T000002R004316", "___s": true }, { "comment": "/**\r\n * Add a list of points to the current list of Vector2 points of the curve.\r\n *\r\n * @method Phaser.Curves.Spline#addPoints\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2[]|number[]|number[][])} points - The points to add. Accepts an array of `Vector2` objects, a flat array of interleaved `x, y` number pairs, or an array of two-element `[x, y]` number arrays.\r\n *\r\n * @return {this} This curve object.\r\n */", "meta": { "filename": "SplineCurve.js", "lineno": 57, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "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.>" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } ] } }, "description": "The points to add. Accepts an array of `Vector2` objects, a flat array of interleaved `x, y` number pairs, or an array of two-element `[x, y]` number arrays.", "name": "points" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This curve object." } ], "memberof": "Phaser.Curves.Spline", "longname": "Phaser.Curves.Spline#addPoints", "scope": "instance", "___id": "T000002R004318", "___s": true }, { "comment": "/**\r\n * Add a point to the current list of Vector2 points of the curve.\r\n *\r\n * @method Phaser.Curves.Spline#addPoint\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate of the point to add.\r\n * @param {number} y - The y coordinate of the point to add.\r\n *\r\n * @return {Phaser.Math.Vector2} The new Vector2 added to the curve\r\n */", "meta": { "filename": "SplineCurve.js", "lineno": 97, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the point to add.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the point to add.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The new Vector2 added to the curve" } ], "memberof": "Phaser.Curves.Spline", "longname": "Phaser.Curves.Spline#addPoint", "scope": "instance", "___id": "T000002R004328", "___s": true }, { "comment": "/**\r\n * Gets the starting point on the curve.\r\n *\r\n * @method Phaser.Curves.Spline#getStartPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.\r\n */", "meta": { "filename": "SplineCurve.js", "lineno": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Gets the starting point on the curve.", "kind": "function", "name": "getStartPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004331", "___s": true }, { "comment": "/**\r\n * Returns the resolution of this curve, which is the number of points used to approximate it per segment. For a Spline, this scales with the number of points and the requested divisions.\r\n *\r\n * @method Phaser.Curves.Spline#getResolution\r\n * @since 3.0.0\r\n *\r\n * @param {number} divisions - The number of divisions per segment used when approximating the curve.\r\n *\r\n * @return {number} The curve resolution.\r\n */", "meta": { "filename": "SplineCurve.js", "lineno": 136, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Returns the resolution of this curve, which is the number of points used to approximate it per segment. For a Spline, this scales with the number of points and the requested divisions.", "kind": "function", "name": "getResolution", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of divisions per segment used when approximating the curve.", "name": "divisions" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The curve resolution." } ], "memberof": "Phaser.Curves.Spline", "longname": "Phaser.Curves.Spline#getResolution", "scope": "instance", "___id": "T000002R004334", "___s": true }, { "comment": "/**\r\n * Get point at relative position in curve according to length.\r\n *\r\n * @method Phaser.Curves.Spline#getPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} t - The position along the curve to return. Where 0 is the start and 1 is the end.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not given will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} The coordinates of the point on the curve. If an `out` object was given this will be returned.\r\n */", "meta": { "filename": "SplineCurve.js", "lineno": 151, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Get point at relative position in curve according to length.", "kind": "function", "name": "getPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004336", "___s": true }, { "comment": "/**\r\n * Exports a JSON object containing this curve data.\r\n *\r\n * @method Phaser.Curves.Spline#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.Curves.JSONCurve} The JSON object containing this curve data.\r\n */", "meta": { "filename": "SplineCurve.js", "lineno": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Exports a JSON object containing this curve data.", "kind": "function", "name": "toJSON", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.Curves.JSONCurve" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Curves.JSONCurve" } }, "description": "The JSON object containing this curve data." } ], "memberof": "Phaser.Curves.Spline", "longname": "Phaser.Curves.Spline#toJSON", "scope": "instance", "___id": "T000002R004347", "___s": true }, { "comment": "/**\r\n * Imports a JSON object containing this curve data.\r\n *\r\n * @function Phaser.Curves.Spline.fromJSON\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Curves.JSONCurve} data - The JSON object containing this curve data.\r\n *\r\n * @return {Phaser.Curves.Spline} The spline curve created.\r\n */", "meta": { "filename": "SplineCurve.js", "lineno": 210, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves", "code": {} }, "description": "Imports a JSON object containing this curve data.", "kind": "function", "name": "fromJSON", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Curves.JSONCurve" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Curves.JSONCurve" } }, "description": "The JSON object containing this curve data.", "name": "data" } ], "returns": [ { "type": { "names": [ "Phaser.Curves.Spline" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Curves.Spline" } }, "description": "The spline curve created." } ], "memberof": "Phaser.Curves.Spline", "longname": "Phaser.Curves.Spline.fromJSON", "scope": "static", "___id": "T000002R004353", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Curves.EllipseCurveConfig\r\n *\r\n * @property {number} [x=0] - The x coordinate of the ellipse.\r\n * @property {number} [y=0] - The y coordinate of the ellipse.\r\n * @property {number} [xRadius=0] - The horizontal radius of the ellipse.\r\n * @property {number} [yRadius=0] - The vertical radius of the ellipse.\r\n * @property {number} [startAngle=0] - The start angle of the ellipse, in degrees.\r\n * @property {number} [endAngle=360] - The end angle of the ellipse, in degrees.\r\n * @property {boolean} [clockwise=false] - Sets if the ellipse rotation is clockwise (true) or anti-clockwise (false)\r\n * @property {number} [rotation=0] - The rotation of the ellipse, in degrees.\r\n */", "meta": { "filename": "EllipseCurveConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves\\typedefs", "code": {} }, "kind": "typedef", "name": "EllipseCurveConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the ellipse.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the ellipse.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal radius of the ellipse.", "name": "xRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical radius of the ellipse.", "name": "yRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The start angle of the ellipse, in degrees.", "name": "startAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 360, "description": "The end angle of the ellipse, in degrees.", "name": "endAngle" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Sets if the ellipse rotation is clockwise (true) or anti-clockwise (false)", "name": "clockwise" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R004356", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Curves\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves\\typedefs", "code": {} }, "kind": "namespace", "name": "Curves", "memberof": "Phaser.Types", "longname": "Phaser.Types.Curves", "scope": "static", "___id": "T000002R004357", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Curves.JSONCurve\r\n * @since 3.0.0\r\n *\r\n * @property {string} type - The type of the curve\r\n * @property {number[]} points - The arrays of points like `[x1, y1, x2, y2]`\r\n */", "meta": { "filename": "JSONCurve.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves\\typedefs", "code": {} }, "kind": "typedef", "name": "JSONCurve", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The type of the curve", "name": "type" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The arrays of points like `[x1, y1, x2, y2]`", "name": "points" } ], "memberof": "Phaser.Types.Curves", "longname": "Phaser.Types.Curves.JSONCurve", "scope": "static", "___id": "T000002R004358", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Curves.JSONEllipseCurve\r\n * @since 3.0.0\r\n *\r\n * @property {string} type - The type of the curve.\r\n * @property {number} x - The x coordinate of the ellipse.\r\n * @property {number} y - The y coordinate of the ellipse.\r\n * @property {number} xRadius - The horizontal radius of ellipse.\r\n * @property {number} yRadius - The vertical radius of ellipse.\r\n * @property {number} startAngle - The start angle of the ellipse, in degrees.\r\n * @property {number} endAngle - The end angle of the ellipse, in degrees.\r\n * @property {boolean} clockwise - Sets if the ellipse rotation is clockwise (true) or anti-clockwise (false)\r\n * @property {number} rotation - The rotation of ellipse, in degrees.\r\n */", "meta": { "filename": "JSONEllipseCurve.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves\\typedefs", "code": {} }, "kind": "typedef", "name": "JSONEllipseCurve", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The type of the curve.", "name": "type" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the ellipse.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the ellipse.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal radius of ellipse.", "name": "xRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical radius of ellipse.", "name": "yRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The start angle of the ellipse, in degrees.", "name": "startAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The end angle of the ellipse, in degrees.", "name": "endAngle" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Sets if the ellipse rotation is clockwise (true) or anti-clockwise (false)", "name": "clockwise" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rotation of ellipse, in degrees.", "name": "rotation" } ], "memberof": "Phaser.Types.Curves", "longname": "Phaser.Types.Curves.JSONEllipseCurve", "scope": "static", "___id": "T000002R004359", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Curves.JSONPath\r\n * @since 3.0.0\r\n *\r\n * @property {string} type - The type of the path.\r\n * @property {number} x - The X coordinate of the curve's starting point.\r\n * @property {number} y - The Y coordinate of the path's starting point.\r\n * @property {boolean} autoClose - The path is auto closed.\r\n * @property {Phaser.Types.Curves.JSONCurve[]} curves - The list of the curves\r\n */", "meta": { "filename": "JSONPath.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\curves\\typedefs", "code": {} }, "kind": "typedef", "name": "JSONPath", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The type of the path.", "name": "type" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the curve's starting point.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the path's starting point.", "name": "y" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The path is auto closed.", "name": "autoClose" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Curves.JSONCurve", "type": "NameExpression" } ] } }, "description": "The list of the curves", "name": "curves" } ], "memberof": "Phaser.Types.Curves", "longname": "Phaser.Types.Curves.JSONPath", "scope": "static", "___id": "T000002R004360", "___s": true }, { "comment": "/**\r\n * @callback DataEachCallback\r\n *\r\n * @param {*} parent - The parent object of the DataManager.\r\n * @param {string} key - The key of the value.\r\n * @param {*} value - The value.\r\n * @param {...*} [args] - Additional arguments that will be passed to the callback, after the game object, key, and data.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "kind": "typedef", "name": "DataEachCallback", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The parent object of the DataManager.", "name": "parent" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the value.", "name": "key" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value.", "name": "value" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "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", "___id": "T000002R004363", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Data Manager provides a way to store, retrieve, and manage arbitrary key-value data on any\r\n * Game Object, System, or Plugin. Each entry is stored by a string key and can hold any value type.\r\n *\r\n * Data changes are communicated through events: a `setdata` event fires when a new key is created,\r\n * and `changedata` / `changedata-key` events fire when an existing value is updated. This makes the\r\n * Data Manager well suited for driving UI, triggering game logic, or syncing state between systems.\r\n *\r\n * The parent object must either extend `EventEmitter` directly, or expose a property called `events`\r\n * that is an instance of `EventEmitter`.\r\n *\r\n * @class DataManager\r\n * @memberof Phaser.Data\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {object} parent - The object that this DataManager belongs to.\r\n * @param {Phaser.Events.EventEmitter} [eventEmitter] - The DataManager's event emitter.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "classdesc": "The Data Manager provides a way to store, retrieve, and manage arbitrary key-value data on any\rGame Object, System, or Plugin. Each entry is stored by a string key and can hold any value type.\r\rData changes are communicated through events: a `setdata` event fires when a new key is created,\rand `changedata` / `changedata-key` events fire when an existing value is updated. This makes the\rData Manager well suited for driving UI, triggering game logic, or syncing state between systems.\r\rThe parent object must either extend `EventEmitter` directly, or expose a property called `events`\rthat is an instance of `EventEmitter`.", "kind": "class", "name": "DataManager", "memberof": "Phaser.Data", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The object that this DataManager belongs to.", "name": "parent" }, { "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "optional": true, "description": "The DataManager's event emitter.", "name": "eventEmitter" } ], "scope": "static", "longname": "Phaser.Data.DataManager", "___id": "T000002R004364", "___s": true }, { "comment": "/**\r\n * The object that this DataManager belongs to.\r\n *\r\n * @name Phaser.Data.DataManager#parent\r\n * @type {*}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DataManager.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "The object that this DataManager belongs to.", "name": "parent", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#parent", "scope": "instance", "kind": "member", "___id": "T000002R004367", "___s": true }, { "comment": "/**\r\n * The DataManager's event emitter.\r\n *\r\n * @name Phaser.Data.DataManager#events\r\n * @type {Phaser.Events.EventEmitter}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DataManager.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "The DataManager's event emitter.", "name": "events", "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "since": "3.0.0", "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#events", "scope": "instance", "kind": "member", "___id": "T000002R004369", "___s": true }, { "comment": "/**\r\n * The data list.\r\n *\r\n * @name Phaser.Data.DataManager#list\r\n * @type {Object.}\r\n * @default {}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DataManager.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "The data list.", "name": "list", "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "AllLiteral" } ] } }, "defaultvalue": "{}", "since": "3.0.0", "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#list", "scope": "instance", "kind": "member", "___id": "T000002R004372", "___s": true }, { "comment": "/**\r\n * The public values list. You can use this to access anything you have stored\r\n * in this Data Manager. For example, if you set a value called `gold` you can\r\n * access it via:\r\n *\r\n * ```javascript\r\n * this.data.values.gold;\r\n * ```\r\n *\r\n * You can also modify it directly:\r\n *\r\n * ```javascript\r\n * this.data.values.gold += 1000;\r\n * ```\r\n *\r\n * Doing so will emit a `changedata` event from the parent of this Data Manager.\r\n *\r\n * Do not modify this object directly. Adding properties directly to this object will not\r\n * emit any events. Always use `DataManager.set` to create new items the first time around.\r\n *\r\n * @name Phaser.Data.DataManager#values\r\n * @type {Object.}\r\n * @default {}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "DataManager.js", "lineno": 78, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "The public values list. You can use this to access anything you have stored\rin this Data Manager. For example, if you set a value called `gold` you can\raccess it via:\r\r```javascript\rthis.data.values.gold;\r```\r\rYou can also modify it directly:\r\r```javascript\rthis.data.values.gold += 1000;\r```\r\rDoing so will emit a `changedata` event from the parent of this Data Manager.\r\rDo not modify this object directly. Adding properties directly to this object will not\remit any events. Always use `DataManager.set` to create new items the first time around.", "name": "values", "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "AllLiteral" } ] } }, "defaultvalue": "{}", "since": "3.10.0", "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#values", "scope": "instance", "kind": "member", "___id": "T000002R004374", "___s": true }, { "comment": "/**\r\n * Retrieves the value for the given key, or undefined if it doesn't exist.\r\n *\r\n * You can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\r\n *\r\n * ```javascript\r\n * this.data.get('gold');\r\n * ```\r\n *\r\n * Or access the value directly:\r\n *\r\n * ```javascript\r\n * this.data.values.gold;\r\n * ```\r\n *\r\n * You can also pass in an array of keys, in which case an array of values will be returned:\r\n *\r\n * ```javascript\r\n * this.data.get([ 'gold', 'armor', 'health' ]);\r\n * ```\r\n *\r\n * This approach is useful for destructuring arrays in ES6.\r\n *\r\n * @method Phaser.Data.DataManager#get\r\n * @since 3.0.0\r\n *\r\n * @param {(string|string[])} key - The key of the value to retrieve, or an array of keys.\r\n *\r\n * @return {*} The value belonging to the given key, or an array of values, the order of which will match the input array.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 122, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Retrieves the value for the given key, or undefined if it doesn't exist.\r\rYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\r\r```javascript\rthis.data.get('gold');\r```\r\rOr access the value directly:\r\r```javascript\rthis.data.values.gold;\r```\r\rYou can also pass in an array of keys, in which case an array of values will be returned:\r\r```javascript\rthis.data.get([ 'gold', 'armor', 'health' ]);\r```\r\rThis approach is useful for destructuring arrays in ES6.", "kind": "function", "name": "get", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "description": "The key of the value to retrieve, or an array of keys.", "name": "key" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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", "___id": "T000002R004378", "___s": true }, { "comment": "/**\r\n * Retrieves all data values in a new object.\r\n *\r\n * @method Phaser.Data.DataManager#getAll\r\n * @since 3.0.0\r\n *\r\n * @return {Object.} All data values.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 173, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Retrieves all data values in a new object.", "kind": "function", "name": "getAll", "since": "3.0.0", "returns": [ { "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "AllLiteral" } ] } }, "description": "All data values." } ], "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#getAll", "scope": "instance", "___id": "T000002R004383", "___s": true }, { "comment": "/**\r\n * Queries the DataManager for the values of keys matching the given regular expression.\r\n *\r\n * @method Phaser.Data.DataManager#query\r\n * @since 3.0.0\r\n *\r\n * @param {RegExp} search - A regular expression object. If a non-RegExp object obj is passed, it is implicitly converted to a RegExp by using new RegExp(obj).\r\n *\r\n * @return {Object.} The values of the keys matching the search string.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 196, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "AllLiteral" } ] } }, "description": "The values of the keys matching the search string." } ], "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#query", "scope": "instance", "___id": "T000002R004388", "___s": true }, { "comment": "/**\r\n * Sets a value for the given key. If the key doesn't already exist in the Data Manager then it is created.\r\n *\r\n * ```javascript\r\n * data.set('name', 'Red Gem Stone');\r\n * ```\r\n *\r\n * You can also pass in an object of key value pairs as the first argument:\r\n *\r\n * ```javascript\r\n * data.set({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\r\n * ```\r\n *\r\n * To get a value back again you can call `get`:\r\n *\r\n * ```javascript\r\n * data.get('gold');\r\n * ```\r\n *\r\n * Or you can access the value directly via the `values` property, where it works like any other variable:\r\n *\r\n * ```javascript\r\n * data.values.gold += 50;\r\n * ```\r\n *\r\n * When the value is first set, a `setdata` event is emitted.\r\n *\r\n * If the key already exists, a `changedata` event is emitted instead, along an event named after the key.\r\n * For example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\r\n * These events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\r\n *\r\n * Please note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\r\n * This means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.\r\n *\r\n * @method Phaser.Data.DataManager#set\r\n * @fires Phaser.Data.Events#SET_DATA\r\n * @fires Phaser.Data.Events#CHANGE_DATA\r\n * @fires Phaser.Data.Events#CHANGE_DATA_KEY\r\n * @since 3.0.0\r\n *\r\n * @generic {any} T\r\n * @genericUse {(string|T)} - [key]\r\n *\r\n * @param {(string|object)} key - The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.\r\n * @param {*} [data] - The value to set for the given key. If an object is provided as the key this argument is ignored.\r\n *\r\n * @return {this} This Data Manager instance.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 221, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Sets a value for the given key. If the key doesn't already exist in the Data Manager then it is created.\r\r```javascript\rdata.set('name', 'Red Gem Stone');\r```\r\rYou can also pass in an object of key value pairs as the first argument:\r\r```javascript\rdata.set({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\r```\r\rTo get a value back again you can call `get`:\r\r```javascript\rdata.get('gold');\r```\r\rOr you can access the value directly via the `values` property, where it works like any other variable:\r\r```javascript\rdata.values.gold += 50;\r```\r\rWhen the value is first set, a `setdata` event is emitted.\r\rIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\rFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\rThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\r\rPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\rThis 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{any} T", "value": "{any} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(string|T)} - [key]", "value": "{(string|T)} - [key]" } ], "params": [ { "type": { "names": [ "string", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "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": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#set", "scope": "instance", "___id": "T000002R004393", "___s": true }, { "comment": "/**\r\n * Increases a value for the given key. If the key doesn't already exist in the Data Manager then it is created with a value of 0 before being increased.\r\n *\r\n * When the key is first created, a `setdata` event is emitted. If the key already exists, a `changedata` event\r\n * and a `changedata-key` event are emitted instead, where `key` is replaced with the actual key name.\r\n *\r\n * @method Phaser.Data.DataManager#inc\r\n * @fires Phaser.Data.Events#SET_DATA\r\n * @fires Phaser.Data.Events#CHANGE_DATA\r\n * @fires Phaser.Data.Events#CHANGE_DATA_KEY\r\n * @since 3.23.0\r\n *\r\n * @param {string} key - The key to change the value for.\r\n * @param {number} [amount=1] - The amount to increase the given key by. Pass a negative value to decrease the key.\r\n *\r\n * @return {this} This Data Manager instance.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 291, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Increases a value for the given key. If the key doesn't already exist in the Data Manager then it is created with a value of 0 before being increased.\r\rWhen the key is first created, a `setdata` event is emitted. If the key already exists, a `changedata` event\rand a `changedata-key` event are emitted instead, where `key` is replaced with the actual key name.", "kind": "function", "name": "inc", "fires": [ "Phaser.Data.Events#event:SET_DATA", "Phaser.Data.Events#event:CHANGE_DATA", "Phaser.Data.Events#event:CHANGE_DATA_KEY" ], "since": "3.23.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to change the value for.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount to increase the given key by. Pass a negative value to decrease the key.", "name": "amount" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#inc", "scope": "instance", "___id": "T000002R004396", "___s": true }, { "comment": "/**\r\n * Toggles a boolean value for the given key. If the key doesn't already exist in the Data Manager then it is created with a value of `false` before being toggled.\r\n *\r\n * When the key is first created, a `setdata` event is emitted. If the key already exists, a `changedata` event\r\n * and a `changedata-key` event are emitted instead, where `key` is replaced with the actual key name.\r\n *\r\n * @method Phaser.Data.DataManager#toggle\r\n * @fires Phaser.Data.Events#SET_DATA\r\n * @fires Phaser.Data.Events#CHANGE_DATA\r\n * @fires Phaser.Data.Events#CHANGE_DATA_KEY\r\n * @since 3.23.0\r\n *\r\n * @param {string} key - The key to toggle the value for.\r\n *\r\n * @return {this} This Data Manager instance.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Toggles a boolean value for the given key. If the key doesn't already exist in the Data Manager then it is created with a value of `false` before being toggled.\r\rWhen the key is first created, a `setdata` event is emitted. If the key already exists, a `changedata` event\rand a `changedata-key` event are emitted instead, where `key` is replaced with the actual key name.", "kind": "function", "name": "toggle", "fires": [ "Phaser.Data.Events#event:SET_DATA", "Phaser.Data.Events#event:CHANGE_DATA", "Phaser.Data.Events#event:CHANGE_DATA_KEY" ], "since": "3.23.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#toggle", "scope": "instance", "___id": "T000002R004401", "___s": true }, { "comment": "/**\r\n * Passes all data entries to the given callback. The callback is invoked for every entry in the\r\n * Data Manager, receiving the parent object, the key, the value, and any additional arguments\r\n * provided to this method.\r\n *\r\n * @method Phaser.Data.DataManager#each\r\n * @since 3.0.0\r\n *\r\n * @param {DataEachCallback} callback - The function to call.\r\n * @param {*} [context] - Value to use as `this` when executing callback.\r\n * @param {...*} [args] - Additional arguments that will be passed to the callback, after the game object, key, and data.\r\n *\r\n * @return {this} This Data Manager instance.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 427, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Passes all data entries to the given callback. The callback is invoked for every entry in the\rData Manager, receiving the parent object, the key, the value, and any additional arguments\rprovided to this method.", "kind": "function", "name": "each", "since": "3.0.0", "params": [ { "type": { "names": [ "DataEachCallback" ], "parsedType": { "type": "NameExpression", "name": "DataEachCallback" } }, "description": "The function to call.", "name": "callback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "Value to use as `this` when executing callback.", "name": "context" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#each", "scope": "instance", "___id": "T000002R004417", "___s": true }, { "comment": "/**\r\n * Merge the given object of key value pairs into this DataManager.\r\n *\r\n * Any newly created values will emit a `setdata` event. Any updated values (see the `overwrite` argument)\r\n * will emit a `changedata` event.\r\n *\r\n * @method Phaser.Data.DataManager#merge\r\n * @fires Phaser.Data.Events#SET_DATA\r\n * @fires Phaser.Data.Events#CHANGE_DATA\r\n * @fires Phaser.Data.Events#CHANGE_DATA_KEY\r\n * @since 3.0.0\r\n *\r\n * @param {Object.} data - The data to merge.\r\n * @param {boolean} [overwrite=true] - Whether to overwrite existing data. Defaults to true.\r\n *\r\n * @return {this} This Data Manager instance.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 461, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Merge the given object of key value pairs into this DataManager.\r\rAny newly created values will emit a `setdata` event. Any updated values (see the `overwrite` argument)\rwill 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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "AllLiteral" } ] } }, "description": "The data to merge.", "name": "data" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether to overwrite existing data. Defaults to true.", "name": "overwrite" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#merge", "scope": "instance", "___id": "T000002R004424", "___s": true }, { "comment": "/**\r\n * Remove the value for the given key.\r\n *\r\n * If the key is found in this Data Manager it is removed from the internal lists and a\r\n * `removedata` event is emitted.\r\n *\r\n * You can also pass in an array of keys, in which case all keys in the array will be removed:\r\n *\r\n * ```javascript\r\n * this.data.remove([ 'gold', 'armor', 'health' ]);\r\n * ```\r\n *\r\n * @method Phaser.Data.DataManager#remove\r\n * @fires Phaser.Data.Events#REMOVE_DATA\r\n * @since 3.0.0\r\n *\r\n * @param {(string|string[])} key - The key to remove, or an array of keys to remove.\r\n *\r\n * @return {this} This Data Manager instance.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Remove the value for the given key.\r\rIf the key is found in this Data Manager it is removed from the internal lists and a\r`removedata` event is emitted.\r\rYou can also pass in an array of keys, in which case all keys in the array will be removed:\r\r```javascript\rthis.data.remove([ 'gold', 'armor', 'health' ]);\r```", "kind": "function", "name": "remove", "fires": [ "Phaser.Data.Events#event:REMOVE_DATA" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "description": "The key to remove, or an array of keys to remove.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#remove", "scope": "instance", "___id": "T000002R004428", "___s": true }, { "comment": "/**\r\n * Retrieves the data associated with the given 'key', deletes it from this Data Manager, then returns it.\r\n *\r\n * @method Phaser.Data.DataManager#pop\r\n * @fires Phaser.Data.Events#REMOVE_DATA\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key of the value to retrieve and delete.\r\n *\r\n * @return {*} The value of the given key.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 563, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the value to retrieve and delete.", "name": "key" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value of the given key." } ], "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#pop", "scope": "instance", "___id": "T000002R004434", "___s": true }, { "comment": "/**\r\n * Determines whether the given key is set in this Data Manager.\r\n *\r\n * Please note that the keys are case-sensitive and must be valid JavaScript Object property strings.\r\n * This means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.\r\n *\r\n * @method Phaser.Data.DataManager#has\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key to check.\r\n *\r\n * @return {boolean} Returns `true` if the key exists, otherwise `false`.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 591, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Determines whether the given key is set in this Data Manager.\r\rPlease note that the keys are case-sensitive and must be valid JavaScript Object property strings.\rThis 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to check.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if the key exists, otherwise `false`." } ], "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#has", "scope": "instance", "___id": "T000002R004438", "___s": true }, { "comment": "/**\r\n * Freeze or unfreeze this Data Manager. A frozen Data Manager will block all attempts\r\n * to create new values or update existing ones.\r\n *\r\n * @method Phaser.Data.DataManager#setFreeze\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - Whether to freeze or unfreeze the Data Manager.\r\n *\r\n * @return {this} This Data Manager instance.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 609, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Freeze or unfreeze this Data Manager. A frozen Data Manager will block all attempts\rto create new values or update existing ones.", "kind": "function", "name": "setFreeze", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to freeze or unfreeze the Data Manager.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#setFreeze", "scope": "instance", "___id": "T000002R004440", "___s": true }, { "comment": "/**\r\n * Delete all data in this Data Manager and unfreeze it.\r\n *\r\n * @method Phaser.Data.DataManager#reset\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Data Manager instance.\r\n */", "meta": { "filename": "DataManager.js", "lineno": 627, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Delete all data in this Data Manager and unfreeze it.", "kind": "function", "name": "reset", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Data Manager instance." } ], "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#reset", "scope": "instance", "___id": "T000002R004443", "___s": true }, { "comment": "/**\r\n * Destroys this Data Manager. All stored data is deleted, all event listeners are removed,\r\n * and the reference to the parent object is cleared. This is called automatically when the\r\n * parent emits a `destroy` event.\r\n *\r\n * @method Phaser.Data.DataManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DataManager.js", "lineno": 648, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Destroys this Data Manager. All stored data is deleted, all event listeners are removed,\rand the reference to the parent object is cleared. This is called automatically when the\rparent emits a `destroy` event.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#destroy", "scope": "instance", "___id": "T000002R004447", "___s": true }, { "comment": "/**\r\n * Gets or sets the frozen state of this Data Manager.\r\n * A frozen Data Manager will block all attempts to create new values or update existing ones.\r\n *\r\n * @name Phaser.Data.DataManager#freeze\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DataManager.js", "lineno": 667, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Gets or sets the frozen state of this Data Manager.\rA frozen Data Manager will block all attempts to create new values or update existing ones.", "name": "freeze", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#freeze", "scope": "instance", "kind": "member", "___id": "T000002R004450", "___s": true }, { "comment": "/**\r\n * Return the total number of entries in this Data Manager.\r\n *\r\n * @name Phaser.Data.DataManager#count\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DataManager.js", "lineno": 689, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Return the total number of entries in this Data Manager.", "name": "count", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Data.DataManager", "longname": "Phaser.Data.DataManager#count", "scope": "instance", "kind": "member", "___id": "T000002R004455", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Data Manager Plugin is a Scene Plugin that provides data storage and retrieval\r\n * functionality for a Scene, integrated with the Scene lifecycle. It extends the base DataManager\r\n * class with automatic event handling for Scene shutdown and destroy events, ensuring that stored\r\n * data and event listeners are properly cleaned up when the Scene stops or is destroyed.\r\n * It is accessed via `scene.data` within any Scene.\r\n *\r\n * @class DataManagerPlugin\r\n * @extends Phaser.Data.DataManager\r\n * @memberof Phaser.Data\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - A reference to the Scene that this DataManager belongs to.\r\n */", "meta": { "filename": "DataManagerPlugin.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "classdesc": "The Data Manager Plugin is a Scene Plugin that provides data storage and retrieval\rfunctionality for a Scene, integrated with the Scene lifecycle. It extends the base DataManager\rclass with automatic event handling for Scene shutdown and destroy events, ensuring that stored\rdata and event listeners are properly cleaned up when the Scene stops or is destroyed.\rIt is accessed via `scene.data` within any Scene.", "kind": "class", "name": "DataManagerPlugin", "augments": [ "Phaser.Data.DataManager" ], "memberof": "Phaser.Data", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "A reference to the Scene that this DataManager belongs to.", "name": "scene" } ], "scope": "static", "longname": "Phaser.Data.DataManagerPlugin", "___id": "T000002R004465", "___s": true }, { "comment": "/**\r\n * A reference to the Scene that this DataManager belongs to.\r\n *\r\n * @name Phaser.Data.DataManagerPlugin#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DataManagerPlugin.js", "lineno": 38, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "A reference to the Scene that this DataManager belongs to.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Data.DataManagerPlugin", "longname": "Phaser.Data.DataManagerPlugin#scene", "scope": "instance", "kind": "member", "___id": "T000002R004469", "___s": true }, { "comment": "/**\r\n * A reference to the Scene's Systems.\r\n *\r\n * @name Phaser.Data.DataManagerPlugin#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DataManagerPlugin.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "A reference to the Scene's Systems.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.0.0", "memberof": "Phaser.Data.DataManagerPlugin", "longname": "Phaser.Data.DataManagerPlugin#systems", "scope": "instance", "kind": "member", "___id": "T000002R004471", "___s": true }, { "comment": "/**\r\n * Destroys this DataManagerPlugin, calling the base DataManager destroy method,\r\n * removing all Scene event listeners, and clearing all internal references.\r\n * This is called automatically when the owning Scene is destroyed.\r\n *\r\n * @method Phaser.Data.DataManagerPlugin#destroy\r\n * @since 3.5.0\r\n */", "meta": { "filename": "DataManagerPlugin.js", "lineno": 102, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "description": "Destroys this DataManagerPlugin, calling the base DataManager destroy method,\rremoving all Scene event listeners, and clearing all internal references.\rThis is called automatically when the owning Scene is destroyed.", "kind": "function", "name": "destroy", "since": "3.5.0", "memberof": "Phaser.Data.DataManagerPlugin", "longname": "Phaser.Data.DataManagerPlugin#destroy", "scope": "instance", "overrides": "Phaser.Data.DataManager#destroy", "___id": "T000002R004480", "___s": true }, { "comment": "/**\r\n * The Change Data Event.\r\n *\r\n * This event is dispatched by a Data Manager when an item in the data store is changed.\r\n *\r\n * Game Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\r\n * a change data event from a Game Object you would use: `sprite.on('changedata', listener)`.\r\n *\r\n * This event is dispatched for all items that change in the Data Manager.\r\n * To listen for the change of a specific item, use the `CHANGE_DATA_KEY_EVENT` event.\r\n *\r\n * @event Phaser.Data.Events#CHANGE_DATA\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {any} parent - A reference to the object that the Data Manager responsible for this event belongs to.\r\n * @param {string} key - The unique key of the data item within the Data Manager.\r\n * @param {any} value - The new value of the item in the Data Manager.\r\n * @param {any} previousValue - The previous value of the item in the Data Manager.\r\n */", "meta": { "filename": "CHANGE_DATA_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\data\\events", "code": {} }, "description": "The Change Data Event.\r\rThis event is dispatched by a Data Manager when an item in the data store is changed.\r\rGame Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\ra change data event from a Game Object you would use: `sprite.on('changedata', listener)`.\r\rThis event is dispatched for all items that change in the Data Manager.\rTo listen for the change of a specific item, use the `CHANGE_DATA_KEY_EVENT` event.", "kind": "event", "name": "CHANGE_DATA", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "A reference to the object that the Data Manager responsible for this event belongs to.", "name": "parent" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the data item within the Data Manager.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The new value of the item in the Data Manager.", "name": "value" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004485", "___s": true }, { "comment": "/**\r\n * The Change Data Key Event.\r\n *\r\n * This event is dispatched by a Data Manager when an item in the data store is changed.\r\n *\r\n * Game Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\r\n * the change of a specific data item from a Game Object you would use: `sprite.on('changedata-key', listener)`,\r\n * where `key` is the unique string key of the data item. For example, if you have a data item stored called `gold`\r\n * then you can listen for `sprite.on('changedata-gold')`.\r\n *\r\n * @event Phaser.Data.Events#CHANGE_DATA_KEY\r\n * @type {string}\r\n * @since 3.16.1\r\n *\r\n * @param {any} parent - A reference to the object that owns the instance of the Data Manager responsible for this event.\r\n * @param {any} value - 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.\r\n * @param {any} previousValue - 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.\r\n */", "meta": { "filename": "CHANGE_DATA_KEY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\data\\events", "code": {} }, "description": "The Change Data Key Event.\r\rThis event is dispatched by a Data Manager when an item in the data store is changed.\r\rGame Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\rthe change of a specific data item from a Game Object you would use: `sprite.on('changedata-key', listener)`,\rwhere `key` is the unique string key of the data item. For example, if you have a data item stored called `gold`\rthen you can listen for `sprite.on('changedata-gold')`.", "kind": "event", "name": "CHANGE_DATA_KEY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.1", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "A reference to the object that owns the instance of the Data Manager responsible for this event.", "name": "parent" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004487", "___s": true }, { "comment": "/**\r\n * The Data Manager Destroy Event.\r\n *\r\n * The Data Manager will listen for the destroy event from its parent, and then close itself down.\r\n *\r\n * @event Phaser.Data.Events#DESTROY\r\n * @type {string}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "DESTROY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\data\\events", "code": {} }, "description": "The Data Manager Destroy Event.\r\rThe Data Manager will listen for the destroy event from its parent, and then close itself down.", "kind": "event", "name": "DESTROY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "memberof": "Phaser.Data.Events", "longname": "Phaser.Data.Events#event:DESTROY", "scope": "instance", "___id": "T000002R004489", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Data.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\data\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Data", "longname": "Phaser.Data.Events", "scope": "static", "___id": "T000002R004491", "___s": true }, { "comment": "/**\r\n * The Remove Data Event.\r\n *\r\n * This event is dispatched by a Data Manager when an item is removed from it.\r\n *\r\n * Game Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\r\n * the removal of a data item on a Game Object you would use: `sprite.on('removedata', listener)`.\r\n *\r\n * @event Phaser.Data.Events#REMOVE_DATA\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {any} parent - A reference to the object that owns the instance of the Data Manager responsible for this event.\r\n * @param {string} key - The unique key of the data item within the Data Manager.\r\n * @param {any} data - 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.\r\n */", "meta": { "filename": "REMOVE_DATA_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\data\\events", "code": {} }, "description": "The Remove Data Event.\r\rThis event is dispatched by a Data Manager when an item is removed from it.\r\rGame Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\rthe removal of a data item on a Game Object you would use: `sprite.on('removedata', listener)`.", "kind": "event", "name": "REMOVE_DATA", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "A reference to the object that owns the instance of the Data Manager responsible for this event.", "name": "parent" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the data item within the Data Manager.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004498", "___s": true }, { "comment": "/**\r\n * The Set Data Event.\r\n *\r\n * This event is dispatched by a Data Manager when a new item is added to the data store.\r\n *\r\n * Game Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\r\n * the addition of a new data item on a Game Object you would use: `sprite.on('setdata', listener)`.\r\n *\r\n * @event Phaser.Data.Events#SET_DATA\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {any} parent - A reference to the object that owns the instance of the Data Manager responsible for this event.\r\n * @param {string} key - The unique key of the data item within the Data Manager.\r\n * @param {any} data - 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.\r\n */", "meta": { "filename": "SET_DATA_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\data\\events", "code": {} }, "description": "The Set Data Event.\r\rThis event is dispatched by a Data Manager when a new item is added to the data store.\r\rGame Objects with data enabled have an instance of a Data Manager under the `data` property. So, to listen for\rthe addition of a new data item on a Game Object you would use: `sprite.on('setdata', listener)`.", "kind": "event", "name": "SET_DATA", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "A reference to the object that owns the instance of the Data Manager responsible for this event.", "name": "parent" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the data item within the Data Manager.", "name": "key" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004500", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Data\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\data", "code": {} }, "kind": "namespace", "name": "Data", "memberof": "Phaser", "longname": "Phaser.Data", "scope": "static", "___id": "T000002R004502", "___s": true }, { "comment": "/**\r\n * Determines the audio playback capabilities of the device running this Phaser Game instance.\r\n * These values are read-only and populated during the boot sequence of the game.\r\n * They are then referenced by internal game systems and are available for you to access\r\n * via `this.sys.game.device.audio` from within any Scene.\r\n *\r\n * @typedef {object} Phaser.Device.Audio\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} audioData - Can this device play HTML Audio tags?\r\n * @property {boolean} dolby - Can this device play EC-3 Dolby Digital Plus files?\r\n * @property {boolean} m4a - Can this device play m4a files?\r\n * @property {boolean} aac - Can this device play aac files?\r\n * @property {boolean} flac - Can this device play flac files?\r\n * @property {boolean} mp3 - Can this device play mp3 files?\r\n * @property {boolean} ogg - Can this device play ogg files?\r\n * @property {boolean} opus - Can this device play opus files?\r\n * @property {boolean} wav - Can this device play wav files?\r\n * @property {boolean} webAudio - Does this device have the Web Audio API?\r\n * @property {boolean} webm - Can this device play webm files?\r\n */", "meta": { "filename": "Audio.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\device", "code": {} }, "description": "Determines the audio playback capabilities of the device running this Phaser Game instance.\rThese values are read-only and populated during the boot sequence of the game.\rThey are then referenced by internal game systems and are available for you to access\rvia `this.sys.game.device.audio` from within any Scene.", "kind": "typedef", "name": "Audio", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play HTML Audio tags?", "name": "audioData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play EC-3 Dolby Digital Plus files?", "name": "dolby" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play m4a files?", "name": "m4a" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play aac files?", "name": "aac" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play flac files?", "name": "flac" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play mp3 files?", "name": "mp3" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play ogg files?", "name": "ogg" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play opus files?", "name": "opus" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play wav files?", "name": "wav" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does this device have the Web Audio API?", "name": "webAudio" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play webm files?", "name": "webm" } ], "memberof": "Phaser.Device", "longname": "Phaser.Device.Audio", "scope": "static", "___id": "T000002R004508", "___s": true }, { "comment": "/**\r\n * Determines the browser type and version running this Phaser Game instance.\r\n * These values are read-only and populated during the boot sequence of the game.\r\n * They are then referenced by internal game systems and are available for you to access\r\n * via `this.sys.game.device.browser` from within any Scene.\r\n *\r\n * @typedef {object} Phaser.Device.Browser\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} chrome - Set to true if running in Chrome.\r\n * @property {boolean} edge - Set to true if running in Microsoft Edge browser.\r\n * @property {boolean} firefox - Set to true if running in Firefox.\r\n * @property {boolean} ie - Set to true if running in Internet Explorer 11 or less (not Edge).\r\n * @property {boolean} mobileSafari - Set to true if running in Mobile Safari.\r\n * @property {boolean} opera - Set to true if running in Opera.\r\n * @property {boolean} safari - Set to true if running in Safari.\r\n * @property {boolean} silk - Set to true if running in the Silk browser (as used on the Amazon Kindle).\r\n * @property {boolean} trident - Set to true if running a Trident version of Internet Explorer (IE11 or earlier).\r\n * @property {boolean} es2019 - Set to true if the browser appears to support ES2019 features.\r\n * @property {number} chromeVersion - If running in Chrome this will contain the major version number.\r\n * @property {number} firefoxVersion - If running in Firefox this will contain the major version number.\r\n * @property {number} ieVersion - If running in Internet Explorer this will contain the major version number. Beyond IE10 you should use Browser.trident and Browser.tridentVersion.\r\n * @property {number} safariVersion - If running in Safari this will contain the major version number.\r\n * @property {number} tridentVersion - 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}\r\n */", "meta": { "filename": "Browser.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\device", "code": {} }, "description": "Determines the browser type and version running this Phaser Game instance.\rThese values are read-only and populated during the boot sequence of the game.\rThey are then referenced by internal game systems and are available for you to access\rvia `this.sys.game.device.browser` from within any Scene.", "kind": "typedef", "name": "Browser", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true if running in Chrome.", "name": "chrome" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true if running in Microsoft Edge browser.", "name": "edge" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true if running in Firefox.", "name": "firefox" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true if running in Internet Explorer 11 or less (not Edge).", "name": "ie" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true if running in Mobile Safari.", "name": "mobileSafari" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true if running in Opera.", "name": "opera" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true if running in Safari.", "name": "safari" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true if running in the Silk browser (as used on the Amazon Kindle).", "name": "silk" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true if running a Trident version of Internet Explorer (IE11 or earlier).", "name": "trident" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true if the browser appears to support ES2019 features.", "name": "es2019" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If running in Chrome this will contain the major version number.", "name": "chromeVersion" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If running in Firefox this will contain the major version number.", "name": "firefoxVersion" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If running in Safari this will contain the major version number.", "name": "safariVersion" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R004542", "___s": true }, { "comment": "/**\r\n * Determines the canvas features of the browser running this Phaser Game instance.\r\n * These values are read-only and populated during the boot sequence of the game.\r\n * They are then referenced by internal game systems and are available for you to access\r\n * via `this.sys.game.device.canvasFeatures` from within any Scene.\r\n *\r\n * @typedef {object} Phaser.Device.CanvasFeatures\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} supportInverseAlpha - Set to true if the browser supports inverted alpha.\r\n * @property {boolean} supportNewBlendModes - Set to true if the browser supports new canvas blend modes.\r\n */", "meta": { "filename": "CanvasFeatures.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\device", "code": {} }, "description": "Determines the canvas features of the browser running this Phaser Game instance.\rThese values are read-only and populated during the boot sequence of the game.\rThey are then referenced by internal game systems and are available for you to access\rvia `this.sys.game.device.canvasFeatures` from within any Scene.", "kind": "typedef", "name": "CanvasFeatures", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true if the browser supports inverted alpha.", "name": "supportInverseAlpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true if the browser supports new canvas blend modes.", "name": "supportNewBlendModes" } ], "memberof": "Phaser.Device", "longname": "Phaser.Device.CanvasFeatures", "scope": "static", "___id": "T000002R004585", "___s": true }, { "comment": "/**\r\n * Determines the features of the browser running this Phaser Game instance.\r\n * These values are read-only and populated during the boot sequence of the game.\r\n * They are then referenced by internal game systems and are available for you to access\r\n * via `this.sys.game.device.features` from within any Scene.\r\n *\r\n * @typedef {object} Phaser.Device.Features\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} canvas - Indicates whether the HTML5 Canvas API (CanvasRenderingContext2D) is available in this browser. Required for the Canvas renderer to function.\r\n * @property {?boolean} canvasBitBltShift - True if canvas supports a 'copy' bitblt onto itself when the source and destination regions overlap. This is used for fast pixel copy operations. Will be `null` if it could not be determined, `false` on iOS and Safari where it is known not to work.\r\n * @property {boolean} file - Indicates whether the File, FileReader, FileList, and Blob APIs are all available, enabling file reading operations within the browser.\r\n * @property {boolean} fileSystem - Indicates whether the FileSystem API (requestFileSystem) is available, allowing sandboxed local file storage access.\r\n * @property {boolean} getUserMedia - Indicates whether the getUserMedia API is available and functional. Used for accessing camera and microphone input. Note: older versions of Firefox (below 21) may report support but not actually work correctly.\r\n * @property {boolean} littleEndian - Indicates whether the device uses little-endian byte ordering. Only detected if the browser supports TypedArrays. Will be `null` if endianness could not be determined.\r\n * @property {boolean} localStorage - Indicates whether the Web Storage localStorage API is available for persisting key-value data between browser sessions.\r\n * @property {boolean} pointerLock - Indicates whether the Pointer Lock API is available, which allows the mouse cursor to be hidden and locked to the game canvas for first-person style input.\r\n * @property {boolean} stableSort - Indicates whether the browser's Array.sort implementation is stable, meaning equal elements retain their original relative order after sorting.\r\n * @property {boolean} support32bit - Indicates whether the device supports 32-bit pixel manipulation of canvas image data using ArrayBuffer and typed array views (Uint8ClampedArray / Int32Array). Requires little-endian byte ordering.\r\n * @property {boolean} vibration - Indicates whether the Vibration API is available, enabling haptic feedback on supported mobile devices.\r\n * @property {boolean} webGL - Indicates whether WebGL is available in this browser. Required for the WebGL renderer to function.\r\n * @property {boolean} worker - Indicates whether Web Workers are available, enabling background JavaScript execution on a separate thread.\r\n */", "meta": { "filename": "Features.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\device", "code": {} }, "description": "Determines the features of the browser running this Phaser Game instance.\rThese values are read-only and populated during the boot sequence of the game.\rThey are then referenced by internal game systems and are available for you to access\rvia `this.sys.game.device.features` from within any Scene.", "kind": "typedef", "name": "Features", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates whether the HTML5 Canvas API (CanvasRenderingContext2D) is available in this browser. Required for the Canvas renderer to function.", "name": "canvas" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "nullable": true, "description": "True if canvas supports a 'copy' bitblt onto itself when the source and destination regions overlap. This is used for fast pixel copy operations. Will be `null` if it could not be determined, `false` on iOS and Safari where it is known not to work.", "name": "canvasBitBltShift" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates whether the File, FileReader, FileList, and Blob APIs are all available, enabling file reading operations within the browser.", "name": "file" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates whether the FileSystem API (requestFileSystem) is available, allowing sandboxed local file storage access.", "name": "fileSystem" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates whether the getUserMedia API is available and functional. Used for accessing camera and microphone input. Note: older versions of Firefox (below 21) may report support but not actually work correctly.", "name": "getUserMedia" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates whether the device uses little-endian byte ordering. Only detected if the browser supports TypedArrays. Will be `null` if endianness could not be determined.", "name": "littleEndian" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates whether the Web Storage localStorage API is available for persisting key-value data between browser sessions.", "name": "localStorage" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates whether the Pointer Lock API is available, which allows the mouse cursor to be hidden and locked to the game canvas for first-person style input.", "name": "pointerLock" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates whether the browser's Array.sort implementation is stable, meaning equal elements retain their original relative order after sorting.", "name": "stableSort" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates whether the device supports 32-bit pixel manipulation of canvas image data using ArrayBuffer and typed array views (Uint8ClampedArray / Int32Array). Requires little-endian byte ordering.", "name": "support32bit" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates whether the Vibration API is available, enabling haptic feedback on supported mobile devices.", "name": "vibration" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates whether WebGL is available in this browser. Required for the WebGL renderer to function.", "name": "webGL" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Indicates whether Web Workers are available, enabling background JavaScript execution on a separate thread.", "name": "worker" } ], "memberof": "Phaser.Device", "longname": "Phaser.Device.Features", "scope": "static", "___id": "T000002R004619", "___s": true }, { "comment": "/**\r\n * Determines the full screen support of the browser running this Phaser Game instance.\r\n * These values are read-only and populated during the boot sequence of the game.\r\n * They are then referenced by internal game systems and are available for you to access\r\n * via `this.sys.game.device.fullscreen` from within any Scene.\r\n *\r\n * @typedef {object} Phaser.Device.Fullscreen\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} available - Does the browser support the Full Screen API?\r\n * @property {boolean} keyboard - Does the browser support access to the Keyboard during Full Screen mode?\r\n * @property {boolean} active - Is the browser currently in fullscreen mode? This is a read-only getter that checks the various vendor-prefixed fullscreen element properties on the document.\r\n * @property {string} cancel - If the browser supports the Full Screen API, this holds the name of the method to call on the document in order to exit fullscreen mode.\r\n * @property {string} request - If the browser supports the Full Screen API, this holds the name of the method to call on a DOM element in order to request fullscreen mode.\r\n */", "meta": { "filename": "Fullscreen.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\device", "code": {} }, "description": "Determines the full screen support of the browser running this Phaser Game instance.\rThese values are read-only and populated during the boot sequence of the game.\rThey are then referenced by internal game systems and are available for you to access\rvia `this.sys.game.device.fullscreen` from within any Scene.", "kind": "typedef", "name": "Fullscreen", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does the browser support the Full Screen API?", "name": "available" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does the browser support access to the Keyboard during Full Screen mode?", "name": "keyboard" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is the browser currently in fullscreen mode? This is a read-only getter that checks the various vendor-prefixed fullscreen element properties on the document.", "name": "active" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "If the browser supports the Full Screen API, this holds the name of the method to call on the document in order to exit fullscreen mode.", "name": "cancel" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "If the browser supports the Full Screen API, this holds the name of the method to call on a DOM element in order to request fullscreen mode.", "name": "request" } ], "memberof": "Phaser.Device", "longname": "Phaser.Device.Fullscreen", "scope": "static", "___id": "T000002R004671", "___s": true }, { "comment": "/**\r\n * The Device class is a collection of properties and functions that describe the device on which the Phaser Game instance is running.\r\n *\r\n * These values are read-only and populated during the boot sequence of the game. They are then referenced by internal game systems and are available for you to access\r\n * via `this.sys.game.device` from within any Scene.\r\n *\r\n * @namespace Phaser.Device\r\n * @since 3.0.0\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\device", "code": {} }, "description": "The Device class is a collection of properties and functions that describe the device on which the Phaser Game instance is running.\r\rThese values are read-only and populated during the boot sequence of the game. They are then referenced by internal game systems and are available for you to access\rvia `this.sys.game.device` from within any Scene.", "kind": "namespace", "name": "Device", "since": "3.0.0", "memberof": "Phaser", "longname": "Phaser.Device", "scope": "static", "___id": "T000002R004691", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.DeviceConf\r\n *\r\n * @property {Phaser.Device.OS} os - The OS Device functions.\r\n * @property {Phaser.Device.Browser} browser - The Browser Device functions.\r\n * @property {Phaser.Device.Features} features - The Features Device functions.\r\n * @property {Phaser.Device.Input} input - The Input Device functions.\r\n * @property {Phaser.Device.Audio} audio - The Audio Device functions.\r\n * @property {Phaser.Device.Video} video - The Video Device functions.\r\n * @property {Phaser.Device.Fullscreen} fullscreen - The Fullscreen Device functions.\r\n * @property {Phaser.Device.CanvasFeatures} canvasFeatures - The Canvas Device functions.\r\n */", "meta": { "filename": "index.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\device", "code": {} }, "kind": "typedef", "name": "DeviceConf", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "properties": [ { "type": { "names": [ "Phaser.Device.OS" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Device.OS" } }, "description": "The OS Device functions.", "name": "os" }, { "type": { "names": [ "Phaser.Device.Browser" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Device.Browser" } }, "description": "The Browser Device functions.", "name": "browser" }, { "type": { "names": [ "Phaser.Device.Features" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Device.Features" } }, "description": "The Features Device functions.", "name": "features" }, { "type": { "names": [ "Phaser.Device.Input" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Device.Input" } }, "description": "The Input Device functions.", "name": "input" }, { "type": { "names": [ "Phaser.Device.Audio" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Device.Audio" } }, "description": "The Audio Device functions.", "name": "audio" }, { "type": { "names": [ "Phaser.Device.Video" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Device.Video" } }, "description": "The Video Device functions.", "name": "video" }, { "type": { "names": [ "Phaser.Device.Fullscreen" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Device.Fullscreen" } }, "description": "The Fullscreen Device functions.", "name": "fullscreen" }, { "type": { "names": [ "Phaser.Device.CanvasFeatures" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Device.CanvasFeatures" } }, "description": "The Canvas Device functions.", "name": "canvasFeatures" } ], "memberof": "Phaser", "longname": "Phaser.DeviceConf", "scope": "static", "___id": "T000002R004692", "___s": true }, { "comment": "/**\r\n * Determines the input support of the browser running this Phaser Game instance.\r\n * These values are read-only and populated during the boot sequence of the game.\r\n * They are then referenced by internal game systems and are available for you to access\r\n * via `this.sys.game.device.input` from within any Scene.\r\n *\r\n * @typedef {object} Phaser.Device.Input\r\n * @since 3.0.0\r\n *\r\n * @property {?string} wheelEvent - The most modern wheel/scroll event type supported by the browser: `'wheel'` (DOM3), `'mousewheel'` (legacy Chrome/IE/Safari), or `'DOMMouseScroll'` (legacy Firefox). `null` if no wheel event is supported.\r\n * @property {boolean} gamepads - Whether the Gamepad API (`navigator.getGamepads`) is available in this browser, allowing gamepad input to be read.\r\n * @property {boolean} mspointer - Whether the Microsoft Pointer API (`navigator.msPointerEnabled` or `navigator.pointerEnabled`) is available, used for pointer input on older IE/Edge browsers.\r\n * @property {boolean} touch - Whether touch input is supported, detected via the `ontouchstart` event or `navigator.maxTouchPoints`.\r\n */", "meta": { "filename": "Input.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\device", "code": {} }, "description": "Determines the input support of the browser running this Phaser Game instance.\rThese values are read-only and populated during the boot sequence of the game.\rThey are then referenced by internal game systems and are available for you to access\rvia `this.sys.game.device.input` from within any Scene.", "kind": "typedef", "name": "Input", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "nullable": true, "description": "The most modern wheel/scroll event type supported by the browser: `'wheel'` (DOM3), `'mousewheel'` (legacy Chrome/IE/Safari), or `'DOMMouseScroll'` (legacy Firefox). `null` if no wheel event is supported.", "name": "wheelEvent" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the Gamepad API (`navigator.getGamepads`) is available in this browser, allowing gamepad input to be read.", "name": "gamepads" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the Microsoft Pointer API (`navigator.msPointerEnabled` or `navigator.pointerEnabled`) is available, used for pointer input on older IE/Edge browsers.", "name": "mspointer" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether touch input is supported, detected via the `ontouchstart` event or `navigator.maxTouchPoints`.", "name": "touch" } ], "memberof": "Phaser.Device", "longname": "Phaser.Device.Input", "scope": "static", "___id": "T000002R004703", "___s": true }, { "comment": "/**\r\n * Determines the operating system of the device running this Phaser Game instance.\r\n * These values are read-only and populated during the boot sequence of the game.\r\n * They are then referenced by internal game systems and are available for you to access\r\n * via `this.sys.game.device.os` from within any Scene.\r\n *\r\n * @typedef {object} Phaser.Device.OS\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} android - Is running on Android?\r\n * @property {boolean} chromeOS - Is running on chromeOS?\r\n * @property {boolean} cordova - Is the game running under Apache Cordova?\r\n * @property {boolean} crosswalk - Is the game running under the Intel Crosswalk XDK?\r\n * @property {boolean} desktop - Is running on a desktop?\r\n * @property {boolean} ejecta - Is the game running under Ejecta?\r\n * @property {boolean} electron - Is the game running under GitHub Electron?\r\n * @property {boolean} iOS - Is running on iOS?\r\n * @property {boolean} iPad - Is running on iPad?\r\n * @property {boolean} iPhone - Is running on iPhone?\r\n * @property {boolean} kindle - Is running on an Amazon Kindle?\r\n * @property {boolean} linux - Is running on Linux?\r\n * @property {boolean} macOS - Is running on macOS?\r\n * @property {boolean} node - Is the game running under Node.js?\r\n * @property {boolean} nodeWebkit - Is the game running under Node-Webkit?\r\n * @property {boolean} webApp - Set to true if running as a WebApp, i.e. within a WebView\r\n * @property {boolean} windows - Is running on Windows?\r\n * @property {boolean} windowsPhone - Is running on a Windows Phone?\r\n * @property {number} iOSVersion - If running in iOS this will contain the major version number.\r\n * @property {number} pixelRatio - The pixel ratio of the host device.\r\n */", "meta": { "filename": "OS.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\device", "code": {} }, "description": "Determines the operating system of the device running this Phaser Game instance.\rThese values are read-only and populated during the boot sequence of the game.\rThey are then referenced by internal game systems and are available for you to access\rvia `this.sys.game.device.os` from within any Scene.", "kind": "typedef", "name": "OS", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is running on Android?", "name": "android" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is running on chromeOS?", "name": "chromeOS" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is the game running under Apache Cordova?", "name": "cordova" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is the game running under the Intel Crosswalk XDK?", "name": "crosswalk" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is running on a desktop?", "name": "desktop" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is the game running under Ejecta?", "name": "ejecta" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is the game running under GitHub Electron?", "name": "electron" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is running on iOS?", "name": "iOS" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is running on iPad?", "name": "iPad" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is running on iPhone?", "name": "iPhone" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is running on an Amazon Kindle?", "name": "kindle" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is running on Linux?", "name": "linux" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is running on macOS?", "name": "macOS" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is the game running under Node.js?", "name": "node" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is the game running under Node-Webkit?", "name": "nodeWebkit" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to true if running as a WebApp, i.e. within a WebView", "name": "webApp" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is running on Windows?", "name": "windows" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is running on a Windows Phone?", "name": "windowsPhone" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If running in iOS this will contain the major version number.", "name": "iOSVersion" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The pixel ratio of the host device.", "name": "pixelRatio" } ], "memberof": "Phaser.Device", "longname": "Phaser.Device.OS", "scope": "static", "___id": "T000002R004717", "___s": true }, { "comment": "/**\r\n * Determines the video support of the browser running this Phaser Game instance.\r\n *\r\n * These values are read-only and populated during the boot sequence of the game.\r\n *\r\n * They are then referenced by internal game systems and are available for you to access\r\n * via `this.sys.game.device.video` from within any Scene.\r\n *\r\n * @typedef {object} Phaser.Device.Video\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} h264 - Can this device play h264 mp4 video files?\r\n * @property {boolean} hls - Can this device play hls video files?\r\n * @property {boolean} mov - Can this device play mov video files?\r\n * @property {boolean} mp4 - Can this device play h264 mp4 video files?\r\n * @property {boolean} m4v - Can this device play m4v (typically mp4) video files?\r\n * @property {boolean} ogg - Can this device play ogg video files?\r\n * @property {boolean} vp9 - Can this device play vp9 video files?\r\n * @property {boolean} webm - Can this device play webm video files?\r\n * @property {boolean} hasRequestVideoFrame - Does this device support the `requestVideoFrameCallback` API?\r\n * @property {function} getVideoURL - Given an array of video URLs (or a single URL string), returns an object with `url` and `type` properties for the first entry that can be played by this browser, or `null` if none of the provided formats are supported.\r\n */", "meta": { "filename": "Video.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\device", "code": {} }, "description": "Determines the video support of the browser running this Phaser Game instance.\r\rThese values are read-only and populated during the boot sequence of the game.\r\rThey are then referenced by internal game systems and are available for you to access\rvia `this.sys.game.device.video` from within any Scene.", "kind": "typedef", "name": "Video", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play h264 mp4 video files?", "name": "h264" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play hls video files?", "name": "hls" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play mov video files?", "name": "mov" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play h264 mp4 video files?", "name": "mp4" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play m4v (typically mp4) video files?", "name": "m4v" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play ogg video files?", "name": "ogg" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play vp9 video files?", "name": "vp9" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Can this device play webm video files?", "name": "webm" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Does this device support the `requestVideoFrameCallback` API?", "name": "hasRequestVideoFrame" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "Given an array of video URLs (or a single URL string), returns an object with `url` and `type` properties for the first entry that can be played by this browser, or `null` if none of the provided formats are supported.", "name": "getVideoURL" } ], "memberof": "Phaser.Device", "longname": "Phaser.Device.Video", "scope": "static", "___id": "T000002R004772", "___s": true }, { "comment": "/**\r\n * A constant representing a top-left alignment or position.\r\n * @constant\r\n * @name Phaser.Display.Align.TOP_LEFT\r\n * @since 3.0.0\r\n * @type {number}\r\n */", "meta": { "filename": "const.js", "lineno": 9, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\align", "code": {} }, "description": "A constant representing a top-left alignment or position.", "kind": "constant", "name": "TOP_LEFT", "since": "3.0.0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.TOP_LEFT", "scope": "static", "___id": "T000002R004809", "___s": true }, { "comment": "/**\r\n * A constant representing a top-center alignment or position.\r\n * @constant\r\n * @name Phaser.Display.Align.TOP_CENTER\r\n * @since 3.0.0\r\n * @type {number}\r\n */", "meta": { "filename": "const.js", "lineno": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\align", "code": {} }, "description": "A constant representing a top-center alignment or position.", "kind": "constant", "name": "TOP_CENTER", "since": "3.0.0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.TOP_CENTER", "scope": "static", "___id": "T000002R004811", "___s": true }, { "comment": "/**\r\n * A constant representing a top-right alignment or position.\r\n * @constant\r\n * @name Phaser.Display.Align.TOP_RIGHT\r\n * @since 3.0.0\r\n * @type {number}\r\n */", "meta": { "filename": "const.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\align", "code": {} }, "description": "A constant representing a top-right alignment or position.", "kind": "constant", "name": "TOP_RIGHT", "since": "3.0.0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.TOP_RIGHT", "scope": "static", "___id": "T000002R004813", "___s": true }, { "comment": "/**\r\n * A constant representing a left-top alignment or position.\r\n * @constant\r\n * @name Phaser.Display.Align.LEFT_TOP\r\n * @since 3.0.0\r\n * @type {number}\r\n */", "meta": { "filename": "const.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\align", "code": {} }, "description": "A constant representing a left-top alignment or position.", "kind": "constant", "name": "LEFT_TOP", "since": "3.0.0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.LEFT_TOP", "scope": "static", "___id": "T000002R004815", "___s": true }, { "comment": "/**\r\n * A constant representing a left-center alignment or position.\r\n * @constant\r\n * @name Phaser.Display.Align.LEFT_CENTER\r\n * @since 3.0.0\r\n * @type {number}\r\n */", "meta": { "filename": "const.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\align", "code": {} }, "description": "A constant representing a left-center alignment or position.", "kind": "constant", "name": "LEFT_CENTER", "since": "3.0.0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.LEFT_CENTER", "scope": "static", "___id": "T000002R004817", "___s": true }, { "comment": "/**\r\n * A constant representing a left-bottom alignment or position.\r\n * @constant\r\n * @name Phaser.Display.Align.LEFT_BOTTOM\r\n * @since 3.0.0\r\n * @type {number}\r\n */", "meta": { "filename": "const.js", "lineno": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\align", "code": {} }, "description": "A constant representing a left-bottom alignment or position.", "kind": "constant", "name": "LEFT_BOTTOM", "since": "3.0.0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.LEFT_BOTTOM", "scope": "static", "___id": "T000002R004819", "___s": true }, { "comment": "/**\r\n * A constant representing a center alignment or position.\r\n * @constant\r\n * @name Phaser.Display.Align.CENTER\r\n * @since 3.0.0\r\n * @type {number}\r\n */", "meta": { "filename": "const.js", "lineno": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\align", "code": {} }, "description": "A constant representing a center alignment or position.", "kind": "constant", "name": "CENTER", "since": "3.0.0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.CENTER", "scope": "static", "___id": "T000002R004821", "___s": true }, { "comment": "/**\r\n * A constant representing a right-top alignment or position.\r\n * @constant\r\n * @name Phaser.Display.Align.RIGHT_TOP\r\n * @since 3.0.0\r\n * @type {number}\r\n */", "meta": { "filename": "const.js", "lineno": 72, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\align", "code": {} }, "description": "A constant representing a right-top alignment or position.", "kind": "constant", "name": "RIGHT_TOP", "since": "3.0.0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.RIGHT_TOP", "scope": "static", "___id": "T000002R004823", "___s": true }, { "comment": "/**\r\n * A constant representing a right-center alignment or position.\r\n * @constant\r\n * @name Phaser.Display.Align.RIGHT_CENTER\r\n * @since 3.0.0\r\n * @type {number}\r\n */", "meta": { "filename": "const.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\align", "code": {} }, "description": "A constant representing a right-center alignment or position.", "kind": "constant", "name": "RIGHT_CENTER", "since": "3.0.0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.RIGHT_CENTER", "scope": "static", "___id": "T000002R004825", "___s": true }, { "comment": "/**\r\n * A constant representing a right-bottom alignment or position.\r\n * @constant\r\n * @name Phaser.Display.Align.RIGHT_BOTTOM\r\n * @since 3.0.0\r\n * @type {number}\r\n */", "meta": { "filename": "const.js", "lineno": 90, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\align", "code": {} }, "description": "A constant representing a right-bottom alignment or position.", "kind": "constant", "name": "RIGHT_BOTTOM", "since": "3.0.0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.RIGHT_BOTTOM", "scope": "static", "___id": "T000002R004827", "___s": true }, { "comment": "/**\r\n * A constant representing a bottom-left alignment or position.\r\n * @constant\r\n * @name Phaser.Display.Align.BOTTOM_LEFT\r\n * @since 3.0.0\r\n * @type {number}\r\n */", "meta": { "filename": "const.js", "lineno": 99, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\align", "code": {} }, "description": "A constant representing a bottom-left alignment or position.", "kind": "constant", "name": "BOTTOM_LEFT", "since": "3.0.0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.BOTTOM_LEFT", "scope": "static", "___id": "T000002R004829", "___s": true }, { "comment": "/**\r\n * A constant representing a bottom-center alignment or position.\r\n * @constant\r\n * @name Phaser.Display.Align.BOTTOM_CENTER\r\n * @since 3.0.0\r\n * @type {number}\r\n */", "meta": { "filename": "const.js", "lineno": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\align", "code": {} }, "description": "A constant representing a bottom-center alignment or position.", "kind": "constant", "name": "BOTTOM_CENTER", "since": "3.0.0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.BOTTOM_CENTER", "scope": "static", "___id": "T000002R004831", "___s": true }, { "comment": "/**\r\n * A constant representing a bottom-right alignment or position.\r\n * @constant\r\n * @name Phaser.Display.Align.BOTTOM_RIGHT\r\n * @since 3.0.0\r\n * @type {number}\r\n */", "meta": { "filename": "const.js", "lineno": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\align", "code": {} }, "description": "A constant representing a bottom-right alignment or position.", "kind": "constant", "name": "BOTTOM_RIGHT", "since": "3.0.0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.BOTTOM_RIGHT", "scope": "static", "___id": "T000002R004833", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that its bottom edge matches the bottom edge of the `alignIn` Game Object, with its horizontal center aligned to the horizontal center of `alignIn`.\r\n *\r\n * @function Phaser.Display.Align.In.BottomCenter\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignIn - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "BottomCenter.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\in", "code": {} }, "description": "Takes a given Game Object and aligns it so that its bottom edge matches the bottom edge of the `alignIn` Game Object, with its horizontal center aligned to the horizontal center of `alignIn`.", "kind": "function", "name": "BottomCenter", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignIn" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.In", "longname": "Phaser.Display.Align.In.BottomCenter", "scope": "static", "___id": "T000002R004840", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that it is positioned in the bottom-left of the other.\r\n *\r\n * @function Phaser.Display.Align.In.BottomLeft\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignIn - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "BottomLeft.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\in", "code": {} }, "description": "Takes a 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignIn" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.In", "longname": "Phaser.Display.Align.In.BottomLeft", "scope": "static", "___id": "T000002R004849", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that it is positioned inside the bottom-right corner of the `alignIn` Game Object. The right edge of `gameObject` is matched to the right edge of `alignIn`, and the bottom edge of `gameObject` is matched to the bottom edge of `alignIn`.\r\n *\r\n * @function Phaser.Display.Align.In.BottomRight\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignIn - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "BottomRight.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\in", "code": {} }, "description": "Takes a given Game Object and aligns it so that it is positioned inside the bottom-right corner of the `alignIn` Game Object. The right edge of `gameObject` is matched to the right edge of `alignIn`, and the bottom edge of `gameObject` is matched to the bottom edge of `alignIn`.", "kind": "function", "name": "BottomRight", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignIn" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.In", "longname": "Phaser.Display.Align.In.BottomRight", "scope": "static", "___id": "T000002R004858", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that it is positioned in the center of the other.\r\n *\r\n * @function Phaser.Display.Align.In.Center\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignIn - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "Center.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\in", "code": {} }, "description": "Takes a 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignIn" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.In", "longname": "Phaser.Display.Align.In.Center", "scope": "static", "___id": "T000002R004866", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Display.Align.In\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\in", "code": {} }, "kind": "namespace", "name": "In", "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.In", "scope": "static", "___id": "T000002R004871", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that its left edge is flush with the left edge of the `alignIn`\r\n * Game Object, and its vertical center matches the vertical center of `alignIn`. This places the Game Object\r\n * at the left-center interior position of the reference object. An optional offset can be applied to adjust\r\n * the final position along either axis.\r\n *\r\n * @function Phaser.Display.Align.In.LeftCenter\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignIn - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "LeftCenter.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\in", "code": {} }, "description": "Takes a given Game Object and aligns it so that its left edge is flush with the left edge of the `alignIn`\rGame Object, and its vertical center matches the vertical center of `alignIn`. This places the Game Object\rat the left-center interior position of the reference object. An optional offset can be applied to adjust\rthe final position along either axis.", "kind": "function", "name": "LeftCenter", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignIn" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.In", "longname": "Phaser.Display.Align.In.LeftCenter", "scope": "static", "___id": "T000002R004887", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that it is positioned relative to another Game Object.\r\n * The alignment used is based on the `position` argument, which is an `ALIGN_CONST` value, such as `LEFT_CENTER` or `TOP_RIGHT`.\r\n *\r\n * @function Phaser.Display.Align.In.QuickSet\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [child,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignIn - The Game Object to base the alignment position on.\r\n * @param {number} position - The position to align the Game Object with. This is an align constant, such as `ALIGN_CONST.LEFT_CENTER`.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "QuickSet.js", "lineno": 25, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\in", "code": {} }, "description": "Takes a given Game Object and aligns it so that it is positioned relative to another Game Object.\rThe 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [child,$return]", "value": "{Phaser.GameObjects.GameObject} G - [child,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "child" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignIn" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.In", "longname": "Phaser.Display.Align.In.QuickSet", "scope": "static", "___id": "T000002R004907", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that its right edge is flush with the right edge of the `alignIn` Game Object, and its vertical center is aligned with the vertical center of the `alignIn` Game Object.\r\n *\r\n * @function Phaser.Display.Align.In.RightCenter\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignIn - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "RightCenter.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\in", "code": {} }, "description": "Takes a given Game Object and aligns it so that its right edge is flush with the right edge of the `alignIn` Game Object, and its vertical center is aligned with the vertical center of the `alignIn` Game Object.", "kind": "function", "name": "RightCenter", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignIn" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.In", "longname": "Phaser.Display.Align.In.RightCenter", "scope": "static", "___id": "T000002R004914", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that its top edge is flush with the top edge of the `alignIn` Game Object, centered horizontally.\r\n *\r\n * @function Phaser.Display.Align.In.TopCenter\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignIn - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "TopCenter.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\in", "code": {} }, "description": "Takes a given Game Object and aligns it so that its top edge is flush with the top edge of the `alignIn` Game Object, centered horizontally.", "kind": "function", "name": "TopCenter", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignIn" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.In", "longname": "Phaser.Display.Align.In.TopCenter", "scope": "static", "___id": "T000002R004923", "___s": true }, { "comment": "/**\r\n * Takes the given Game Object and aligns it so that it is positioned in the top-left of the `alignIn` Game Object.\r\n *\r\n * @function Phaser.Display.Align.In.TopLeft\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignIn - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "TopLeft.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\in", "code": {} }, "description": "Takes the given Game Object and aligns it so that it is positioned in the top-left of the `alignIn` Game Object.", "kind": "function", "name": "TopLeft", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignIn" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.In", "longname": "Phaser.Display.Align.In.TopLeft", "scope": "static", "___id": "T000002R004932", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that it is positioned in the top-right of the `alignIn` Game Object.\r\n *\r\n * @function Phaser.Display.Align.In.TopRight\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignIn - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "TopRight.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\in", "code": {} }, "description": "Takes a given Game Object and aligns it so that it is positioned in the top-right of the `alignIn` Game Object.", "kind": "function", "name": "TopRight", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignIn" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.In", "longname": "Phaser.Display.Align.In.TopRight", "scope": "static", "___id": "T000002R004941", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Display.Align\r\n */", "meta": { "filename": "index.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align", "code": {} }, "kind": "namespace", "name": "Align", "memberof": "Phaser.Display", "longname": "Phaser.Display.Align", "scope": "static", "___id": "T000002R004948", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that its top edge is flush with the bottom of the `alignTo` Game Object, centered horizontally on it.\r\n *\r\n * @function Phaser.Display.Align.To.BottomCenter\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignTo - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "BottomCenter.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\to", "code": {} }, "description": "Takes a given Game Object and aligns it so that its top edge is flush with the bottom of the `alignTo` Game Object, centered horizontally on it.", "kind": "function", "name": "BottomCenter", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignTo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.To", "longname": "Phaser.Display.Align.To.BottomCenter", "scope": "static", "___id": "T000002R004958", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that it is placed directly below the `alignTo` Game Object, with its left edge aligned to the left edge of `alignTo`.\r\n *\r\n * @function Phaser.Display.Align.To.BottomLeft\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignTo - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "BottomLeft.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\to", "code": {} }, "description": "Takes a given Game Object and aligns it so that it is placed directly below the `alignTo` Game Object, with its left edge aligned to the left edge of `alignTo`.", "kind": "function", "name": "BottomLeft", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignTo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.To", "longname": "Phaser.Display.Align.To.BottomLeft", "scope": "static", "___id": "T000002R004967", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that it is placed directly below and flush with the right edge of the other Game Object. The right edge of `gameObject` is aligned to the right edge of `alignTo`, and the top edge of `gameObject` is placed at the bottom edge of `alignTo`.\r\n *\r\n * @function Phaser.Display.Align.To.BottomRight\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignTo - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "BottomRight.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\to", "code": {} }, "description": "Takes a given Game Object and aligns it so that it is placed directly below and flush with the right edge of the other Game Object. The right edge of `gameObject` is aligned to the right edge of `alignTo`, and the top edge of `gameObject` is placed at the bottom edge of `alignTo`.", "kind": "function", "name": "BottomRight", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignTo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.To", "longname": "Phaser.Display.Align.To.BottomRight", "scope": "static", "___id": "T000002R004976", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Display.Align.To\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\to", "code": {} }, "kind": "namespace", "name": "To", "memberof": "Phaser.Display.Align", "longname": "Phaser.Display.Align.To", "scope": "static", "___id": "T000002R004981", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that its right edge touches the left edge of the `alignTo` Game Object, with its bottom edge aligned to the bottom edge of `alignTo`.\r\n *\r\n * @function Phaser.Display.Align.To.LeftBottom\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignTo - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "LeftBottom.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\to", "code": {} }, "description": "Takes a given Game Object and aligns it so that its right edge touches the left edge of the `alignTo` Game Object, with its bottom edge aligned to the bottom edge of `alignTo`.", "kind": "function", "name": "LeftBottom", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignTo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.To", "longname": "Phaser.Display.Align.To.LeftBottom", "scope": "static", "___id": "T000002R005000", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that its right edge touches the left edge of the `alignTo` Game Object, with their vertical centers matched.\r\n *\r\n * @function Phaser.Display.Align.To.LeftCenter\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignTo - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "LeftCenter.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\to", "code": {} }, "description": "Takes a given Game Object and aligns it so that its right edge touches the left edge of the `alignTo` Game Object, with their vertical centers matched.", "kind": "function", "name": "LeftCenter", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignTo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.To", "longname": "Phaser.Display.Align.To.LeftCenter", "scope": "static", "___id": "T000002R005009", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that its right edge touches the left edge of the `alignTo` Game Object, with its top edge aligned to the top of `alignTo`.\r\n *\r\n * @function Phaser.Display.Align.To.LeftTop\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignTo - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "LeftTop.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\to", "code": {} }, "description": "Takes a given Game Object and aligns it so that its right edge touches the left edge of the `alignTo` Game Object, with its top edge aligned to the top of `alignTo`.", "kind": "function", "name": "LeftTop", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignTo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.To", "longname": "Phaser.Display.Align.To.LeftTop", "scope": "static", "___id": "T000002R005018", "___s": true }, { "comment": "/**\r\n * Takes a Game Object and aligns it next to another, at the given position.\r\n * The alignment used is based on the `position` argument, which is a `Phaser.Display.Align` property such as `LEFT_CENTER` or `TOP_RIGHT`.\r\n *\r\n * @function Phaser.Display.Align.To.QuickSet\r\n * @since 3.22.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [child,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignTo - The Game Object to base the alignment position on.\r\n * @param {number} position - The position to align the Game Object with. This is an align constant, such as `Phaser.Display.Align.LEFT_CENTER`.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position, in pixels.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position, in pixels.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "QuickSet.js", "lineno": 24, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\to", "code": {} }, "description": "Takes a Game Object and aligns it next to another, at the given position.\rThe 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [child,$return]", "value": "{Phaser.GameObjects.GameObject} G - [child,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "child" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignTo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position, in pixels.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position, in pixels.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.To", "longname": "Phaser.Display.Align.To.QuickSet", "scope": "static", "___id": "T000002R005037", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that it is placed immediately to the right of the `alignTo` Game Object, with their bottom edges aligned.\r\n *\r\n * @function Phaser.Display.Align.To.RightBottom\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignTo - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "RightBottom.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\to", "code": {} }, "description": "Takes a given Game Object and aligns it so that it is placed immediately to the right of the `alignTo` Game Object, with their bottom edges aligned.", "kind": "function", "name": "RightBottom", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignTo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.To", "longname": "Phaser.Display.Align.To.RightBottom", "scope": "static", "___id": "T000002R005044", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that its left edge is flush with the right edge of the `alignTo` Game Object, with their vertical centers matching.\r\n *\r\n * @function Phaser.Display.Align.To.RightCenter\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignTo - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "RightCenter.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\to", "code": {} }, "description": "Takes a given Game Object and aligns it so that its left edge is flush with the right edge of the `alignTo` Game Object, with their vertical centers matching.", "kind": "function", "name": "RightCenter", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignTo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.To", "longname": "Phaser.Display.Align.To.RightCenter", "scope": "static", "___id": "T000002R005053", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that its left edge is flush with the right edge of the `alignTo` Game Object, with its top edge matching the top edge of `alignTo`.\r\n *\r\n * @function Phaser.Display.Align.To.RightTop\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignTo - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "RightTop.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\to", "code": {} }, "description": "Takes a given Game Object and aligns it so that its left edge is flush with the right edge of the `alignTo` Game Object, with its top edge matching the top edge of `alignTo`.", "kind": "function", "name": "RightTop", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignTo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.To", "longname": "Phaser.Display.Align.To.RightTop", "scope": "static", "___id": "T000002R005062", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that it is placed directly above the `alignTo` Game Object, centered horizontally on it. The bottom edge of `gameObject` is positioned flush with the top edge of `alignTo`, and their center X coordinates are matched.\r\n *\r\n * @function Phaser.Display.Align.To.TopCenter\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignTo - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "TopCenter.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\to", "code": {} }, "description": "Takes a given Game Object and aligns it so that it is placed directly above the `alignTo` Game Object, centered horizontally on it. The bottom edge of `gameObject` is positioned flush with the top edge of `alignTo`, and their center X coordinates are matched.", "kind": "function", "name": "TopCenter", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignTo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.To", "longname": "Phaser.Display.Align.To.TopCenter", "scope": "static", "___id": "T000002R005071", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that its bottom edge sits flush with the top edge of the `alignTo` Game Object, with their left edges aligned. The result is that `gameObject` appears directly above `alignTo`, anchored to its left side.\r\n *\r\n * @function Phaser.Display.Align.To.TopLeft\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignTo - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "TopLeft.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\to", "code": {} }, "description": "Takes a given Game Object and aligns it so that its bottom edge sits flush with the top edge of the `alignTo` Game Object, with their left edges aligned. The result is that `gameObject` appears directly above `alignTo`, anchored to its left side.", "kind": "function", "name": "TopLeft", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignTo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.To", "longname": "Phaser.Display.Align.To.TopLeft", "scope": "static", "___id": "T000002R005080", "___s": true }, { "comment": "/**\r\n * Takes a given Game Object and aligns it so that it is positioned directly above the `alignTo` Game Object, with their right edges aligned.\r\n *\r\n * @function Phaser.Display.Align.To.TopRight\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be positioned.\r\n * @param {Phaser.GameObjects.GameObject} alignTo - The Game Object to base the alignment position on.\r\n * @param {number} [offsetX=0] - Optional horizontal offset from the position.\r\n * @param {number} [offsetY=0] - Optional vertical offset from the position.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was aligned.\r\n */", "meta": { "filename": "TopRight.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\align\\to", "code": {} }, "description": "Takes a given Game Object and aligns it so that it is positioned directly above the `alignTo` Game Object, with their right edges aligned.", "kind": "function", "name": "TopRight", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be positioned.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to base the alignment position on.", "name": "alignTo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional horizontal offset from the position.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional vertical offset from the position.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was aligned." } ], "memberof": "Phaser.Display.Align.To", "longname": "Phaser.Display.Align.To.TopRight", "scope": "static", "___id": "T000002R005089", "___s": true }, { "comment": "/**\r\n * Positions the Game Object so that it is centered on the given coordinates.\r\n *\r\n * @function Phaser.Display.Bounds.CenterOn\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be re-positioned.\r\n * @param {number} x - The horizontal coordinate to position the Game Object on.\r\n * @param {number} y - The vertical coordinate to position the Game Object on.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was positioned.\r\n */", "meta": { "filename": "CenterOn.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "description": "Positions the Game Object so that it is centered on the given coordinates.", "kind": "function", "name": "CenterOn", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be re-positioned.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate to position the Game Object on.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate to position the Game Object on.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was positioned." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.CenterOn", "scope": "static", "___id": "T000002R005096", "___s": true }, { "comment": "/**\r\n * Returns the bottom coordinate from the bounds of the Game Object.\r\n *\r\n * @function Phaser.Display.Bounds.GetBottom\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to get the bounds value from.\r\n *\r\n * @return {number} The bottom coordinate of the bounds of the Game Object.\r\n */", "meta": { "filename": "GetBottom.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to get the bounds value from.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom coordinate of the bounds of the Game Object." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.GetBottom", "scope": "static", "___id": "T000002R005099", "___s": true }, { "comment": "/**\r\n * Returns the unrotated bounds of the Game Object as a rectangle.\r\n *\r\n * @function Phaser.Display.Bounds.GetBounds\r\n * @since 3.24.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to get the bounds value from.\r\n * @param {(Phaser.Geom.Rectangle|object)} [output] - An object to store the values in. If not provided a new Rectangle will be created.\r\n *\r\n * @return {(Phaser.Geom.Rectangle|object)} - The bounds of the Game Object.\r\n */", "meta": { "filename": "GetBounds.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "description": "Returns the unrotated bounds of the Game Object as a rectangle.", "kind": "function", "name": "GetBounds", "since": "3.24.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to get the bounds value from.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Geom.Rectangle", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "- The bounds of the Game Object." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.GetBounds", "scope": "static", "___id": "T000002R005107", "___s": true }, { "comment": "/**\r\n * Returns the center x coordinate from the bounds of the Game Object.\r\n *\r\n * @function Phaser.Display.Bounds.GetCenterX\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to get the bounds value from.\r\n *\r\n * @return {number} The center x coordinate of the bounds of the Game Object.\r\n */", "meta": { "filename": "GetCenterX.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to get the bounds value from.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The center x coordinate of the bounds of the Game Object." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.GetCenterX", "scope": "static", "___id": "T000002R005117", "___s": true }, { "comment": "/**\r\n * Returns the center y coordinate from the bounds of the Game Object.\r\n *\r\n * @function Phaser.Display.Bounds.GetCenterY\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to get the bounds value from.\r\n *\r\n * @return {number} The center y coordinate of the bounds of the Game Object.\r\n */", "meta": { "filename": "GetCenterY.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to get the bounds value from.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The center y coordinate of the bounds of the Game Object." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.GetCenterY", "scope": "static", "___id": "T000002R005120", "___s": true }, { "comment": "/**\r\n * Returns the left coordinate from the bounds of the Game Object.\r\n *\r\n * @function Phaser.Display.Bounds.GetLeft\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to get the bounds value from.\r\n *\r\n * @return {number} The left coordinate of the bounds of the Game Object.\r\n */", "meta": { "filename": "GetLeft.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to get the bounds value from.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left coordinate of the bounds of the Game Object." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.GetLeft", "scope": "static", "___id": "T000002R005123", "___s": true }, { "comment": "/**\r\n * Returns the amount the Game Object is visually offset from its x coordinate.\r\n * This is the same as `width * origin.x`.\r\n * This value will only be > 0 if `origin.x` is not equal to zero.\r\n *\r\n * @function Phaser.Display.Bounds.GetOffsetX\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to get the bounds value from.\r\n *\r\n * @return {number} The horizontal offset of the Game Object.\r\n */", "meta": { "filename": "GetOffsetX.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "description": "Returns the amount the Game Object is visually offset from its x coordinate.\rThis is the same as `width * origin.x`.\rThis 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to get the bounds value from.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal offset of the Game Object." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.GetOffsetX", "scope": "static", "___id": "T000002R005126", "___s": true }, { "comment": "/**\r\n * Returns the amount the Game Object is visually offset from its y coordinate.\r\n * This is the same as `height * origin.y`.\r\n * This value will only be > 0 if `origin.y` is not equal to zero.\r\n *\r\n * @function Phaser.Display.Bounds.GetOffsetY\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to get the bounds value from.\r\n *\r\n * @return {number} The vertical offset of the Game Object.\r\n */", "meta": { "filename": "GetOffsetY.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "description": "Returns the amount the Game Object is visually offset from its y coordinate.\rThis is the same as `height * origin.y`.\rThis 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to get the bounds value from.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical offset of the Game Object." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.GetOffsetY", "scope": "static", "___id": "T000002R005129", "___s": true }, { "comment": "/**\r\n * Returns the right coordinate from the bounds of the Game Object.\r\n *\r\n * @function Phaser.Display.Bounds.GetRight\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to get the bounds value from.\r\n *\r\n * @return {number} The right coordinate of the bounds of the Game Object.\r\n */", "meta": { "filename": "GetRight.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to get the bounds value from.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The right coordinate of the bounds of the Game Object." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.GetRight", "scope": "static", "___id": "T000002R005132", "___s": true }, { "comment": "/**\r\n * Returns the top coordinate from the bounds of the Game Object.\r\n *\r\n * @function Phaser.Display.Bounds.GetTop\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to get the bounds value from.\r\n *\r\n * @return {number} The top coordinate of the bounds of the Game Object.\r\n */", "meta": { "filename": "GetTop.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to get the bounds value from.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top coordinate of the bounds of the Game Object." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.GetTop", "scope": "static", "___id": "T000002R005135", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Display.Bounds\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "kind": "namespace", "name": "Bounds", "memberof": "Phaser.Display", "longname": "Phaser.Display.Bounds", "scope": "static", "___id": "T000002R005138", "___s": true }, { "comment": "/**\r\n * Positions the Game Object so that the bottom of its bounds aligns with the given coordinate.\r\n *\r\n * @function Phaser.Display.Bounds.SetBottom\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be re-positioned.\r\n * @param {number} value - The coordinate to position the Game Object bounds on.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was positioned.\r\n */", "meta": { "filename": "SetBottom.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be re-positioned.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The coordinate to position the Game Object bounds on.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was positioned." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.SetBottom", "scope": "static", "___id": "T000002R005156", "___s": true }, { "comment": "/**\r\n * Positions the Game Object so that the horizontal center of its bounds aligns with the given coordinate.\r\n *\r\n * @function Phaser.Display.Bounds.SetCenterX\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be re-positioned.\r\n * @param {number} x - The coordinate to position the Game Object bounds on.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was positioned.\r\n */", "meta": { "filename": "SetCenterX.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "description": "Positions the Game Object so that the horizontal center of its bounds aligns with the given coordinate.", "kind": "function", "name": "SetCenterX", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be re-positioned.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The coordinate to position the Game Object bounds on.", "name": "x" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was positioned." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.SetCenterX", "scope": "static", "___id": "T000002R005160", "___s": true }, { "comment": "/**\r\n * Positions the Game Object so that the vertical center of its bounds aligns with the given coordinate.\r\n *\r\n * @function Phaser.Display.Bounds.SetCenterY\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be re-positioned.\r\n * @param {number} y - The coordinate to position the Game Object bounds on.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was positioned.\r\n */", "meta": { "filename": "SetCenterY.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "description": "Positions the Game Object so that the vertical center of its bounds aligns with the given coordinate.", "kind": "function", "name": "SetCenterY", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be re-positioned.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The coordinate to position the Game Object bounds on.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was positioned." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.SetCenterY", "scope": "static", "___id": "T000002R005165", "___s": true }, { "comment": "/**\r\n * Positions the Game Object so that the left of its bounds aligns with the given coordinate.\r\n *\r\n * @function Phaser.Display.Bounds.SetLeft\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be re-positioned.\r\n * @param {number} value - The coordinate to position the Game Object bounds on.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was positioned.\r\n */", "meta": { "filename": "SetLeft.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be re-positioned.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The coordinate to position the Game Object bounds on.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was positioned." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.SetLeft", "scope": "static", "___id": "T000002R005170", "___s": true }, { "comment": "/**\r\n * Positions the Game Object so that the right of its bounds aligns with the given coordinate.\r\n *\r\n * @function Phaser.Display.Bounds.SetRight\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be re-positioned.\r\n * @param {number} value - The coordinate to position the Game Object bounds on.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was positioned.\r\n */", "meta": { "filename": "SetRight.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "description": "Positions the Game Object so that the right of its bounds aligns with the given coordinate.", "kind": "function", "name": "SetRight", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be re-positioned.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The coordinate to position the Game Object bounds on.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was positioned." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.SetRight", "scope": "static", "___id": "T000002R005174", "___s": true }, { "comment": "/**\r\n * Positions the Game Object so that the top of its bounds aligns with the given coordinate.\r\n *\r\n * @function Phaser.Display.Bounds.SetTop\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} G - [gameObject,$return]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will be re-positioned.\r\n * @param {number} value - The coordinate to position the Game Object bounds on.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was positioned.\r\n */", "meta": { "filename": "SetTop.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\bounds", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]", "value": "{Phaser.GameObjects.GameObject} G - [gameObject,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will be re-positioned.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The coordinate to position the Game Object bounds on.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was positioned." } ], "memberof": "Phaser.Display.Bounds", "longname": "Phaser.Display.Bounds.SetTop", "scope": "static", "___id": "T000002R005178", "___s": true }, { "comment": "/**\r\n * The Canvas Interpolation namespace contains helper functions for setting the CSS `image-rendering`\r\n * property on a canvas element. This controls how the browser scales the canvas when it is\r\n * displayed at a size different from its native resolution.\r\n *\r\n * Use `setCrisp` for pixel art games where you want sharp, nearest-neighbor scaling with no\r\n * anti-aliasing. Use `setBicubic` to restore the default browser behavior, which applies smooth\r\n * interpolation when scaling up the canvas.\r\n *\r\n * @namespace Phaser.Display.Canvas.CanvasInterpolation\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasInterpolation.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "The Canvas Interpolation namespace contains helper functions for setting the CSS `image-rendering`\rproperty on a canvas element. This controls how the browser scales the canvas when it is\rdisplayed at a size different from its native resolution.\r\rUse `setCrisp` for pixel art games where you want sharp, nearest-neighbor scaling with no\ranti-aliasing. Use `setBicubic` to restore the default browser behavior, which applies smooth\rinterpolation when scaling up the canvas.", "kind": "namespace", "name": "CanvasInterpolation", "since": "3.0.0", "memberof": "Phaser.Display.Canvas", "longname": "Phaser.Display.Canvas.CanvasInterpolation", "scope": "static", "___id": "T000002R005182", "___s": true }, { "comment": "/**\r\n * Sets the CSS `image-rendering` property on the given canvas to use nearest-neighbor (crisp) scaling.\r\n * This disables anti-aliasing so that each pixel is rendered as a hard-edged block, which is ideal\r\n * for pixel art games. Multiple vendor-prefixed values are applied in sequence to ensure\r\n * cross-browser compatibility, including Firefox (`-moz-crisp-edges`), Opera (`-o-crisp-edges`),\r\n * WebKit (`-webkit-optimize-contrast`), and Internet Explorer (`msInterpolationMode: nearest-neighbor`).\r\n *\r\n * @function Phaser.Display.Canvas.CanvasInterpolation.setCrisp\r\n * @since 3.0.0\r\n * \r\n * @param {HTMLCanvasElement} canvas - The canvas object to have the style set on.\r\n * \r\n * @return {HTMLCanvasElement} The canvas.\r\n */", "meta": { "filename": "CanvasInterpolation.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Sets the CSS `image-rendering` property on the given canvas to use nearest-neighbor (crisp) scaling.\rThis disables anti-aliasing so that each pixel is rendered as a hard-edged block, which is ideal\rfor pixel art games. Multiple vendor-prefixed values are applied in sequence to ensure\rcross-browser compatibility, including Firefox (`-moz-crisp-edges`), Opera (`-o-crisp-edges`),\rWebKit (`-webkit-optimize-contrast`), and Internet Explorer (`msInterpolationMode: nearest-neighbor`).", "kind": "function", "name": "setCrisp", "since": "3.0.0", "params": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The canvas object to have the style set on.", "name": "canvas" } ], "returns": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The canvas." } ], "memberof": "Phaser.Display.Canvas.CanvasInterpolation", "longname": "Phaser.Display.Canvas.CanvasInterpolation.setCrisp", "scope": "static", "___id": "T000002R005184", "___s": true }, { "comment": "/**\r\n * Sets the CSS `image-rendering` property on the given canvas to `auto`, restoring the default\r\n * browser behavior. This allows the browser to apply smooth (typically bicubic) interpolation\r\n * when scaling the canvas, which produces softer edges and is better suited to high-resolution\r\n * textures or non-pixel-art content. Also sets the IE-specific `msInterpolationMode` to `bicubic`.\r\n *\r\n * @function Phaser.Display.Canvas.CanvasInterpolation.setBicubic\r\n * @since 3.0.0\r\n * \r\n * @param {HTMLCanvasElement} canvas - The canvas object to have the style set on.\r\n * \r\n * @return {HTMLCanvasElement} The canvas.\r\n */", "meta": { "filename": "CanvasInterpolation.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Sets the CSS `image-rendering` property on the given canvas to `auto`, restoring the default\rbrowser behavior. This allows the browser to apply smooth (typically bicubic) interpolation\rwhen scaling the canvas, which produces softer edges and is better suited to high-resolution\rtextures or non-pixel-art content. Also sets the IE-specific `msInterpolationMode` to `bicubic`.", "kind": "function", "name": "setBicubic", "since": "3.0.0", "params": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The canvas object to have the style set on.", "name": "canvas" } ], "returns": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The canvas." } ], "memberof": "Phaser.Display.Canvas.CanvasInterpolation", "longname": "Phaser.Display.Canvas.CanvasInterpolation.setBicubic", "scope": "static", "___id": "T000002R005189", "___s": true }, { "comment": "/**\r\n * The CanvasPool is a global static object, that allows Phaser to recycle and pool 2D Context Canvas DOM elements.\r\n * It does not pool WebGL Contexts, because once the context options are set they cannot be modified again,\r\n * which is useless for the Phaser renderer.\r\n *\r\n * This singleton is instantiated as soon as Phaser loads, before a Phaser.Game instance has even been created.\r\n * Which means all instances of Phaser Games on the same page can share the one single pool.\r\n *\r\n * @namespace Phaser.Display.Canvas.CanvasPool\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasPool.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "The CanvasPool is a global static object, that allows Phaser to recycle and pool 2D Context Canvas DOM elements.\rIt does not pool WebGL Contexts, because once the context options are set they cannot be modified again,\rwhich is useless for the Phaser renderer.\r\rThis singleton is instantiated as soon as Phaser loads, before a Phaser.Game instance has even been created.\rWhich 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", "___id": "T000002R005198", "___s": true }, { "comment": "/**\r\n * Creates a new Canvas DOM element, or pulls one from the pool if free.\r\n *\r\n * @function Phaser.Display.Canvas.CanvasPool.create\r\n * @since 3.0.0\r\n *\r\n * @param {*} parent - The parent of the Canvas object.\r\n * @param {number} [width=1] - The width of the Canvas.\r\n * @param {number} [height=1] - The height of the Canvas.\r\n * @param {number} [canvasType=Phaser.CANVAS] - The type of the Canvas. Either `Phaser.CANVAS` or `Phaser.WEBGL`.\r\n * @param {boolean} [selfParent=false] - Use the generated Canvas element as the parent?\r\n *\r\n * @return {HTMLCanvasElement} The canvas element that was created or pulled from the pool.\r\n */", "meta": { "filename": "CanvasPool.js", "lineno": 29, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "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": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The parent of the Canvas object.", "name": "parent" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The width of the Canvas.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The height of the Canvas.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "Phaser.CANVAS", "description": "The type of the Canvas. Either `Phaser.CANVAS` or `Phaser.WEBGL`.", "name": "canvasType" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Use the generated Canvas element as the parent?", "name": "selfParent" } ], "returns": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R005200", "___s": true }, { "comment": "/**\r\n * Creates a new 2D Canvas DOM element, or pulls one from the pool if free.\r\n *\r\n * This is a convenience wrapper around `create` that forces `canvasType` to `Phaser.CANVAS`,\r\n * ensuring the returned canvas is always intended for use with a 2D rendering context.\r\n *\r\n * @function Phaser.Display.Canvas.CanvasPool.create2D\r\n * @since 3.0.0\r\n *\r\n * @param {*} parent - The parent of the Canvas object.\r\n * @param {number} [width=1] - The width of the Canvas.\r\n * @param {number} [height=1] - The height of the Canvas.\r\n *\r\n * @return {HTMLCanvasElement} The canvas element that was created or pulled from the pool.\r\n */", "meta": { "filename": "CanvasPool.js", "lineno": 91, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Creates a new 2D Canvas DOM element, or pulls one from the pool if free.\r\rThis is a convenience wrapper around `create` that forces `canvasType` to `Phaser.CANVAS`,\rensuring the returned canvas is always intended for use with a 2D rendering context.", "kind": "function", "name": "create2D", "since": "3.0.0", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The parent of the Canvas object.", "name": "parent" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The width of the Canvas.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The height of the Canvas.", "name": "height" } ], "returns": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The canvas element that was created or pulled from the pool." } ], "memberof": "Phaser.Display.Canvas.CanvasPool", "longname": "Phaser.Display.Canvas.CanvasPool.create2D", "scope": "static", "___id": "T000002R005219", "___s": true }, { "comment": "/**\r\n * Creates a new WebGL Canvas DOM element.\r\n *\r\n * This is a convenience wrapper around `create` that forces `canvasType` to `Phaser.WEBGL`.\r\n * WebGL canvases are never added to the pool, because once a WebGL context's options are set\r\n * they cannot be changed, making pooling unsuitable for them.\r\n *\r\n * @function Phaser.Display.Canvas.CanvasPool.createWebGL\r\n * @since 3.0.0\r\n *\r\n * @param {*} parent - The parent of the Canvas object.\r\n * @param {number} [width=1] - The width of the Canvas.\r\n * @param {number} [height=1] - The height of the Canvas.\r\n *\r\n * @return {HTMLCanvasElement} The created WebGL canvas.\r\n */", "meta": { "filename": "CanvasPool.js", "lineno": 111, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Creates a new WebGL Canvas DOM element.\r\rThis is a convenience wrapper around `create` that forces `canvasType` to `Phaser.WEBGL`.\rWebGL canvases are never added to the pool, because once a WebGL context's options are set\rthey cannot be changed, making pooling unsuitable for them.", "kind": "function", "name": "createWebGL", "since": "3.0.0", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The parent of the Canvas object.", "name": "parent" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The width of the Canvas.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The height of the Canvas.", "name": "height" } ], "returns": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The created WebGL canvas." } ], "memberof": "Phaser.Display.Canvas.CanvasPool", "longname": "Phaser.Display.Canvas.CanvasPool.createWebGL", "scope": "static", "___id": "T000002R005221", "___s": true }, { "comment": "/**\r\n * Gets the first free canvas container from the pool.\r\n *\r\n * @function Phaser.Display.Canvas.CanvasPool.first\r\n * @since 3.0.0\r\n *\r\n * @param {number} [canvasType=Phaser.CANVAS] - The type of the Canvas. Either `Phaser.CANVAS` or `Phaser.WEBGL`.\r\n *\r\n * @return {HTMLCanvasElement} The first free canvas, or `null` if a WebGL canvas was requested or if the pool doesn't have free canvases.\r\n */", "meta": { "filename": "CanvasPool.js", "lineno": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Gets the first free canvas container from the pool.", "kind": "function", "name": "first", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "Phaser.CANVAS", "description": "The type of the Canvas. Either `Phaser.CANVAS` or `Phaser.WEBGL`.", "name": "canvasType" } ], "returns": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R005223", "___s": true }, { "comment": "/**\r\n * Looks up a canvas based on its parent, and if found puts it back in the pool, freeing it up for re-use.\r\n * The canvas has its width and height set to 1, and its parent attribute nulled.\r\n *\r\n * @function Phaser.Display.Canvas.CanvasPool.remove\r\n * @since 3.0.0\r\n *\r\n * @param {*} parent - The canvas or the parent of the canvas to free.\r\n */", "meta": { "filename": "CanvasPool.js", "lineno": 164, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Looks up a canvas based on its parent, and if found puts it back in the pool, freeing it up for re-use.\rThe 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": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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", "___id": "T000002R005228", "___s": true }, { "comment": "/**\r\n * Gets the total number of used canvas elements in the pool.\r\n *\r\n * @function Phaser.Display.Canvas.CanvasPool.total\r\n * @since 3.0.0\r\n *\r\n * @return {number} The number of used canvases.\r\n */", "meta": { "filename": "CanvasPool.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Gets the total number of used canvas elements in the pool.", "kind": "function", "name": "total", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of used canvases." } ], "memberof": "Phaser.Display.Canvas.CanvasPool", "longname": "Phaser.Display.Canvas.CanvasPool.total", "scope": "static", "___id": "T000002R005234", "___s": true }, { "comment": "/**\r\n * Gets the total number of free canvas elements in the pool.\r\n *\r\n * @function Phaser.Display.Canvas.CanvasPool.free\r\n * @since 3.0.0\r\n *\r\n * @return {number} The number of free canvases.\r\n */", "meta": { "filename": "CanvasPool.js", "lineno": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Gets the total number of free canvas elements in the pool.", "kind": "function", "name": "free", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of free canvases." } ], "memberof": "Phaser.Display.Canvas.CanvasPool", "longname": "Phaser.Display.Canvas.CanvasPool.free", "scope": "static", "___id": "T000002R005237", "___s": true }, { "comment": "/**\r\n * Disable context smoothing on any new Canvas element created.\r\n *\r\n * @function Phaser.Display.Canvas.CanvasPool.disableSmoothing\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasPool.js", "lineno": 225, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "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", "___id": "T000002R005239", "___s": true }, { "comment": "/**\r\n * Enable context smoothing on any new Canvas element created.\r\n *\r\n * @function Phaser.Display.Canvas.CanvasPool.enableSmoothing\r\n * @since 3.0.0\r\n */", "meta": { "filename": "CanvasPool.js", "lineno": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "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", "___id": "T000002R005242", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Display.Canvas\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "kind": "namespace", "name": "Canvas", "memberof": "Phaser.Display", "longname": "Phaser.Display.Canvas", "scope": "static", "___id": "T000002R005256", "___s": true }, { "comment": "/**\r\n * The Smoothing namespace contains functions for controlling the image smoothing (anti-aliasing)\r\n * setting on a canvas rendering context. Image smoothing affects how the browser scales images:\r\n * when enabled, scaled images are blurred to reduce jagged edges; when disabled, pixels are\r\n * rendered sharply without interpolation. Disabling smoothing is commonly used in games that\r\n * rely on pixel art, where blurring would distort the intended aesthetic. The functions in this\r\n * namespace automatically detect and apply the correct vendor-prefixed property for the current\r\n * browser, supporting `imageSmoothingEnabled` as well as the `webkit`, `ms`, `moz`, and `o` prefixed variants.\r\n *\r\n * @namespace Phaser.Display.Canvas.Smoothing\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Smoothing.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "The Smoothing namespace contains functions for controlling the image smoothing (anti-aliasing)\rsetting on a canvas rendering context. Image smoothing affects how the browser scales images:\rwhen enabled, scaled images are blurred to reduce jagged edges; when disabled, pixels are\rrendered sharply without interpolation. Disabling smoothing is commonly used in games that\rrely on pixel art, where blurring would distort the intended aesthetic. The functions in this\rnamespace automatically detect and apply the correct vendor-prefixed property for the current\rbrowser, supporting `imageSmoothingEnabled` as well as the `webkit`, `ms`, `moz`, and `o` prefixed variants.", "kind": "namespace", "name": "Smoothing", "since": "3.0.0", "memberof": "Phaser.Display.Canvas", "longname": "Phaser.Display.Canvas.Smoothing", "scope": "static", "___id": "T000002R005264", "___s": true }, { "comment": "/**\r\n * Gets the Smoothing Enabled vendor prefix being used on the given context, or null if not set.\r\n *\r\n * @function Phaser.Display.Canvas.Smoothing.getPrefix\r\n * @since 3.0.0\r\n *\r\n * @param {(CanvasRenderingContext2D|WebGLRenderingContext)} context - The canvas context to check.\r\n *\r\n * @return {string} 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.\r\n */", "meta": { "filename": "Smoothing.js", "lineno": 24, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "CanvasRenderingContext2D" }, { "type": "NameExpression", "name": "WebGLRenderingContext" } ] } }, "description": "The canvas context to check.", "name": "context" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R005266", "___s": true }, { "comment": "/**\r\n * Enables the Image Smoothing property on the given context.\r\n * By default browsers have image smoothing enabled, which isn't always what you visually want, especially\r\n * when using pixel art in a game. Note that this sets the property on the context itself, so that any image\r\n * drawn to the context will be affected. This sets the property across all current browsers but support is\r\n * patchy on earlier browsers, especially on mobile.\r\n *\r\n * @function Phaser.Display.Canvas.Smoothing.enable\r\n * @since 3.0.0\r\n *\r\n * @param {(CanvasRenderingContext2D|WebGLRenderingContext)} context - The context on which to enable smoothing.\r\n *\r\n * @return {(CanvasRenderingContext2D|WebGLRenderingContext)} The provided context.\r\n */", "meta": { "filename": "Smoothing.js", "lineno": 51, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Enables the Image Smoothing property on the given context.\rBy default browsers have image smoothing enabled, which isn't always what you visually want, especially\rwhen using pixel art in a game. Note that this sets the property on the context itself, so that any image\rdrawn to the context will be affected. This sets the property across all current browsers but support is\rpatchy on earlier browsers, especially on mobile.", "kind": "function", "name": "enable", "since": "3.0.0", "params": [ { "type": { "names": [ "CanvasRenderingContext2D", "WebGLRenderingContext" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "CanvasRenderingContext2D" }, { "type": "NameExpression", "name": "WebGLRenderingContext" } ] } }, "description": "The context on which to enable smoothing.", "name": "context" } ], "returns": [ { "type": { "names": [ "CanvasRenderingContext2D", "WebGLRenderingContext" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "CanvasRenderingContext2D" }, { "type": "NameExpression", "name": "WebGLRenderingContext" } ] } }, "description": "The provided context." } ], "memberof": "Phaser.Display.Canvas.Smoothing", "longname": "Phaser.Display.Canvas.Smoothing.enable", "scope": "static", "___id": "T000002R005271", "___s": true }, { "comment": "/**\r\n * Disables the Image Smoothing property on the given context.\r\n * By default browsers have image smoothing enabled, which isn't always what you visually want, especially\r\n * when using pixel art in a game. Note that this sets the property on the context itself, so that any image\r\n * drawn to the context will be affected. This sets the property across all current browsers but support is\r\n * patchy on earlier browsers, especially on mobile.\r\n *\r\n * @function Phaser.Display.Canvas.Smoothing.disable\r\n * @since 3.0.0\r\n *\r\n * @param {(CanvasRenderingContext2D|WebGLRenderingContext)} context - The context on which to disable smoothing.\r\n *\r\n * @return {(CanvasRenderingContext2D|WebGLRenderingContext)} The provided context.\r\n */", "meta": { "filename": "Smoothing.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Disables the Image Smoothing property on the given context.\rBy default browsers have image smoothing enabled, which isn't always what you visually want, especially\rwhen using pixel art in a game. Note that this sets the property on the context itself, so that any image\rdrawn to the context will be affected. This sets the property across all current browsers but support is\rpatchy on earlier browsers, especially on mobile.", "kind": "function", "name": "disable", "since": "3.0.0", "params": [ { "type": { "names": [ "CanvasRenderingContext2D", "WebGLRenderingContext" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "CanvasRenderingContext2D" }, { "type": "NameExpression", "name": "WebGLRenderingContext" } ] } }, "description": "The context on which to disable smoothing.", "name": "context" } ], "returns": [ { "type": { "names": [ "CanvasRenderingContext2D", "WebGLRenderingContext" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "CanvasRenderingContext2D" }, { "type": "NameExpression", "name": "WebGLRenderingContext" } ] } }, "description": "The provided context." } ], "memberof": "Phaser.Display.Canvas.Smoothing", "longname": "Phaser.Display.Canvas.Smoothing.disable", "scope": "static", "___id": "T000002R005275", "___s": true }, { "comment": "/**\r\n * Returns `true` if the given context has image smoothing enabled, otherwise returns `false`.\r\n * Returns null if no smoothing prefix is available.\r\n *\r\n * @function Phaser.Display.Canvas.Smoothing.isEnabled\r\n * @since 3.0.0\r\n *\r\n * @param {(CanvasRenderingContext2D|WebGLRenderingContext)} context - The context to check.\r\n *\r\n * @return {?boolean} `true` if smoothing is enabled on the context, otherwise `false`. `null` if not supported.\r\n */", "meta": { "filename": "Smoothing.js", "lineno": 109, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "description": "Returns `true` if the given context has image smoothing enabled, otherwise returns `false`.\rReturns null if no smoothing prefix is available.", "kind": "function", "name": "isEnabled", "since": "3.0.0", "params": [ { "type": { "names": [ "CanvasRenderingContext2D", "WebGLRenderingContext" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "CanvasRenderingContext2D" }, { "type": "NameExpression", "name": "WebGLRenderingContext" } ] } }, "description": "The context to check.", "name": "context" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "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", "___id": "T000002R005279", "___s": true }, { "comment": "/**\r\n * Sets the touch-action property on the canvas style. Can be used to disable default browser touch actions.\r\n *\r\n * @function Phaser.Display.Canvas.TouchAction\r\n * @since 3.0.0\r\n *\r\n * @param {HTMLCanvasElement} canvas - The canvas element to have the style applied to.\r\n * @param {string} [value='none'] - The touch action value to set on the canvas. Set to `none` to disable touch actions.\r\n *\r\n * @return {HTMLCanvasElement} The canvas element.\r\n */", "meta": { "filename": "TouchAction.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The canvas element to have the style applied to.", "name": "canvas" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The canvas element." } ], "memberof": "Phaser.Display.Canvas", "longname": "Phaser.Display.Canvas.TouchAction", "scope": "static", "___id": "T000002R005286", "___s": true }, { "comment": "/**\r\n * Sets the user-select property on the canvas style. Can be used to disable default browser selection actions.\r\n *\r\n * @function Phaser.Display.Canvas.UserSelect\r\n * @since 3.0.0\r\n *\r\n * @param {HTMLCanvasElement} canvas - The canvas element to have the style applied to.\r\n * @param {string} [value='none'] - The user-select value to set on the canvas. Set to `none` to disable default browser text selection and touch callouts.\r\n *\r\n * @return {HTMLCanvasElement} The canvas element.\r\n */", "meta": { "filename": "UserSelect.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\canvas", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The canvas element to have the style applied to.", "name": "canvas" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'none'", "description": "The user-select value to set on the canvas. Set to `none` to disable default browser text selection and touch callouts.", "name": "value" } ], "returns": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The canvas element." } ], "memberof": "Phaser.Display.Canvas", "longname": "Phaser.Display.Canvas.UserSelect", "scope": "static", "___id": "T000002R005293", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Display.Color\r\n */", "meta": { "filename": "Color.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "kind": "namespace", "name": "Color", "memberof": "Phaser.Display", "longname": "Phaser.Display.Color", "scope": "static", "___id": "T000002R005306", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A mutable color representation that stores RGBA values (0-255 range) with automatic conversion\r\n * to WebGL-compatible normalized floats (0-1), HSV color space, CSS rgba strings, and packed\r\n * 24/32-bit integer formats. Provides methods for color manipulation including saturation,\r\n * lightness, brightness adjustments, grayscale, and randomization. Supports construction from\r\n * RGB integers, hex strings, HSV values, or color objects. Used throughout Phaser for tinting,\r\n * effects, and rendering.\r\n *\r\n * @class Color\r\n * @memberof Phaser.Display\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {number} [red=0] - The red color value. A number between 0 and 255.\r\n * @param {number} [green=0] - The green color value. A number between 0 and 255.\r\n * @param {number} [blue=0] - The blue color value. A number between 0 and 255.\r\n * @param {number} [alpha=255] - The alpha value. A number between 0 and 255.\r\n */", "meta": { "filename": "Color.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "classdesc": "A mutable color representation that stores RGBA values (0-255 range) with automatic conversion\rto WebGL-compatible normalized floats (0-1), HSV color space, CSS rgba strings, and packed\r24/32-bit integer formats. Provides methods for color manipulation including saturation,\rlightness, brightness adjustments, grayscale, and randomization. Supports construction from\rRGB integers, hex strings, HSV values, or color objects. Used throughout Phaser for tinting,\reffects, and rendering.", "kind": "class", "name": "Color", "memberof": "Phaser.Display", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The red color value. A number between 0 and 255.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The green color value. A number between 0 and 255.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The blue color value. A number between 0 and 255.", "name": "blue" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The alpha value. A number between 0 and 255.", "name": "alpha" } ], "scope": "static", "longname": "Phaser.Display.Color", "___id": "T000002R005307", "___s": true }, { "comment": "/**\r\n * An array containing the RGBA color components in WebGL-compatible normalized float format,\r\n * stored as `[red, green, blue, alpha]` with each value in the range 0 to 1.\r\n *\r\n * @name Phaser.Display.Color#gl\r\n * @type {number[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Color.js", "lineno": 137, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "An array containing the RGBA color components in WebGL-compatible normalized float format,\rstored as `[red, green, blue, alpha]` with each value in the range 0 to 1.", "name": "gl", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#gl", "scope": "instance", "kind": "member", "___id": "T000002R005330", "___s": true }, { "comment": "/**\r\n * Sets this color to be transparent. Sets all values to zero.\r\n *\r\n * @method Phaser.Display.Color#transparent\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Display.Color} This Color object.\r\n */", "meta": { "filename": "Color.js", "lineno": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "This Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#transparent", "scope": "instance", "___id": "T000002R005338", "___s": true }, { "comment": "/**\r\n * Sets the color of this Color component.\r\n *\r\n * @method Phaser.Display.Color#setTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} red - The red color value. A number between 0 and 255.\r\n * @param {number} green - The green color value. A number between 0 and 255.\r\n * @param {number} blue - The blue color value. A number between 0 and 255.\r\n * @param {number} [alpha=255] - The alpha value. A number between 0 and 255.\r\n * @param {boolean} [updateHSV=true] - Update the HSV values after setting the RGB values?\r\n *\r\n * @return {Phaser.Display.Color} This Color object.\r\n */", "meta": { "filename": "Color.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Sets the color of this Color component.", "kind": "function", "name": "setTo", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The red color value. A number between 0 and 255.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The green color value. A number between 0 and 255.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blue color value. A number between 0 and 255.", "name": "blue" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The alpha value. A number between 0 and 255.", "name": "alpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Update the HSV values after setting the RGB values?", "name": "updateHSV" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "This Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#setTo", "scope": "instance", "___id": "T000002R005346", "___s": true }, { "comment": "/**\r\n * Sets the red, green, blue and alpha GL values of this Color component.\r\n *\r\n * @method Phaser.Display.Color#setGLTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} red - The red color value. A number between 0 and 1.\r\n * @param {number} green - The green color value. A number between 0 and 1.\r\n * @param {number} blue - The blue color value. A number between 0 and 1.\r\n * @param {number} [alpha=1] - The alpha value. A number between 0 and 1.\r\n *\r\n * @return {Phaser.Display.Color} This Color object.\r\n */", "meta": { "filename": "Color.js", "lineno": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The red color value. A number between 0 and 1.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The green color value. A number between 0 and 1.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blue color value. A number between 0 and 1.", "name": "blue" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha value. A number between 0 and 1.", "name": "alpha" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "This Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#setGLTo", "scope": "instance", "___id": "T000002R005356", "___s": true }, { "comment": "/**\r\n * Sets the color based on the color object given.\r\n *\r\n * @method Phaser.Display.Color#setFromRGB\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Display.InputColorObject} color - An object containing `r`, `g`, `b` and optionally `a` values in the range 0 to 255.\r\n *\r\n * @return {Phaser.Display.Color} This Color object.\r\n */", "meta": { "filename": "Color.js", "lineno": 265, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "This Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#setFromRGB", "scope": "instance", "___id": "T000002R005365", "___s": true }, { "comment": "/**\r\n * Sets the color based on the hue, saturation and value (HSV) components given.\r\n *\r\n * @method Phaser.Display.Color#setFromHSV\r\n * @since 3.13.0\r\n *\r\n * @param {number} h - The hue, in the range 0 - 1. This is the base color.\r\n * @param {number} s - 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.\r\n * @param {number} v - 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.\r\n *\r\n * @return {Phaser.Display.Color} This Color object.\r\n */", "meta": { "filename": "Color.js", "lineno": 293, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Sets the color based on the hue, saturation and value (HSV) components given.", "kind": "function", "name": "setFromHSV", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The hue, in the range 0 - 1. This is the base color.", "name": "h" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "This Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#setFromHSV", "scope": "instance", "___id": "T000002R005373", "___s": true }, { "comment": "/**\r\n * Returns a new Color component using the values from this one.\r\n *\r\n * @method Phaser.Display.Color#clone\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Display.Color} A new Color object.\r\n */", "meta": { "filename": "Color.js", "lineno": 365, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "A new Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#clone", "scope": "instance", "___id": "T000002R005390", "___s": true }, { "comment": "/**\r\n * Sets this Color object to be grayscaled based on the shade value given.\r\n *\r\n * @method Phaser.Display.Color#gray\r\n * @since 3.13.0\r\n * \r\n * @param {number} shade - A value between 0 and 255.\r\n *\r\n * @return {Phaser.Display.Color} This Color object.\r\n */", "meta": { "filename": "Color.js", "lineno": 378, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A value between 0 and 255.", "name": "shade" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "This Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#gray", "scope": "instance", "___id": "T000002R005392", "___s": true }, { "comment": "/**\r\n * Sets this Color object to be a random color between the `min` and `max` values given.\r\n *\r\n * @method Phaser.Display.Color#random\r\n * @since 3.13.0\r\n * \r\n * @param {number} [min=0] - The minimum random color value. Between 0 and 255.\r\n * @param {number} [max=255] - The maximum random color value. Between 0 and 255.\r\n *\r\n * @return {Phaser.Display.Color} This Color object.\r\n */", "meta": { "filename": "Color.js", "lineno": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The minimum random color value. Between 0 and 255.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The maximum random color value. Between 0 and 255.", "name": "max" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "This Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#random", "scope": "instance", "___id": "T000002R005394", "___s": true }, { "comment": "/**\r\n * Sets this Color object to be a random grayscale color between the `min` and `max` values given.\r\n *\r\n * @method Phaser.Display.Color#randomGray\r\n * @since 3.13.0\r\n * \r\n * @param {number} [min=0] - The minimum random color value. Between 0 and 255.\r\n * @param {number} [max=255] - The maximum random color value. Between 0 and 255.\r\n *\r\n * @return {Phaser.Display.Color} This Color object.\r\n */", "meta": { "filename": "Color.js", "lineno": 416, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The minimum random color value. Between 0 and 255.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The maximum random color value. Between 0 and 255.", "name": "max" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "This Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#randomGray", "scope": "instance", "___id": "T000002R005401", "___s": true }, { "comment": "/**\r\n * Increase the saturation of this Color by the percentage amount given.\r\n * The saturation is the amount of the base color in the hue.\r\n *\r\n * @method Phaser.Display.Color#saturate\r\n * @since 3.13.0\r\n * \r\n * @param {number} amount - The percentage amount to change this color by. A value between 0 and 100.\r\n *\r\n * @return {Phaser.Display.Color} This Color object.\r\n */", "meta": { "filename": "Color.js", "lineno": 437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Increase the saturation of this Color by the percentage amount given.\rThe saturation is the amount of the base color in the hue.", "kind": "function", "name": "saturate", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage amount to change this color by. A value between 0 and 100.", "name": "amount" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "This Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#saturate", "scope": "instance", "___id": "T000002R005406", "___s": true }, { "comment": "/**\r\n * Decrease the saturation of this Color by the percentage amount given.\r\n * The saturation is the amount of the base color in the hue.\r\n *\r\n * @method Phaser.Display.Color#desaturate\r\n * @since 3.13.0\r\n * \r\n * @param {number} amount - The percentage amount to change this color by. A value between 0 and 100.\r\n *\r\n * @return {Phaser.Display.Color} This Color object.\r\n */", "meta": { "filename": "Color.js", "lineno": 455, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Decrease the saturation of this Color by the percentage amount given.\rThe saturation is the amount of the base color in the hue.", "kind": "function", "name": "desaturate", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage amount to change this color by. A value between 0 and 100.", "name": "amount" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "This Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#desaturate", "scope": "instance", "___id": "T000002R005409", "___s": true }, { "comment": "/**\r\n * Increase the lightness of this Color by the percentage amount given.\r\n *\r\n * @method Phaser.Display.Color#lighten\r\n * @since 3.13.0\r\n * \r\n * @param {number} amount - The percentage amount to change this color by. A value between 0 and 100.\r\n *\r\n * @return {Phaser.Display.Color} This Color object.\r\n */", "meta": { "filename": "Color.js", "lineno": 473, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Increase the lightness of this Color by the percentage amount given.", "kind": "function", "name": "lighten", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage amount to change this color by. A value between 0 and 100.", "name": "amount" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "This Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#lighten", "scope": "instance", "___id": "T000002R005412", "___s": true }, { "comment": "/**\r\n * Decrease the lightness of this Color by the percentage amount given.\r\n *\r\n * @method Phaser.Display.Color#darken\r\n * @since 3.13.0\r\n * \r\n * @param {number} amount - The percentage amount to change this color by. A value between 0 and 100.\r\n *\r\n * @return {Phaser.Display.Color} This Color object.\r\n */", "meta": { "filename": "Color.js", "lineno": 490, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Decrease the lightness of this Color by the percentage amount given.", "kind": "function", "name": "darken", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage amount to change this color by. A value between 0 and 100.", "name": "amount" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "This Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#darken", "scope": "instance", "___id": "T000002R005415", "___s": true }, { "comment": "/**\r\n * Brighten this Color by the percentage amount given.\r\n *\r\n * @method Phaser.Display.Color#brighten\r\n * @since 3.13.0\r\n * \r\n * @param {number} amount - The percentage amount to change this color by. A value between 0 and 100.\r\n *\r\n * @return {Phaser.Display.Color} This Color object.\r\n */", "meta": { "filename": "Color.js", "lineno": 507, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Brighten this Color by the percentage amount given.", "kind": "function", "name": "brighten", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The percentage amount to change this color by. A value between 0 and 100.", "name": "amount" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "This Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#brighten", "scope": "instance", "___id": "T000002R005418", "___s": true }, { "comment": "/**\r\n * The packed 24-bit RGB integer representation of this color, not including the alpha channel.\r\n *\r\n * @name Phaser.Display.Color#color\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Color.js", "lineno": 530, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The packed 24-bit RGB integer representation of this color, not including the alpha channel.", "name": "color", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#color", "scope": "instance", "kind": "member", "___id": "T000002R005426", "___s": true }, { "comment": "/**\r\n * The packed 32-bit RGBA integer representation of this color, including the alpha channel.\r\n *\r\n * @name Phaser.Display.Color#color32\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Color.js", "lineno": 547, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The packed 32-bit RGBA integer representation of this color, including the alpha channel.", "name": "color32", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#color32", "scope": "instance", "kind": "member", "___id": "T000002R005429", "___s": true }, { "comment": "/**\r\n * The color of this Color object as a CSS-compatible `rgba()` string, suitable for use with Canvas 2D or HTML elements.\r\n *\r\n * @name Phaser.Display.Color#rgba\r\n * @type {string}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Color.js", "lineno": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The color of this Color object as a CSS-compatible `rgba()` string, suitable for use with Canvas 2D or HTML elements.", "name": "rgba", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#rgba", "scope": "instance", "kind": "member", "___id": "T000002R005432", "___s": true }, { "comment": "/**\r\n * The red color value, normalized to the range 0 to 1.\r\n *\r\n * @name Phaser.Display.Color#redGL\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Color.js", "lineno": 581, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The red color value, normalized to the range 0 to 1.", "name": "redGL", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#redGL", "scope": "instance", "kind": "member", "___id": "T000002R005435", "___s": true }, { "comment": "/**\r\n * The green color value, normalized to the range 0 to 1.\r\n *\r\n * @name Phaser.Display.Color#greenGL\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Color.js", "lineno": 606, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The green color value, normalized to the range 0 to 1.", "name": "greenGL", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#greenGL", "scope": "instance", "kind": "member", "___id": "T000002R005441", "___s": true }, { "comment": "/**\r\n * The blue color value, normalized to the range 0 to 1.\r\n *\r\n * @name Phaser.Display.Color#blueGL\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Color.js", "lineno": 631, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The blue color value, normalized to the range 0 to 1.", "name": "blueGL", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#blueGL", "scope": "instance", "kind": "member", "___id": "T000002R005447", "___s": true }, { "comment": "/**\r\n * The alpha color value, normalized to the range 0 to 1.\r\n *\r\n * @name Phaser.Display.Color#alphaGL\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Color.js", "lineno": 656, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The alpha color value, normalized to the range 0 to 1.", "name": "alphaGL", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#alphaGL", "scope": "instance", "kind": "member", "___id": "T000002R005453", "___s": true }, { "comment": "/**\r\n * The red color value, in the range 0 to 255.\r\n *\r\n * @name Phaser.Display.Color#red\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Color.js", "lineno": 681, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The red color value, in the range 0 to 255.", "name": "red", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#red", "scope": "instance", "kind": "member", "___id": "T000002R005459", "___s": true }, { "comment": "/**\r\n * The green color value, in the range 0 to 255.\r\n *\r\n * @name Phaser.Display.Color#green\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Color.js", "lineno": 708, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The green color value, in the range 0 to 255.", "name": "green", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#green", "scope": "instance", "kind": "member", "___id": "T000002R005466", "___s": true }, { "comment": "/**\r\n * The blue color value, in the range 0 to 255.\r\n *\r\n * @name Phaser.Display.Color#blue\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Color.js", "lineno": 735, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The blue color value, in the range 0 to 255.", "name": "blue", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#blue", "scope": "instance", "kind": "member", "___id": "T000002R005473", "___s": true }, { "comment": "/**\r\n * The alpha color value, in the range 0 to 255.\r\n *\r\n * @name Phaser.Display.Color#alpha\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Color.js", "lineno": 762, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The alpha color value, in the range 0 to 255.", "name": "alpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#alpha", "scope": "instance", "kind": "member", "___id": "T000002R005480", "___s": true }, { "comment": "/**\r\n * The hue color value. A number between 0 and 1.\r\n * This is the base color.\r\n *\r\n * @name Phaser.Display.Color#h\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Color.js", "lineno": 789, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The hue color value. A number between 0 and 1.\rThis is the base color.", "name": "h", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#h", "scope": "instance", "kind": "member", "___id": "T000002R005487", "___s": true }, { "comment": "/**\r\n * The saturation color value. A number between 0 and 1.\r\n * This controls how much of the hue will be in the final color, where 1 is fully saturated and 0 will give you white.\r\n *\r\n * @name Phaser.Display.Color#s\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Color.js", "lineno": 813, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The saturation color value. A number between 0 and 1.\rThis 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#s", "scope": "instance", "kind": "member", "___id": "T000002R005492", "___s": true }, { "comment": "/**\r\n * The value (brightness) component of this color in the HSV color space. A number between 0 and 1,\r\n * where 1 is fully bright and 0 is black.\r\n *\r\n * @name Phaser.Display.Color#v\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Color.js", "lineno": 837, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "The value (brightness) component of this color in the HSV color space. A number between 0 and 1,\rwhere 1 is fully bright and 0 is black.", "name": "v", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color#v", "scope": "instance", "kind": "member", "___id": "T000002R005497", "___s": true }, { "comment": "/**\r\n * Returns an array of Color Objects representing a full color spectrum.\r\n *\r\n * The spectrum colors cycle through the hue wheel in the order: red, yellow, green, cyan, blue, violet, and back to red.\r\n *\r\n * By default this function will return an array with 1024 elements.\r\n *\r\n * However, you can reduce this to a smaller quantity if needed, by specifying the `limit` parameter.\r\n * When a limit smaller than 1024 is given, the colors are sampled evenly across the full spectrum so\r\n * the hue distribution remains uniform regardless of the array size.\r\n *\r\n * @function Phaser.Display.Color.ColorSpectrum\r\n * @since 3.50.0\r\n *\r\n * @param {number} [limit=1024] - How many colors should be returned? The maximum is 1024 but you can set a smaller quantity if required.\r\n *\r\n * @return {Phaser.Types.Display.ColorObject[]} An array containing `limit` parameter number of elements, where each contains a Color Object.\r\n */", "meta": { "filename": "ColorSpectrum.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Returns an array of Color Objects representing a full color spectrum.\r\rThe spectrum colors cycle through the hue wheel in the order: red, yellow, green, cyan, blue, violet, and back to red.\r\rBy default this function will return an array with 1024 elements.\r\rHowever, you can reduce this to a smaller quantity if needed, by specifying the `limit` parameter.\rWhen a limit smaller than 1024 is given, the colors are sampled evenly across the full spectrum so\rthe hue distribution remains uniform regardless of the array size.", "kind": "function", "name": "ColorSpectrum", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1024, "description": "How many colors should be returned? The maximum is 1024 but you can set a smaller quantity if required.", "name": "limit" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Display.ColorObject", "type": "NameExpression" } ] } }, "description": "An array containing `limit` parameter number of elements, where each contains a Color Object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.ColorSpectrum", "scope": "static", "___id": "T000002R005504", "___s": true }, { "comment": "/**\r\n * Converts the given color value into an object containing r, g, b and a properties.\r\n *\r\n * The color value can be a 24-bit RGB integer (e.g. `0xRRGGBB`) or a 32-bit ARGB integer\r\n * (e.g. `0xAARRGGBB`). If the value is 24-bit (i.e. does not exceed `0xFFFFFF`), the alpha\r\n * component of the returned object defaults to 255 (fully opaque). Otherwise, the alpha is\r\n * extracted from the upper 8 bits of the value.\r\n *\r\n * @function Phaser.Display.Color.ColorToRGBA\r\n * @since 3.0.0\r\n *\r\n * @param {number} color - A 24-bit RGB or 32-bit ARGB color integer, optionally including an alpha component in the most-significant byte.\r\n *\r\n * @return {Phaser.Types.Display.ColorObject} An object containing the parsed color values.\r\n */", "meta": { "filename": "ColorToRGBA.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Converts the given color value into an object containing r, g, b and a properties.\r\rThe color value can be a 24-bit RGB integer (e.g. `0xRRGGBB`) or a 32-bit ARGB integer\r(e.g. `0xAARRGGBB`). If the value is 24-bit (i.e. does not exceed `0xFFFFFF`), the alpha\rcomponent of the returned object defaults to 255 (fully opaque). Otherwise, the alpha is\rextracted from the upper 8 bits of the value.", "kind": "function", "name": "ColorToRGBA", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A 24-bit RGB or 32-bit ARGB color integer, optionally including an alpha component in the most-significant byte.", "name": "color" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Display.ColorObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Display.ColorObject" } }, "description": "An object containing the parsed color values." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.ColorToRGBA", "scope": "static", "___id": "T000002R005543", "___s": true }, { "comment": "/**\r\n * Returns a string containing a hex representation of the given color component.\r\n *\r\n * @function Phaser.Display.Color.ComponentToHex\r\n * @since 3.0.0\r\n *\r\n * @param {number} color - The color channel to get the hex value for, must be a value between 0 and 255.\r\n *\r\n * @return {string} A string of length 2 characters, i.e. 255 = ff, 100 = 64.\r\n */", "meta": { "filename": "ComponentToHex.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Returns a string containing a hex representation of the given color component.", "kind": "function", "name": "ComponentToHex", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color channel to get the hex value for, must be a value between 0 and 255.", "name": "color" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R005552", "___s": true }, { "comment": "/**\r\n * Packs three separate red, green, and blue color component values into a single 24-bit integer in the format 0xRRGGBB.\r\n *\r\n * @function Phaser.Display.Color.GetColor\r\n * @since 3.0.0\r\n *\r\n * @param {number} red - The red color value. A number between 0 and 255.\r\n * @param {number} green - The green color value. A number between 0 and 255.\r\n * @param {number} blue - The blue color value. A number between 0 and 255.\r\n *\r\n * @return {number} The packed color value as a 24-bit integer in the format 0xRRGGBB.\r\n */", "meta": { "filename": "GetColor.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Packs three separate red, green, and blue color component values into a single 24-bit integer in the format 0xRRGGBB.", "kind": "function", "name": "GetColor", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The red color value. A number between 0 and 255.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The green color value. A number between 0 and 255.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blue color value. A number between 0 and 255.", "name": "blue" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The packed color value as a 24-bit integer in the format 0xRRGGBB." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.GetColor", "scope": "static", "___id": "T000002R005556", "___s": true }, { "comment": "/**\r\n * Packs four ARGB component values (red, green, blue, and alpha) into a single 32-bit integer in ARGB format.\r\n *\r\n * @function Phaser.Display.Color.GetColor32\r\n * @since 3.0.0\r\n *\r\n * @param {number} red - The red color value. A number between 0 and 255.\r\n * @param {number} green - The green color value. A number between 0 and 255.\r\n * @param {number} blue - The blue color value. A number between 0 and 255.\r\n * @param {number} alpha - The alpha color value. A number between 0 and 255.\r\n *\r\n * @return {number} The packed 32-bit ARGB color value.\r\n */", "meta": { "filename": "GetColor32.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Packs four ARGB component values (red, green, blue, and alpha) into a single 32-bit integer in ARGB format.", "kind": "function", "name": "GetColor32", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The red color value. A number between 0 and 255.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The green color value. A number between 0 and 255.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blue color value. A number between 0 and 255.", "name": "blue" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha color value. A number between 0 and 255.", "name": "alpha" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The packed 32-bit ARGB color value." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.GetColor32", "scope": "static", "___id": "T000002R005559", "___s": true }, { "comment": "/**\r\n * Converts a hex string into a Phaser Color object.\r\n *\r\n * The hex string can be supplied as `'#0033ff'` or the short-hand format of `'#03f'`; it can begin with an optional \"#\" or \"0x\", or be unprefixed.\r\n *\r\n * An alpha channel is _not_ supported.\r\n *\r\n * @function Phaser.Display.Color.HexStringToColor\r\n * @since 3.0.0\r\n *\r\n * @param {string} hex - The hex color value to convert, such as `#0033ff` or the short-hand format: `#03f`.\r\n * @param {Phaser.Display.Color} [color] - The color where the new color will be stored. If not defined, a new color object is returned.\r\n *\r\n * @return {Phaser.Display.Color} A Color object populated by the values of the given string.\r\n */", "meta": { "filename": "HexStringToColor.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Converts a hex string into a Phaser Color object.\r\rThe hex string can be supplied as `'#0033ff'` or the short-hand format of `'#03f'`; it can begin with an optional \"#\" or \"0x\", or be unprefixed.\r\rAn alpha channel is _not_ supported.", "kind": "function", "name": "HexStringToColor", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The hex color value to convert, such as `#0033ff` or the short-hand format: `#03f`.", "name": "hex" }, { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "optional": true, "description": "The color where the new color will be stored. If not defined, a new color object is returned.", "name": "color" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R005563", "___s": true }, { "comment": "/**\r\n * Converts HSL (hue, saturation and lightness) values to a Phaser Color object.\r\n *\r\n * All three input values should be in the range 0 to 1. If the saturation is 0\r\n * the color is treated as achromatic (greyscale). Otherwise the standard HSL-to-RGB\r\n * algorithm is applied, using the lightness value to derive the intermediate q and p\r\n * coefficients before delegating each channel to `HueToComponent`.\r\n *\r\n * @function Phaser.Display.Color.HSLToColor\r\n * @since 3.0.0\r\n *\r\n * @param {number} h - The hue value in the range 0 to 1.\r\n * @param {number} s - The saturation value in the range 0 to 1.\r\n * @param {number} l - The lightness value in the range 0 to 1.\r\n * @param {Phaser.Display.Color} [color] - An optional Color object to populate with the converted values. If not provided, a new Color object is created and returned.\r\n *\r\n * @return {Phaser.Display.Color} The Color object populated with the RGB values derived from the given h, s and l inputs. This is either the `color` argument (if provided) or a newly created Color object.\r\n */", "meta": { "filename": "HSLToColor.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Converts HSL (hue, saturation and lightness) values to a Phaser Color object.\r\rAll three input values should be in the range 0 to 1. If the saturation is 0\rthe color is treated as achromatic (greyscale). Otherwise the standard HSL-to-RGB\ralgorithm is applied, using the lightness value to derive the intermediate q and p\rcoefficients before delegating each channel to `HueToComponent`.", "kind": "function", "name": "HSLToColor", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The hue value in the range 0 to 1.", "name": "h" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The saturation value in the range 0 to 1.", "name": "s" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The lightness value in the range 0 to 1.", "name": "l" }, { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "optional": true, "description": "An optional Color object to populate with the converted values. If not provided, a new Color object is created and returned.", "name": "color" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "The Color object populated with the RGB values derived from the given h, s and l inputs. This is either the `color` argument (if provided) or a newly created Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.HSLToColor", "scope": "static", "___id": "T000002R005574", "___s": true }, { "comment": "/**\r\n * Generates an HSV color wheel as an array of 360 ColorObject entries, one for each degree of hue from 0 to 359.\r\n *\r\n * @function Phaser.Display.Color.HSVColorWheel\r\n * @since 3.0.0\r\n *\r\n * @param {number} [s=1] - The saturation, in the range 0 - 1.\r\n * @param {number} [v=1] - The value, in the range 0 - 1.\r\n *\r\n * @return {Phaser.Types.Display.ColorObject[]} An array of 360 ColorObject elements, each representing the RGB color at that hue step of the HSV color wheel.\r\n */", "meta": { "filename": "HSVColorWheel.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Generates an HSV color wheel as an array of 360 ColorObject entries, one for each degree of hue from 0 to 359.", "kind": "function", "name": "HSVColorWheel", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The saturation, in the range 0 - 1.", "name": "s" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The value, in the range 0 - 1.", "name": "v" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Display.ColorObject", "type": "NameExpression" } ] } }, "description": "An array of 360 ColorObject elements, each representing the RGB color at that hue step of the HSV color wheel." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.HSVColorWheel", "scope": "static", "___id": "T000002R005587", "___s": true }, { "comment": "/**\r\n * Converts a HSV (hue, saturation and value) color set to RGB.\r\n *\r\n * Conversion formula from https://en.wikipedia.org/wiki/HSL_and_HSV\r\n *\r\n * Assumes HSV values are contained in the set [0, 1].\r\n *\r\n * @function Phaser.Display.Color.HSVToRGB\r\n * @since 3.0.0\r\n *\r\n * @param {number} h - The hue, in the range 0 - 1. This is the base color.\r\n * @param {number} s - 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 a greyscale color.\r\n * @param {number} v - The value, in the range 0 - 1. This controls how bright the color is, where 1 is as bright as possible and 0 is black.\r\n * @param {(Phaser.Types.Display.ColorObject|Phaser.Display.Color)} [out] - A Color object to store the results in. If not given a new ColorObject will be created.\r\n *\r\n * @return {(Phaser.Types.Display.ColorObject|Phaser.Display.Color)} An object with the red, green and blue values set in the r, g and b properties.\r\n */", "meta": { "filename": "HSVToRGB.js", "lineno": 30, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Converts a HSV (hue, saturation and value) color set to RGB.\r\rConversion formula from https://en.wikipedia.org/wiki/HSL_and_HSV\r\rAssumes HSV values are contained in the set [0, 1].", "kind": "function", "name": "HSVToRGB", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The hue, in the range 0 - 1. This is the base color.", "name": "h" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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 a greyscale color.", "name": "s" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value, in the range 0 - 1. This controls how bright 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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Display.ColorObject" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Display.ColorObject" }, { "type": "NameExpression", "name": "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", "___id": "T000002R005598", "___s": true }, { "comment": "/**\r\n * Calculates a single RGB channel value from a hue offset and the two intermediate\r\n * lightness values used during HSL to RGB conversion. Call this function once for each\r\n * channel (red, green, and blue), passing the appropriate hue offset each time.\r\n * Based on code by Michael Jackson (https://github.com/mjijackson)\r\n *\r\n * @function Phaser.Display.Color.HueToComponent\r\n * @since 3.0.0\r\n *\r\n * @param {number} p - The first intermediate value derived from the lightness during HSL to RGB conversion.\r\n * @param {number} q - The second intermediate value derived from the lightness and saturation during HSL to RGB conversion.\r\n * @param {number} t - The hue offset for the color channel being calculated (red, green, or blue).\r\n *\r\n * @return {number} The RGB channel value for the given hue offset, in the range 0 to 1.\r\n */", "meta": { "filename": "HueToComponent.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Calculates a single RGB channel value from a hue offset and the two intermediate\rlightness values used during HSL to RGB conversion. Call this function once for each\rchannel (red, green, and blue), passing the appropriate hue offset each time.\rBased on code by Michael Jackson (https://github.com/mjijackson)", "kind": "function", "name": "HueToComponent", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The first intermediate value derived from the lightness during HSL to RGB conversion.", "name": "p" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The second intermediate value derived from the lightness and saturation during HSL to RGB conversion.", "name": "q" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The hue offset for the color channel being calculated (red, green, or blue).", "name": "t" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The RGB channel value for the given hue offset, in the range 0 to 1." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.HueToComponent", "scope": "static", "___id": "T000002R005614", "___s": true }, { "comment": "/**\r\n * Converts the given color value into an instance of a Color object.\r\n *\r\n * @function Phaser.Display.Color.IntegerToColor\r\n * @since 3.0.0\r\n *\r\n * @param {number} input - The 32-bit integer color value to convert, such as a hex value like `0xff0000` for red.\r\n * @param {Phaser.Display.Color} [color] - An optional Color object to store the result in. If not provided, a new Color object is created and returned.\r\n *\r\n * @return {Phaser.Display.Color} A Color object containing the red, green, blue, and alpha components extracted from the given integer.\r\n */", "meta": { "filename": "IntegerToColor.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Converts the given color value into an instance of a Color object.", "kind": "function", "name": "IntegerToColor", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The 32-bit integer color value to convert, such as a hex value like `0xff0000` for red.", "name": "input" }, { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "optional": true, "description": "An optional Color object to store the result in. If not provided, a new Color object is created and returned.", "name": "color" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "A Color object containing the red, green, blue, and alpha components extracted from the given integer." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.IntegerToColor", "scope": "static", "___id": "T000002R005642", "___s": true }, { "comment": "/**\r\n * Return the component parts of a color as an Object with the properties alpha, red, green, blue.\r\n *\r\n * If the color value includes an alpha component (0xAARRGGBB), it is extracted and set in the `a` property.\r\n * Otherwise, alpha defaults to 255 (fully opaque).\r\n *\r\n * @function Phaser.Display.Color.IntegerToRGB\r\n * @since 3.0.0\r\n *\r\n * @param {number} color - The color value to convert into a Color object.\r\n *\r\n * @return {Phaser.Types.Display.ColorObject} An object with the alpha, red, green, and blue values set in the a, r, g, and b properties.\r\n */", "meta": { "filename": "IntegerToRGB.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Return the component parts of a color as an Object with the properties alpha, red, green, blue.\r\rIf the color value includes an alpha component (0xAARRGGBB), it is extracted and set in the `a` property.\rOtherwise, alpha defaults to 255 (fully opaque).", "kind": "function", "name": "IntegerToRGB", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color value to convert into a Color object.", "name": "color" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Display.ColorObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Display.ColorObject" } }, "description": "An object with the alpha, red, green, and blue values set in the a, r, g, and b properties." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.IntegerToRGB", "scope": "static", "___id": "T000002R005646", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Display.Color.Interpolate\r\n * @memberof Phaser.Display.Color\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Interpolate.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "kind": "namespace", "name": "Interpolate", "memberof": "Phaser.Display.Color", "since": "3.0.0", "longname": "Phaser.Display.Color.Interpolate", "scope": "static", "___id": "T000002R005660", "___s": true }, { "comment": "/**\r\n * Interpolates between the two given RGB color values over the length supplied.\r\n *\r\n * @function Phaser.Display.Color.Interpolate.RGBWithRGB\r\n * @memberof Phaser.Display.Color.Interpolate\r\n * @static\r\n * @since 3.0.0\r\n *\r\n * @param {number} r1 - Red value.\r\n * @param {number} g1 - Green value.\r\n * @param {number} b1 - Blue value.\r\n * @param {number} r2 - Red value.\r\n * @param {number} g2 - Green value.\r\n * @param {number} b2 - Blue value.\r\n * @param {number} [length=100] - Distance to interpolate over.\r\n * @param {number} [index=0] - Index to start from.\r\n *\r\n * @return {Phaser.Types.Display.ColorObject} An object containing the interpolated color values.\r\n */", "meta": { "filename": "Interpolate.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Interpolates between the two given RGB color values over the length supplied.", "kind": "function", "name": "RGBWithRGB", "memberof": "Phaser.Display.Color.Interpolate", "scope": "static", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Red value.", "name": "r1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Green value.", "name": "g1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Blue value.", "name": "b1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Red value.", "name": "r2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Green value.", "name": "g2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Blue value.", "name": "b2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 100, "description": "Distance to interpolate over.", "name": "length" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Index to start from.", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Display.ColorObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Display.ColorObject" } }, "description": "An object containing the interpolated color values." } ], "longname": "Phaser.Display.Color.Interpolate.RGBWithRGB", "___id": "T000002R005661", "___s": true }, { "comment": "/**\r\n * Interpolates between the two given HSV color ranges over the length supplied.\r\n * The `sign` parameter controls the direction of hue interpolation: 0 finds the\r\n * nearest path, a positive value always increases hue, and a negative value always\r\n * decreases hue.\r\n *\r\n * @function Phaser.Display.Color.Interpolate.HSVWithHSV\r\n * @memberof Phaser.Display.Color.Interpolate\r\n * @static\r\n * @since 4.0.0\r\n *\r\n * @param {number} h1 - Hue of the first color (0 to 1).\r\n * @param {number} s1 - Saturation of the first color (0 to 1).\r\n * @param {number} v1 - Value (brightness) of the first color (0 to 1).\r\n * @param {number} h2 - Hue of the second color (0 to 1).\r\n * @param {number} s2 - Saturation of the second color (0 to 1).\r\n * @param {number} v2 - Value (brightness) of the second color (0 to 1).\r\n * @param {number} [length=100] - Distance to interpolate over.\r\n * @param {number} [index=0] - Index to start from.\r\n * @param {number} [sign=0] - Hue interpolation direction. 0 = nearest, positive = always increase, negative = always decrease.\r\n *\r\n * @return {Phaser.Types.Display.ColorObject} An object containing the interpolated color values.\r\n */", "meta": { "filename": "Interpolate.js", "lineno": 55, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Interpolates between the two given HSV color ranges over the length supplied.\rThe `sign` parameter controls the direction of hue interpolation: 0 finds the\rnearest path, a positive value always increases hue, and a negative value always\rdecreases hue.", "kind": "function", "name": "HSVWithHSV", "memberof": "Phaser.Display.Color.Interpolate", "scope": "static", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Hue of the first color (0 to 1).", "name": "h1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Saturation of the first color (0 to 1).", "name": "s1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Value (brightness) of the first color (0 to 1).", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Hue of the second color (0 to 1).", "name": "h2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Saturation of the second color (0 to 1).", "name": "s2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Value (brightness) of the second color (0 to 1).", "name": "v2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 100, "description": "Distance to interpolate over.", "name": "length" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Index to start from.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Hue interpolation direction. 0 = nearest, positive = always increase, negative = always decrease.", "name": "sign" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Display.ColorObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Display.ColorObject" } }, "description": "An object containing the interpolated color values." } ], "longname": "Phaser.Display.Color.Interpolate.HSVWithHSV", "___id": "T000002R005674", "___s": true }, { "comment": "/**\r\n * Interpolates between the two given color objects over the length supplied.\r\n *\r\n * @function Phaser.Display.Color.Interpolate.ColorWithColor\r\n * @memberof Phaser.Display.Color.Interpolate\r\n * @static\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Display.Color} color1 - The first Color object.\r\n * @param {Phaser.Display.Color} color2 - The second Color object.\r\n * @param {number} [length=100] - Distance to interpolate over.\r\n * @param {number} [index=0] - Index to start from.\r\n * @param {boolean} [hsv=false] - Whether to interpolate in HSV.\r\n * @param {number} [hsvSign=0] - Preferred direction for HSV interpolation. 0 is nearest, negative always decreases hue, positive always increases hue.\r\n *\r\n * @return {Phaser.Types.Display.ColorObject} An object containing the interpolated color values.\r\n */", "meta": { "filename": "Interpolate.js", "lineno": 102, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "The first Color object.", "name": "color1" }, { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "The second Color object.", "name": "color2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 100, "description": "Distance to interpolate over.", "name": "length" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Index to start from.", "name": "index" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to interpolate in HSV.", "name": "hsv" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Preferred direction for HSV interpolation. 0 is nearest, negative always decreases hue, positive always increases hue.", "name": "hsvSign" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Display.ColorObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Display.ColorObject" } }, "description": "An object containing the interpolated color values." } ], "longname": "Phaser.Display.Color.Interpolate.ColorWithColor", "___id": "T000002R005686", "___s": true }, { "comment": "/**\r\n * Interpolates between the Color object and color values over the length supplied.\r\n *\r\n * @function Phaser.Display.Color.Interpolate.ColorWithRGB\r\n * @memberof Phaser.Display.Color.Interpolate\r\n * @static\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Display.Color} color - The Color object.\r\n * @param {number} r - Red value.\r\n * @param {number} g - Green value.\r\n * @param {number} b - Blue value.\r\n * @param {number} [length=100] - Distance to interpolate over.\r\n * @param {number} [index=0] - Index to start from.\r\n *\r\n * @return {Phaser.Types.Display.ColorObject} An object containing the interpolated color values.\r\n */", "meta": { "filename": "Interpolate.js", "lineno": 132, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "The Color object.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Red value.", "name": "r" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Green value.", "name": "g" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Blue value.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 100, "description": "Distance to interpolate over.", "name": "length" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Index to start from.", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Display.ColorObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Display.ColorObject" } }, "description": "An object containing the interpolated color values." } ], "longname": "Phaser.Display.Color.Interpolate.ColorWithRGB", "___id": "T000002R005690", "___s": true }, { "comment": "/**\r\n * Converts an object containing `r`, `g`, `b` and `a` properties into a Color class instance.\r\n *\r\n * @function Phaser.Display.Color.ObjectToColor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Display.InputColorObject} input - An object containing `r`, `g`, `b` and `a` properties in the range 0 to 255.\r\n * @param {Phaser.Display.Color} [color] - The color where the new color will be stored. If not defined, a new color object is returned.\r\n *\r\n * @return {Phaser.Display.Color} A Color object.\r\n */", "meta": { "filename": "ObjectToColor.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Display.InputColorObject" } }, "description": "An object containing `r`, `g`, `b` and `a` properties in the range 0 to 255.", "name": "input" }, { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "optional": true, "description": "The color where the new color will be stored. If not defined, a new color object is returned.", "name": "color" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "A Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.ObjectToColor", "scope": "static", "___id": "T000002R005700", "___s": true }, { "comment": "/**\r\n * Creates a new Color object where the r, g, and b values have been set to random values\r\n * based on the given min max values.\r\n *\r\n * @function Phaser.Display.Color.RandomRGB\r\n * @since 3.0.0\r\n *\r\n * @param {number} [min=0] - The minimum value to set the random range from (between 0 and 255)\r\n * @param {number} [max=255] - The maximum value to set the random range from (between 0 and 255)\r\n *\r\n * @return {Phaser.Display.Color} A Color object.\r\n */", "meta": { "filename": "RandomRGB.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Creates a new Color object where the r, g, and b values have been set to random values\rbased on the given min max values.", "kind": "function", "name": "RandomRGB", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The minimum value to set the random range from (between 0 and 255)", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "A Color object." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.RandomRGB", "scope": "static", "___id": "T000002R005705", "___s": true }, { "comment": "/**\r\n * Converts a CSS 'web' string into a Phaser Color object.\r\n *\r\n * The 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].\r\n *\r\n * @function Phaser.Display.Color.RGBStringToColor\r\n * @since 3.0.0\r\n *\r\n * @param {string} rgb - The CSS format color string, using the `rgb` or `rgba` format.\r\n * @param {Phaser.Display.Color} [color] - An optional Color object to populate with the parsed values. If not provided, a new Color object is created and returned.\r\n *\r\n * @return {Phaser.Display.Color} The Color object populated with the parsed RGB or RGBA values.\r\n */", "meta": { "filename": "RGBStringToColor.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Converts a CSS 'web' string into a Phaser Color object.\r\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The CSS format color string, using the `rgb` or `rgba` format.", "name": "rgb" }, { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "optional": true, "description": "An optional Color object to populate with the parsed values. If not provided, a new Color object is created and returned.", "name": "color" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "The Color object populated with the parsed RGB or RGBA values." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.RGBStringToColor", "scope": "static", "___id": "T000002R005711", "___s": true }, { "comment": "/**\r\n * Converts an RGB color value to HSV (hue, saturation and value).\r\n * Conversion formula from http://en.wikipedia.org/wiki/HSL_color_space.\r\n * Assumes RGB values are contained in the set [0, 255] and returns h, s and v in the set [0, 1].\r\n * Based on code by Michael Jackson (https://github.com/mjijackson)\r\n *\r\n * @function Phaser.Display.Color.RGBToHSV\r\n * @since 3.0.0\r\n *\r\n * @param {number} r - The red color value. A number between 0 and 255.\r\n * @param {number} g - The green color value. A number between 0 and 255.\r\n * @param {number} b - The blue color value. A number between 0 and 255.\r\n * @param {(Phaser.Types.Display.HSVColorObject|Phaser.Display.Color)} [out] - An object to store the color values in. If not given an HSV Color Object will be created.\r\n *\r\n * @return {(Phaser.Types.Display.HSVColorObject|Phaser.Display.Color)} An object with the properties `h`, `s` and `v` set.\r\n */", "meta": { "filename": "RGBToHSV.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Converts an RGB color value to HSV (hue, saturation and value).\rConversion formula from http://en.wikipedia.org/wiki/HSL_color_space.\rAssumes RGB values are contained in the set [0, 255] and returns h, s and v in the set [0, 1].\rBased on code by Michael Jackson (https://github.com/mjijackson)", "kind": "function", "name": "RGBToHSV", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The red color value. A number between 0 and 255.", "name": "r" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The green color value. A number between 0 and 255.", "name": "g" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blue color value. A number between 0 and 255.", "name": "b" }, { "type": { "names": [ "Phaser.Types.Display.HSVColorObject", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Display.HSVColorObject" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Display.HSVColorObject" }, { "type": "NameExpression", "name": "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", "___id": "T000002R005720", "___s": true }, { "comment": "/**\r\n * Converts the given red, green, blue, and alpha color component values into a hex color string.\r\n *\r\n * When using the `#` prefix the result is a 6-character CSS-compatible hex string in `#rrggbb` format.\r\n * The alpha value is not included in this format.\r\n *\r\n * When using the `0x` prefix the result is an 8-character ARGB hex string in `0xaarrggbb` format,\r\n * which includes the alpha component as the most significant byte.\r\n *\r\n * @function Phaser.Display.Color.RGBToString\r\n * @since 3.0.0\r\n *\r\n * @param {number} r - The red color value. A number between 0 and 255.\r\n * @param {number} g - The green color value. A number between 0 and 255.\r\n * @param {number} b - The blue color value. A number between 0 and 255.\r\n * @param {number} [a=255] - The alpha value. A number between 0 and 255.\r\n * @param {string} [prefix=#] - The prefix of the string. Either `#` or `0x`.\r\n *\r\n * @return {string} A hex color string in either `#rrggbb` or `0xaarrggbb` format, depending on the prefix.\r\n */", "meta": { "filename": "RGBToString.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Converts the given red, green, blue, and alpha color component values into a hex color string.\r\rWhen using the `#` prefix the result is a 6-character CSS-compatible hex string in `#rrggbb` format.\rThe alpha value is not included in this format.\r\rWhen using the `0x` prefix the result is an 8-character ARGB hex string in `0xaarrggbb` format,\rwhich includes the alpha component as the most significant byte.", "kind": "function", "name": "RGBToString", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The red color value. A number between 0 and 255.", "name": "r" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The green color value. A number between 0 and 255.", "name": "g" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blue color value. A number between 0 and 255.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 255, "description": "The alpha value. A number between 0 and 255.", "name": "a" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "#", "description": "The prefix of the string. Either `#` or `0x`.", "name": "prefix" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A hex color string in either `#rrggbb` or `0xaarrggbb` format, depending on the prefix." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.RGBToString", "scope": "static", "___id": "T000002R005747", "___s": true }, { "comment": "/**\r\n * Converts the given source color value into an instance of a Color class.\r\n * The value can be a string (either prefixed with `rgb` for an RGB color string, or a hex color string),\r\n * a number representing a packed RGB integer, or a plain object with `r`, `g`, and `b` properties.\r\n *\r\n * @function Phaser.Display.Color.ValueToColor\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number|Phaser.Types.Display.InputColorObject)} input - The source color value to convert.\r\n * @param {Phaser.Display.Color} [color] - An existing Color object to store the result in. If not provided, a new Color object is created and returned.\r\n *\r\n * @return {Phaser.Display.Color} A Color object containing the converted color value.\r\n */", "meta": { "filename": "ValueToColor.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\color", "code": {} }, "description": "Converts the given source color value into an instance of a Color class.\rThe value can be a string (either prefixed with `rgb` for an RGB color string, or a hex color string),\ra number representing a packed RGB integer, or a plain object with `r`, `g`, and `b` properties.", "kind": "function", "name": "ValueToColor", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "number", "Phaser.Types.Display.InputColorObject" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.Display.InputColorObject" } ] } }, "description": "The source color value to convert.", "name": "input" }, { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "optional": true, "description": "An existing Color object to store the result in. If not provided, a new Color object is created and returned.", "name": "color" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "description": "A Color object containing the converted color value." } ], "memberof": "Phaser.Display.Color", "longname": "Phaser.Display.Color.ValueToColor", "scope": "static", "___id": "T000002R005756", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The ColorBand class represents a transition from one color to another.\r\n * It is used in a {@see Phaser.Display.ColorRamp}, and forms the basis\r\n * of a {@see Phaser.GameObjects.Gradient}.\r\n *\r\n * ColorBand can control the transition by setting a middle point,\r\n * a color space for blending, and an interpolation style.\r\n *\r\n * This class also records `start` and `end` points for use in a ramp.\r\n * These indicate its position within the ramp.\r\n *\r\n * Colors are handled unpremultiplied, so RGB values may be larger than alpha.\r\n *\r\n * @class ColorBand\r\n * @memberof Phaser.Display\r\n * @since 4.0.0\r\n * @constructor\r\n *\r\n * @param {Phaser.Types.Display.ColorBandConfig} [config] - The configuration to use for the band.\r\n */", "meta": { "filename": "ColorBand.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "classdesc": "The ColorBand class represents a transition from one color to another.\rIt is used in a {@see Phaser.Display.ColorRamp}, and forms the basis\rof a {@see Phaser.GameObjects.Gradient}.\r\rColorBand can control the transition by setting a middle point,\ra color space for blending, and an interpolation style.\r\rThis class also records `start` and `end` points for use in a ramp.\rThese indicate its position within the ramp.\r\rColors are handled unpremultiplied, so RGB values may be larger than alpha.", "kind": "class", "name": "ColorBand", "memberof": "Phaser.Display", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Display.ColorBandConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Display.ColorBandConfig" } }, "optional": true, "description": "The configuration to use for the band.", "name": "config" } ], "scope": "static", "longname": "Phaser.Display.ColorBand", "___id": "T000002R005765", "___s": true }, { "comment": "/**\r\n * Identifies this object as a ColorBand.\r\n * This property is read-only and must not be modified.\r\n *\r\n * @name Phaser.Display.ColorBand#isColorBand\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default true\r\n * @readonly\r\n */", "meta": { "filename": "ColorBand.js", "lineno": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Identifies this object as a ColorBand.\rThis property is read-only and must not be modified.", "name": "isColorBand", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "true", "readonly": true, "memberof": "Phaser.Display.ColorBand", "longname": "Phaser.Display.ColorBand#isColorBand", "scope": "instance", "kind": "member", "___id": "T000002R005769", "___s": true }, { "comment": "/**\r\n * The color at the start of the color band.\r\n *\r\n * @name Phaser.Display.ColorBand#colorStart\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorBand.js", "lineno": 51, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The color at the start of the color band.", "name": "colorStart", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.Display.ColorBand", "longname": "Phaser.Display.ColorBand#colorStart", "scope": "instance", "kind": "member", "___id": "T000002R005771", "___s": true }, { "comment": "/**\r\n * The color at the end of the color band.\r\n *\r\n * @name Phaser.Display.ColorBand#colorEnd\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorBand.js", "lineno": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The color at the end of the color band.", "name": "colorEnd", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.Display.ColorBand", "longname": "Phaser.Display.ColorBand#colorEnd", "scope": "instance", "kind": "member", "___id": "T000002R005773", "___s": true }, { "comment": "/**\r\n * The start point of this band within a ColorRamp.\r\n * This value should be normalized within the ramp,\r\n * between 0 (ramp start) and 1 (ramp end).\r\n *\r\n * @name Phaser.Display.ColorBand#start\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorBand.js", "lineno": 69, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The start point of this band within a ColorRamp.\rThis value should be normalized within the ramp,\rbetween 0 (ramp start) and 1 (ramp end).", "name": "start", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Display.ColorBand", "longname": "Phaser.Display.ColorBand#start", "scope": "instance", "kind": "member", "___id": "T000002R005775", "___s": true }, { "comment": "/**\r\n * The middle point of this band within a ColorRamp.\r\n * This value should be normalized within the band,\r\n * between 0 (band start) and 1 (band end).\r\n * Middle point alters the shape of the color interpolation.\r\n *\r\n * Mathematically, the gradient should be 0.5 at the middle.\r\n * We use a gamma curve to adjust the gradient.\r\n * Thus, `0.5 = middle^gamma`.\r\n * By the properties of logarithms, therefore,\r\n * `gamma = log base middle of 0.5`.\r\n *\r\n * @name Phaser.Display.ColorBand#middle\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorBand.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The middle point of this band within a ColorRamp.\rThis value should be normalized within the band,\rbetween 0 (band start) and 1 (band end).\rMiddle point alters the shape of the color interpolation.\r\rMathematically, the gradient should be 0.5 at the middle.\rWe use a gamma curve to adjust the gradient.\rThus, `0.5 = middle^gamma`.\rBy the properties of logarithms, therefore,\r`gamma = log base middle of 0.5`.", "name": "middle", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Display.ColorBand", "longname": "Phaser.Display.ColorBand#middle", "scope": "instance", "kind": "member", "___id": "T000002R005777", "___s": true }, { "comment": "/**\r\n * The end point of this band within a ColorRamp.\r\n * This value should be normalized within the ramp,\r\n * between 0 (ramp start) and 1 (ramp end).\r\n *\r\n * @name Phaser.Display.ColorBand#end\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorBand.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The end point of this band within a ColorRamp.\rThis value should be normalized within the ramp,\rbetween 0 (ramp start) and 1 (ramp end).", "name": "end", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Display.ColorBand", "longname": "Phaser.Display.ColorBand#end", "scope": "instance", "kind": "member", "___id": "T000002R005779", "___s": true }, { "comment": "/**\r\n * The color interpolation.\r\n * This can be one of the following codes:\r\n *\r\n * - 0: LINEAR - a straight blend.\r\n * - 1: CURVED - color changes quickly at start and end,\r\n * flattening in the middle. Good for convex surfaces.\r\n * - 2: SINUSOIDAL - color changes quickly in the middle,\r\n * flattening at start and end. Good for smooth transitions.\r\n * - 3: CURVE_START - color changes quickly at the start,\r\n * flattening at the end.\r\n * - 4: CURVE_END - color changes quickly at the end,\r\n * flattening at the start.\r\n *\r\n * Modes 2, 3, and 4 use the circular easing function directly.\r\n * Mode 1 uses a related custom formula based on the unit circle.\r\n *\r\n * @name Phaser.Display.ColorBand#interpolation\r\n * @type {number}\r\n * @default 0\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorBand.js", "lineno": 111, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The color interpolation.\rThis can be one of the following codes:\r\r- 0: LINEAR - a straight blend.\r- 1: CURVED - color changes quickly at start and end,\r flattening in the middle. Good for convex surfaces.\r- 2: SINUSOIDAL - color changes quickly in the middle,\r flattening at start and end. Good for smooth transitions.\r- 3: CURVE_START - color changes quickly at the start,\r flattening at the end.\r- 4: CURVE_END - color changes quickly at the end,\r flattening at the start.\r\rModes 2, 3, and 4 use the circular easing function directly.\rMode 1 uses a related custom formula based on the unit circle.", "name": "interpolation", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.0.0", "memberof": "Phaser.Display.ColorBand", "longname": "Phaser.Display.ColorBand#interpolation", "scope": "instance", "kind": "member", "___id": "T000002R005783", "___s": true }, { "comment": "/**\r\n * The color space where interpolation should be done.\r\n * This can be one of the following codes:\r\n *\r\n * - 0: RGBA - channels are blended directly.\r\n * This can produce perceptually inaccurate results, as blending\r\n * in RGB space does not account for how humans perceive color.\r\n * - 1: HSVA_NEAREST - colors are blended in HSVA space,\r\n * better preserving saturation and lightness.\r\n * The hue is blended with the shortest angle, e.g. red and blue\r\n * blend via purple, not green.\r\n * - 2: HSVA_PLUS - as HSVA_NEAREST, but hue angle always increases.\r\n * - 3: HSVA_MINUS - as HSVA_NEAREST, but hue angle always decreases.\r\n *\r\n * @name Phaser.Display.ColorBand#colorSpace\r\n * @type {number}\r\n * @default 0\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorBand.js", "lineno": 135, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The color space where interpolation should be done.\rThis can be one of the following codes:\r\r- 0: RGBA - channels are blended directly.\r This can produce perceptually inaccurate results, as blending\r in RGB space does not account for how humans perceive color.\r- 1: HSVA_NEAREST - colors are blended in HSVA space,\r better preserving saturation and lightness.\r The hue is blended with the shortest angle, e.g. red and blue\r blend via purple, not green.\r- 2: HSVA_PLUS - as HSVA_NEAREST, but hue angle always increases.\r- 3: HSVA_MINUS - as HSVA_NEAREST, but hue angle always decreases.", "name": "colorSpace", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.0.0", "memberof": "Phaser.Display.ColorBand", "longname": "Phaser.Display.ColorBand#colorSpace", "scope": "instance", "kind": "member", "___id": "T000002R005785", "___s": true }, { "comment": "/**\r\n * Set the colors of the band, from a variety of color formats.\r\n *\r\n * - A number is expected to be a 24 or 32 bit RGB or ARGB value.\r\n * - A string is expected to be a hex code.\r\n * - An array of numbers is expected to be RGB or RGBA in the range 0-1.\r\n * - A Color object can be used.\r\n *\r\n * @method Phaser.Display.ColorBand#setColors\r\n * @since 4.0.0\r\n * @param {number | string | number[] | Phaser.Display.Color} [start=0x000000] - The color at the start of the band.\r\n * @param {number | string | number[] | Phaser.Display.Color} [end] - The color at the end of the band. If not specified, equals `start`.\r\n * @return {this} This ColorBand.\r\n */", "meta": { "filename": "ColorBand.js", "lineno": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Set the colors of the band, from a variety of color formats.\r\r- A number is expected to be a 24 or 32 bit RGB or ARGB value.\r- A string is expected to be a hex code.\r- An array of numbers is expected to be RGB or RGBA in the range 0-1.\r- A Color object can be used.", "kind": "function", "name": "setColors", "since": "4.0.0", "params": [ { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color at the start of the band.", "name": "start" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "description": "The color at the end of the band. If not specified, equals `start`.", "name": "end" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorBand." } ], "memberof": "Phaser.Display.ColorBand", "longname": "Phaser.Display.ColorBand#setColors", "scope": "instance", "___id": "T000002R005787", "___s": true }, { "comment": "/**\r\n * Returns the blended color at a normalized position within this band.\r\n * The middle point gamma curve, interpolation mode, and color space are\r\n * all applied before blending between `colorStart` and `colorEnd`.\r\n *\r\n * @method Phaser.Display.ColorBand#getColor\r\n * @since 4.0.0\r\n * @param {number} index - The normalized position within the band, where 0 is the band start and 1 is the band end.\r\n * @return {Phaser.Types.Display.ColorObject} The blended color at that position.\r\n */", "meta": { "filename": "ColorBand.js", "lineno": 225, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Returns the blended color at a normalized position within this band.\rThe middle point gamma curve, interpolation mode, and color space are\rall applied before blending between `colorStart` and `colorEnd`.", "kind": "function", "name": "getColor", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The normalized position within the band, where 0 is the band start and 1 is the band end.", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Display.ColorObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Display.ColorObject" } }, "description": "The blended color at that position." } ], "memberof": "Phaser.Display.ColorBand", "longname": "Phaser.Display.ColorBand#getColor", "scope": "instance", "___id": "T000002R005794", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The ColorMatrix class creates a 5x4 matrix that can be used in shaders and graphics\r\n * operations. It provides methods required to modify the color values, such as adjusting\r\n * the brightness, setting a sepia tone, hue rotation and more.\r\n *\r\n * The matrix rows (indices 0, 1, 2, 3, 4 form the first row)\r\n * are summed to create the red, green, blue, and alpha channels in order.\r\n * The matrix columns (indices 0, 5, 10, 15 form the first column)\r\n * describe contributions from the initial channels,\r\n * typically in the range -1 to 1.\r\n * The last column (4, 9, 14, 19) contains an addition,\r\n * expected to be in the range 0-255 (although other values are valid).\r\n * For example, to set the red channel to the contents of the green channel,\r\n * the first row would be [0, 1, 0, 0, 0].\r\n * To set the red channel to full, regardless of current channels,\r\n * the first row would be [0, 0, 0, 0, 255].\r\n *\r\n * These operations are the default use,\r\n * but you can use ColorMatrix to conveniently store data for other purposes.\r\n *\r\n * Use the method `getData` to return a Float32Array containing the current color values.\r\n * This shrinks the addition column from the range 0-255 to 0-1\r\n * (but does not clamp it).\r\n *\r\n * @class ColorMatrix\r\n * @memberof Phaser.Display\r\n * @constructor\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "classdesc": "The ColorMatrix class creates a 5x4 matrix that can be used in shaders and graphics\roperations. It provides methods required to modify the color values, such as adjusting\rthe brightness, setting a sepia tone, hue rotation and more.\r\rThe matrix rows (indices 0, 1, 2, 3, 4 form the first row)\rare summed to create the red, green, blue, and alpha channels in order.\rThe matrix columns (indices 0, 5, 10, 15 form the first column)\rdescribe contributions from the initial channels,\rtypically in the range -1 to 1.\rThe last column (4, 9, 14, 19) contains an addition,\rexpected to be in the range 0-255 (although other values are valid).\rFor example, to set the red channel to the contents of the green channel,\rthe first row would be [0, 1, 0, 0, 0].\rTo set the red channel to full, regardless of current channels,\rthe first row would be [0, 0, 0, 0, 255].\r\rThese operations are the default use,\rbut you can use ColorMatrix to conveniently store data for other purposes.\r\rUse the method `getData` to return a Float32Array containing the current color values.\rThis shrinks the addition column from the range 0-255 to 0-1\r(but does not clamp it).", "kind": "class", "name": "ColorMatrix", "memberof": "Phaser.Display", "since": "3.50.0", "scope": "static", "longname": "Phaser.Display.ColorMatrix", "___id": "T000002R005814", "___s": true }, { "comment": "/**\r\n * The value that determines how much of the original color is used\r\n * when mixing the colors. A value between 0 (all original) and 1 (all final)\r\n *\r\n * @name Phaser.Display.ColorMatrix#alpha\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The value that determines how much of the original color is used\rwhen mixing the colors. A value between 0 (all original) and 1 (all final)", "name": "alpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#alpha", "scope": "instance", "kind": "member", "___id": "T000002R005819", "___s": true }, { "comment": "/**\r\n * Sets this ColorMatrix from the given array of color values.\r\n *\r\n * @method Phaser.Display.ColorMatrix#set\r\n * @since 3.50.0\r\n *\r\n * @param {(number[]|Float32Array)} value - The ColorMatrix values to set. Must have 20 elements.\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Sets this ColorMatrix from the given array of color values.", "kind": "function", "name": "set", "since": "3.50.0", "params": [ { "type": { "names": [ "Array.", "Float32Array" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Float32Array" } ] } }, "description": "The ColorMatrix values to set. Must have 20 elements.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#set", "scope": "instance", "___id": "T000002R005825", "___s": true }, { "comment": "/**\r\n * Resets the ColorMatrix to default values and also resets\r\n * the `alpha` property back to 1.\r\n *\r\n * @method Phaser.Display.ColorMatrix#reset\r\n * @since 3.50.0\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 111, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Resets the ColorMatrix to default values and also resets\rthe `alpha` property back to 1.", "kind": "function", "name": "reset", "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#reset", "scope": "instance", "___id": "T000002R005828", "___s": true }, { "comment": "/**\r\n * Gets the ColorMatrix as a Float32Array.\r\n *\r\n * Can be used directly as a 1fv shader uniform value.\r\n *\r\n * @method Phaser.Display.ColorMatrix#getData\r\n * @since 3.50.0\r\n *\r\n * @return {Float32Array} The ColorMatrix as a Float32Array.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 138, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Gets the ColorMatrix as a Float32Array.\r\rCan be used directly as a 1fv shader uniform value.", "kind": "function", "name": "getData", "since": "3.50.0", "returns": [ { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The ColorMatrix as a Float32Array." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#getData", "scope": "instance", "___id": "T000002R005837", "___s": true }, { "comment": "/**\r\n * Changes the brightness of this ColorMatrix by the given amount.\r\n *\r\n * @method Phaser.Display.ColorMatrix#brightness\r\n * @since 3.50.0\r\n *\r\n * @param {number} [value=0] - The amount of brightness to apply to this ColorMatrix. Between 0 (black) and 1.\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Changes the brightness of this ColorMatrix by the given amount.", "kind": "function", "name": "brightness", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount of brightness to apply to this ColorMatrix. Between 0 (black) and 1.", "name": "value" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#brightness", "scope": "instance", "___id": "T000002R005845", "___s": true }, { "comment": "/**\r\n * Changes the saturation of this ColorMatrix by the given amount.\r\n *\r\n * @method Phaser.Display.ColorMatrix#saturate\r\n * @since 3.50.0\r\n *\r\n * @param {number} [value=0] - The amount of saturation to apply to this ColorMatrix.\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 193, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Changes the saturation of this ColorMatrix by the given amount.", "kind": "function", "name": "saturate", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount of saturation to apply to this ColorMatrix.", "name": "value" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#saturate", "scope": "instance", "___id": "T000002R005850", "___s": true }, { "comment": "/**\r\n * Desaturates this ColorMatrix (removes color from it).\r\n *\r\n * @method Phaser.Display.ColorMatrix#desaturate\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 220, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Desaturates this ColorMatrix (removes color from it).", "kind": "function", "name": "desaturate", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#desaturate", "scope": "instance", "___id": "T000002R005856", "___s": true }, { "comment": "/**\r\n * Rotates the hues of this ColorMatrix by the value given.\r\n *\r\n * @method Phaser.Display.ColorMatrix#hue\r\n * @since 3.50.0\r\n *\r\n * @param {number} [rotation=0] - The amount of hue rotation to apply to this ColorMatrix, in degrees.\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Rotates the hues of this ColorMatrix by the value given.", "kind": "function", "name": "hue", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount of hue rotation to apply to this ColorMatrix, in degrees.", "name": "rotation" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#hue", "scope": "instance", "___id": "T000002R005859", "___s": true }, { "comment": "/**\r\n * Sets this ColorMatrix to be grayscale.\r\n *\r\n * @method Phaser.Display.ColorMatrix#grayscale\r\n * @since 3.50.0\r\n *\r\n * @param {number} [value=1] - The grayscale scale (0 is black).\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Sets this ColorMatrix to be grayscale.", "kind": "function", "name": "grayscale", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The grayscale scale (0 is black).", "name": "value" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#grayscale", "scope": "instance", "___id": "T000002R005869", "___s": true }, { "comment": "/**\r\n * Sets this ColorMatrix to be black and white.\r\n *\r\n * @method Phaser.Display.ColorMatrix#blackWhite\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Sets this ColorMatrix to be black and white.", "kind": "function", "name": "blackWhite", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#blackWhite", "scope": "instance", "___id": "T000002R005873", "___s": true }, { "comment": "/**\r\n * Sets this ColorMatrix to be black, only preserving alpha.\r\n * Useful for cases where you only want the alpha.\r\n *\r\n * @method Phaser.Display.ColorMatrix#black\r\n * @since 4.0.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 305, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Sets this ColorMatrix to be black, only preserving alpha.\rUseful for cases where you only want the alpha.", "kind": "function", "name": "black", "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#black", "scope": "instance", "___id": "T000002R005876", "___s": true }, { "comment": "/**\r\n * Change the contrast of this ColorMatrix by the amount given.\r\n *\r\n * @method Phaser.Display.ColorMatrix#contrast\r\n * @since 3.50.0\r\n *\r\n * @param {number} [value=0] - The amount of contrast to apply to this ColorMatrix.\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 321, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Change the contrast of this ColorMatrix by the amount given.", "kind": "function", "name": "contrast", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount of contrast to apply to this ColorMatrix.", "name": "value" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#contrast", "scope": "instance", "___id": "T000002R005878", "___s": true }, { "comment": "/**\r\n * Converts this ColorMatrix to have negative values.\r\n *\r\n * @method Phaser.Display.ColorMatrix#negative\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 348, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Converts this ColorMatrix to have negative values.", "kind": "function", "name": "negative", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#negative", "scope": "instance", "___id": "T000002R005884", "___s": true }, { "comment": "/**\r\n * Apply a desaturated luminance to this ColorMatrix.\r\n *\r\n * @method Phaser.Display.ColorMatrix#desaturateLuminance\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 365, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Apply a desaturated luminance to this ColorMatrix.", "kind": "function", "name": "desaturateLuminance", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#desaturateLuminance", "scope": "instance", "___id": "T000002R005887", "___s": true }, { "comment": "/**\r\n * Applies a sepia tone to this ColorMatrix.\r\n *\r\n * @method Phaser.Display.ColorMatrix#sepia\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 382, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Applies a sepia tone to this ColorMatrix.", "kind": "function", "name": "sepia", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#sepia", "scope": "instance", "___id": "T000002R005890", "___s": true }, { "comment": "/**\r\n * Applies a night vision tone to this ColorMatrix.\r\n *\r\n * @method Phaser.Display.ColorMatrix#night\r\n * @since 3.50.0\r\n *\r\n * @param {number} [intensity=0.1] - The intensity of this effect.\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 399, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Applies a night vision tone to this ColorMatrix.", "kind": "function", "name": "night", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "The intensity of this effect.", "name": "intensity" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#night", "scope": "instance", "___id": "T000002R005893", "___s": true }, { "comment": "/**\r\n * Applies a trippy color tone to this ColorMatrix.\r\n *\r\n * @method Phaser.Display.ColorMatrix#lsd\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 423, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Applies a trippy color tone to this ColorMatrix.", "kind": "function", "name": "lsd", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#lsd", "scope": "instance", "___id": "T000002R005897", "___s": true }, { "comment": "/**\r\n * Applies a brown tone to this ColorMatrix.\r\n *\r\n * @method Phaser.Display.ColorMatrix#brown\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 440, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Applies a brown tone to this ColorMatrix.", "kind": "function", "name": "brown", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#brown", "scope": "instance", "___id": "T000002R005900", "___s": true }, { "comment": "/**\r\n * Applies a vintage pinhole color effect to this ColorMatrix.\r\n *\r\n * @method Phaser.Display.ColorMatrix#vintagePinhole\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 457, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Applies a vintage pinhole color effect to this ColorMatrix.", "kind": "function", "name": "vintagePinhole", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#vintagePinhole", "scope": "instance", "___id": "T000002R005903", "___s": true }, { "comment": "/**\r\n * Applies a kodachrome color effect to this ColorMatrix.\r\n *\r\n * @method Phaser.Display.ColorMatrix#kodachrome\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 474, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Applies a kodachrome color effect to this ColorMatrix.", "kind": "function", "name": "kodachrome", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#kodachrome", "scope": "instance", "___id": "T000002R005906", "___s": true }, { "comment": "/**\r\n * Applies a technicolor color effect to this ColorMatrix.\r\n *\r\n * @method Phaser.Display.ColorMatrix#technicolor\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 491, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Applies a technicolor color effect to this ColorMatrix.", "kind": "function", "name": "technicolor", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#technicolor", "scope": "instance", "___id": "T000002R005909", "___s": true }, { "comment": "/**\r\n * Applies a polaroid color effect to this ColorMatrix.\r\n *\r\n * @method Phaser.Display.ColorMatrix#polaroid\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 508, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Applies a polaroid color effect to this ColorMatrix.", "kind": "function", "name": "polaroid", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#polaroid", "scope": "instance", "___id": "T000002R005912", "___s": true }, { "comment": "/**\r\n * Applies an alpha-to-brightness color effect to this ColorMatrix.\r\n * This replaces the color with a grayscale depiction of the original alpha,\r\n * where black represents transparency and white represents opacity,\r\n * and sets the alpha to full.\r\n *\r\n * @method Phaser.Display.ColorMatrix#alphaToBrightness\r\n * @since 4.0.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 525, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Applies an alpha-to-brightness color effect to this ColorMatrix.\rThis replaces the color with a grayscale depiction of the original alpha,\rwhere black represents transparency and white represents opacity,\rand sets the alpha to full.", "kind": "function", "name": "alphaToBrightness", "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#alphaToBrightness", "scope": "instance", "___id": "T000002R005915", "___s": true }, { "comment": "/**\r\n * Applies an alpha-to-brightness color effect to this ColorMatrix.\r\n * This replaces the color with a grayscale depiction of the original alpha,\r\n * where white represents transparency and black represents opacity,\r\n * and sets the alpha to full.\r\n *\r\n * @method Phaser.Display.ColorMatrix#alphaToBrightnessInverse\r\n * @since 4.0.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 545, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Applies an alpha-to-brightness color effect to this ColorMatrix.\rThis replaces the color with a grayscale depiction of the original alpha,\rwhere white represents transparency and black represents opacity,\rand sets the alpha to full.", "kind": "function", "name": "alphaToBrightnessInverse", "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#alphaToBrightnessInverse", "scope": "instance", "___id": "T000002R005918", "___s": true }, { "comment": "/**\r\n * Applies a brightness-to-alpha color effect to this ColorMatrix.\r\n * This preserves RGB, but replaces the alpha with the brightness of the color.\r\n *\r\n * @method Phaser.Display.ColorMatrix#brightnessToAlpha\r\n * @since 4.0.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 565, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Applies a brightness-to-alpha color effect to this ColorMatrix.\rThis preserves RGB, but replaces the alpha with the brightness of the color.", "kind": "function", "name": "brightnessToAlpha", "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#brightnessToAlpha", "scope": "instance", "___id": "T000002R005921", "___s": true }, { "comment": "/**\r\n * Applies a brightness-to-alpha color effect to this ColorMatrix.\r\n * This preserves RGB, but replaces the alpha with the brightness of the color,\r\n * inverted.\r\n *\r\n * @method Phaser.Display.ColorMatrix#brightnessToAlphaInverse\r\n * @since 4.0.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 583, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Applies a brightness-to-alpha color effect to this ColorMatrix.\rThis preserves RGB, but replaces the alpha with the brightness of the color,\rinverted.", "kind": "function", "name": "brightnessToAlphaInverse", "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#brightnessToAlphaInverse", "scope": "instance", "___id": "T000002R005924", "___s": true }, { "comment": "/**\r\n * Shifts the values of this ColorMatrix into BGR order.\r\n *\r\n * @method Phaser.Display.ColorMatrix#shiftToBGR\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 602, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Shifts the values of this ColorMatrix into BGR order.", "kind": "function", "name": "shiftToBGR", "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#shiftToBGR", "scope": "instance", "___id": "T000002R005927", "___s": true }, { "comment": "/**\r\n * Multiplies the given matrix `a` against the current `_matrix`.\r\n *\r\n * @method Phaser.Display.ColorMatrix#multiply\r\n * @since 3.50.0\r\n *\r\n * @param {number[]} a - The 5x4 array to multiply with ColorMatrix._matrix.\r\n * @param {boolean} [multiply=false] - Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?\r\n *\r\n * @return {this} This ColorMatrix instance.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 619, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Multiplies the given matrix `a` against the current `_matrix`.", "kind": "function", "name": "multiply", "since": "3.50.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The 5x4 array to multiply with ColorMatrix._matrix.", "name": "a" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Multiply the resulting ColorMatrix (`true`), or set it (`false`) ?", "name": "multiply" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorMatrix instance." } ], "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix#multiply", "scope": "instance", "___id": "T000002R005930", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for black operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.BLACK\r\n * @const\r\n * @type {number[]}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 685, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for black operations.", "name": "BLACK", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.BLACK", "scope": "static", "___id": "T000002R005936", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for black_white operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.BLACK_WHITE\r\n * @const\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 700, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for black_white operations.", "name": "BLACK_WHITE", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.BLACK_WHITE", "scope": "static", "___id": "T000002R005938", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for negative operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.NEGATIVE\r\n * @const\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 710, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for negative operations.", "name": "NEGATIVE", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.NEGATIVE", "scope": "static", "___id": "T000002R005940", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for desaturated luminance operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.DESATURATE_LUMINANCE\r\n * @const\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 720, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for desaturated luminance operations.", "name": "DESATURATE_LUMINANCE", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.DESATURATE_LUMINANCE", "scope": "static", "___id": "T000002R005942", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for sepia operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.SEPIA\r\n * @const\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 730, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for sepia operations.", "name": "SEPIA", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.SEPIA", "scope": "static", "___id": "T000002R005944", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for lsd operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.LSD\r\n * @const\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 740, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for lsd operations.", "name": "LSD", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.LSD", "scope": "static", "___id": "T000002R005946", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for brown operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.BROWN\r\n * @const\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 750, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for brown operations.", "name": "BROWN", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.BROWN", "scope": "static", "___id": "T000002R005948", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for vintage pinhole operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.VINTAGE\r\n * @const\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 760, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for vintage pinhole operations.", "name": "VINTAGE", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.VINTAGE", "scope": "static", "___id": "T000002R005950", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for kodachrome operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.KODACHROME\r\n * @const\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 770, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for kodachrome operations.", "name": "KODACHROME", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.KODACHROME", "scope": "static", "___id": "T000002R005952", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for technicolor operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.TECHNICOLOR\r\n * @const\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 780, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for technicolor operations.", "name": "TECHNICOLOR", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.TECHNICOLOR", "scope": "static", "___id": "T000002R005954", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for polaroid shift operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.POLAROID\r\n * @const\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 790, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for polaroid shift operations.", "name": "POLAROID", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.POLAROID", "scope": "static", "___id": "T000002R005956", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for alpha-to-brightness operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.ALPHA_TO_BRIGHTNESS\r\n * @const\r\n * @type {number[]}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 800, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for alpha-to-brightness operations.", "name": "ALPHA_TO_BRIGHTNESS", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.ALPHA_TO_BRIGHTNESS", "scope": "static", "___id": "T000002R005958", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for inverse alpha-to-brightness operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.ALPHA_TO_BRIGHTNESS_INVERSE\r\n * @const\r\n * @type {number[]}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 815, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for inverse alpha-to-brightness operations.", "name": "ALPHA_TO_BRIGHTNESS_INVERSE", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.ALPHA_TO_BRIGHTNESS_INVERSE", "scope": "static", "___id": "T000002R005960", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for brightness-to-alpha operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.BRIGHTNESS_TO_ALPHA\r\n * @const\r\n * @type {number[]}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 830, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for brightness-to-alpha operations.", "name": "BRIGHTNESS_TO_ALPHA", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.BRIGHTNESS_TO_ALPHA", "scope": "static", "___id": "T000002R005962", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for inverse brightness-to-alpha operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.BRIGHTNESS_TO_ALPHA_INVERSE\r\n * @const\r\n * @type {number[]}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 845, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for inverse brightness-to-alpha operations.", "name": "BRIGHTNESS_TO_ALPHA_INVERSE", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.BRIGHTNESS_TO_ALPHA_INVERSE", "scope": "static", "___id": "T000002R005964", "___s": true }, { "comment": "/**\r\n * A constant array used by the ColorMatrix class for shift BGR operations.\r\n *\r\n * @name Phaser.Display.ColorMatrix.SHIFT_BGR\r\n * @const\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 860, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "A constant array used by the ColorMatrix class for shift BGR operations.", "name": "SHIFT_BGR", "kind": "constant", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.Display.ColorMatrix", "longname": "Phaser.Display.ColorMatrix.SHIFT_BGR", "scope": "static", "___id": "T000002R005966", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The ColorRamp class represents a series of color transitions.\r\n * It is intended for use in a {@see Phaser.GameObjects.Gradient}.\r\n *\r\n * You should make sure that your bands are arranged end-to-end,\r\n * with no gaps. The Gradient shader assumes this is so.\r\n * You may leave gaps at the start and end.\r\n * Overlaps and gaps may not act as expected.\r\n *\r\n * By default, ColorRamp stores its data for use on the GPU\r\n * in a data texture. This is updated automatically on creation\r\n * and when you run `setBands()`, but if you edit the bands manually,\r\n * you should run `encode()` to rebuild the texture.\r\n * We don't update it automatically because we don't want to waste cycles\r\n * on rebuilds that you're about to overwrite.\r\n *\r\n * @class ColorRamp\r\n * @memberof Phaser.Display\r\n * @since 4.0.0\r\n * @constructor\r\n *\r\n * @param {Phaser.Scene} scene - The current scene.\r\n * @param {Phaser.Types.Display.ColorBandConfig | Phaser.Display.ColorBand | Array} bands - The bands which make up this ramp. This can be one entry or an array, and can be configs or existing instances. A band count over 1048576 may be unsafe.\r\n * @param {boolean} [gpuEncode=true] - Whether to create a data texture to use this ramp in shaders.\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "classdesc": "The ColorRamp class represents a series of color transitions.\rIt is intended for use in a {@see Phaser.GameObjects.Gradient}.\r\rYou should make sure that your bands are arranged end-to-end,\rwith no gaps. The Gradient shader assumes this is so.\rYou may leave gaps at the start and end.\rOverlaps and gaps may not act as expected.\r\rBy default, ColorRamp stores its data for use on the GPU\rin a data texture. This is updated automatically on creation\rand when you run `setBands()`, but if you edit the bands manually,\ryou should run `encode()` to rebuild the texture.\rWe don't update it automatically because we don't want to waste cycles\ron rebuilds that you're about to overwrite.", "kind": "class", "name": "ColorRamp", "memberof": "Phaser.Display", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The current scene.", "name": "scene" }, { "type": { "names": [ "Phaser.Types.Display.ColorBandConfig", "Phaser.Display.ColorBand", "Array.<(Phaser.Types.Display.ColorBandConfig|Phaser.Display.ColorBand)>" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Display.ColorBandConfig" }, { "type": "NameExpression", "name": "Phaser.Display.ColorBand" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Display.ColorBandConfig" }, { "type": "NameExpression", "name": "Phaser.Display.ColorBand" } ] } ] } ] } }, "description": "The bands which make up this ramp. This can be one entry or an array, and can be configs or existing instances. A band count over 1048576 may be unsafe.", "name": "bands" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether to create a data texture to use this ramp in shaders.", "name": "gpuEncode" } ], "scope": "static", "longname": "Phaser.Display.ColorRamp", "___id": "T000002R005975", "___s": true }, { "comment": "/**\r\n * The scene where the ColorRamp was created.\r\n *\r\n * @name Phaser.Display.ColorRamp#scene\r\n * @type {Phaser.Scene}\r\n * @since 4.0.0\r\n * @readonly\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 46, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The scene where the ColorRamp was created.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "4.0.0", "readonly": true, "memberof": "Phaser.Display.ColorRamp", "longname": "Phaser.Display.ColorRamp#scene", "scope": "instance", "kind": "member", "___id": "T000002R005979", "___s": true }, { "comment": "/**\r\n * The color bands that make up this ramp.\r\n *\r\n * @name Phaser.Display.ColorRamp#bands\r\n * @type {Phaser.Display.ColorBand[]}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 56, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The color bands that make up this ramp.", "name": "bands", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Display.ColorBand", "type": "NameExpression" } ] } }, "since": "4.0.0", "memberof": "Phaser.Display.ColorRamp", "longname": "Phaser.Display.ColorRamp#bands", "scope": "instance", "kind": "member", "___id": "T000002R005981", "___s": true }, { "comment": "/**\r\n * Whether to encode the ramp for shaders to use on the GPU.\r\n * An encoded ramp is stored as a texture.\r\n *\r\n * @name Phaser.Display.ColorRamp#gpuEncode\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default true\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Whether to encode the ramp for shaders to use on the GPU.\rAn encoded ramp is stored as a texture.", "name": "gpuEncode", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "true", "memberof": "Phaser.Display.ColorRamp", "longname": "Phaser.Display.ColorRamp#gpuEncode", "scope": "instance", "kind": "member", "___id": "T000002R005983", "___s": true }, { "comment": "/**\r\n * The Phaser Texture wrapping the GPU data texture for this ramp.\r\n * This is registered with the Scene's Texture Manager under a unique key\r\n * so it can be referenced elsewhere. It is not intended for display.\r\n *\r\n * @name Phaser.Display.ColorRamp#dataTexture\r\n * @type {?Phaser.Textures.Texture}\r\n * @since 4.0.0\r\n * @readonly\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The Phaser Texture wrapping the GPU data texture for this ramp.\rThis is registered with the Scene's Texture Manager under a unique key\rso it can be referenced elsewhere. It is not intended for display.", "name": "dataTexture", "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "since": "4.0.0", "readonly": true, "memberof": "Phaser.Display.ColorRamp", "longname": "Phaser.Display.ColorRamp#dataTexture", "scope": "instance", "kind": "member", "___id": "T000002R005985", "___s": true }, { "comment": "/**\r\n * The texture containing the ramp encoded for the GPU.\r\n * This is used internally by effects such as the Gradient game object\r\n * to read complex ramp data.\r\n *\r\n * @name Phaser.Display.ColorRamp#glTexture\r\n * @type {?Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper}\r\n * @since 4.0.0\r\n * @readonly\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The texture containing the ramp encoded for the GPU.\rThis is used internally by effects such as the Gradient game object\rto read complex ramp data.", "name": "glTexture", "type": { "names": [ "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper", "nullable": true } }, "nullable": true, "since": "4.0.0", "readonly": true, "memberof": "Phaser.Display.ColorRamp", "longname": "Phaser.Display.ColorRamp#glTexture", "scope": "instance", "kind": "member", "___id": "T000002R005987", "___s": true }, { "comment": "/**\r\n * The texel index which contains the first band data\r\n * in `glTexture` if it has been encoded.\r\n * This is used internally.\r\n *\r\n * @name Phaser.Display.ColorRamp#dataTextureFirstBand\r\n * @type {number}\r\n * @since 4.0.0\r\n * @readonly\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The texel index which contains the first band data\rin `glTexture` if it has been encoded.\rThis is used internally.", "name": "dataTextureFirstBand", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "readonly": true, "memberof": "Phaser.Display.ColorRamp", "longname": "Phaser.Display.ColorRamp#dataTextureFirstBand", "scope": "instance", "kind": "member", "___id": "T000002R005989", "___s": true }, { "comment": "/**\r\n * The number of levels in the band tree.\r\n * This is used internally to decode the data texture.\r\n *\r\n * @name Phaser.Display.ColorRamp#bandTreeDepth\r\n * @type {number}\r\n * @since 4.0.0\r\n * @readonly\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The number of levels in the band tree.\rThis is used internally to decode the data texture.", "name": "bandTreeDepth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "readonly": true, "memberof": "Phaser.Display.ColorRamp", "longname": "Phaser.Display.ColorRamp#bandTreeDepth", "scope": "instance", "kind": "member", "___id": "T000002R005991", "___s": true }, { "comment": "/**\r\n * The resolution of the data texture, if it has been encoded.\r\n * This is used internally.\r\n *\r\n * @name Phaser.Display.ColorRamp#dataTextureResolution\r\n * @type {number[]}\r\n * @since 4.0.0\r\n * @readonly\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The resolution of the data texture, if it has been encoded.\rThis is used internally.", "name": "dataTextureResolution", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "readonly": true, "memberof": "Phaser.Display.ColorRamp", "longname": "Phaser.Display.ColorRamp#dataTextureResolution", "scope": "instance", "kind": "member", "___id": "T000002R005993", "___s": true }, { "comment": "/**\r\n * Set or replace the color bands in this ramp.\r\n * Use this after creation to update the bands.\r\n *\r\n * This will re-encode the data texture if `gpuEncode` is set\r\n * and `encode` is not `false`.\r\n *\r\n * @method Phaser.Display.ColorRamp#setBands\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.Display.ColorBandConfig | Phaser.Display.ColorBand | Array} bands - The bands to make up this ramp. This can be one entry or an array, and can be configs or existing instances.\r\n * @param {boolean} [encode=true] - Whether to encode the new ramp data to a data texture for use in shaders.\r\n *\r\n * @return {this} - This ColorRamp instance.\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Set or replace the color bands in this ramp.\rUse this after creation to update the bands.\r\rThis will re-encode the data texture if `gpuEncode` is set\rand `encode` is not `false`.", "kind": "function", "name": "setBands", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Display.ColorBandConfig", "Phaser.Display.ColorBand", "Array.<(Phaser.Types.Display.ColorBandConfig|Phaser.Display.ColorBand)>" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Display.ColorBandConfig" }, { "type": "NameExpression", "name": "Phaser.Display.ColorBand" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Display.ColorBandConfig" }, { "type": "NameExpression", "name": "Phaser.Display.ColorBand" } ] } ] } ] } }, "description": "The bands to make up this ramp. This can be one entry or an array, and can be configs or existing instances.", "name": "bands" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether to encode the new ramp data to a data texture for use in shaders.", "name": "encode" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "- This ColorRamp instance." } ], "memberof": "Phaser.Display.ColorRamp", "longname": "Phaser.Display.ColorRamp#setBands", "scope": "instance", "___id": "T000002R005995", "___s": true }, { "comment": "/**\r\n * Encode a data texture from the color ramp bands.\r\n *\r\n * This process runs automatically when `gpuEncode` is enabled\r\n * and the bands are set or updated with `setBands`.\r\n * If you modify the bands directly, you must call `encode` yourself.\r\n *\r\n * The data is encoded in texels as follows:\r\n *\r\n * Numbers are encoded in \"RG.BA\" form.\r\n * The number equals R * 255 + G + B / 255 + A / 255 / 255.\r\n *\r\n * - First 2 texels: start and end.\r\n * - Start is the start of the first band.\r\n * - End is the end of the last band.\r\n * - Next block of texels: binary symmetrical tree of band ranges,\r\n * represented as the end value of the midpoint band.\r\n * - Final block of texels, starting at `dataTextureFirstBand`:\r\n * the band data, in blocks of 3:\r\n * - colorStart\r\n * - colorEnd\r\n * - colorSpace * 255 + interpolation + (middle / 2)\r\n *\r\n * The binary symmetrical tree breaks the bands list in half\r\n * with every node. It is intended to quickly find the band corresponding\r\n * to a given progress along the ramp.\r\n * For example, a ramp with 10 bands would store the ends in this order:\r\n *\r\n * `[ 7, 3, 11, 1, 5, 9, 13, 0, 2, 4, 6, 8, 10, 12, 14 ]`\r\n *\r\n * But because it doesn't have bands from index 10 and up, it's actually:\r\n *\r\n * `[ 7, 3, 9, 1, 5, 9, 9, 0, 2, 4, 6, 8, 9, 9, 9 ]`\r\n *\r\n * Note that, if you change the number of bands in the ramp,\r\n * `dataTexture` may no longer have the correct resolution.\r\n * It is not intended for display.\r\n *\r\n * @method Phaser.Display.ColorRamp#encode\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Encode a data texture from the color ramp bands.\r\rThis process runs automatically when `gpuEncode` is enabled\rand the bands are set or updated with `setBands`.\rIf you modify the bands directly, you must call `encode` yourself.\r\rThe data is encoded in texels as follows:\r\rNumbers are encoded in \"RG.BA\" form.\rThe number equals R * 255 + G + B / 255 + A / 255 / 255.\r\r- First 2 texels: start and end.\r - Start is the start of the first band.\r - End is the end of the last band.\r- Next block of texels: binary symmetrical tree of band ranges,\r represented as the end value of the midpoint band.\r- Final block of texels, starting at `dataTextureFirstBand`:\r the band data, in blocks of 3:\r - colorStart\r - colorEnd\r - colorSpace * 255 + interpolation + (middle / 2)\r\rThe binary symmetrical tree breaks the bands list in half\rwith every node. It is intended to quickly find the band corresponding\rto a given progress along the ramp.\rFor example, a ramp with 10 bands would store the ends in this order:\r\r`[ 7, 3, 11, 1, 5, 9, 13, 0, 2, 4, 6, 8, 10, 12, 14 ]`\r\rBut because it doesn't have bands from index 10 and up, it's actually:\r\r`[ 7, 3, 9, 1, 5, 9, 9, 0, 2, 4, 6, 8, 9, 9, 9 ]`\r\rNote that, if you change the number of bands in the ramp,\r`dataTexture` may no longer have the correct resolution.\rIt is not intended for display.", "kind": "function", "name": "encode", "since": "4.0.0", "memberof": "Phaser.Display.ColorRamp", "longname": "Phaser.Display.ColorRamp#encode", "scope": "instance", "___id": "T000002R006007", "___s": true }, { "comment": "/**\r\n * Fix the fit of bands within this ColorRamp.\r\n *\r\n * This sets the start of each band to the end of the previous band,\r\n * ensuring that there are no gaps.\r\n *\r\n * Optionally, you can define start and end values to stretch the ramp\r\n * to some specific range, e.g. 0-1.\r\n *\r\n * By default, any band that is now 0 length will be removed.\r\n *\r\n * @method Phaser.Display.ColorRamp#fixFit\r\n * @since 4.0.0\r\n * @param {number} start - Override the start of the first band.\r\n * @param {number} end - Override the end of the last band.\r\n * @param {boolean} purgeZeroLength - Whether to discard bands that now have 0 size.\r\n * @param {boolean} encode - Whether to reencode the data texture.\r\n * @return {this} - This ColorRamp instance.\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 324, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Fix the fit of bands within this ColorRamp.\r\rThis sets the start of each band to the end of the previous band,\rensuring that there are no gaps.\r\rOptionally, you can define start and end values to stretch the ramp\rto some specific range, e.g. 0-1.\r\rBy default, any band that is now 0 length will be removed.", "kind": "function", "name": "fixFit", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Override the start of the first band.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Override the end of the last band.", "name": "end" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to discard bands that now have 0 size.", "name": "purgeZeroLength" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to reencode the data texture.", "name": "encode" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "- This ColorRamp instance." } ], "memberof": "Phaser.Display.ColorRamp", "longname": "Phaser.Display.ColorRamp#fixFit", "scope": "instance", "___id": "T000002R006054", "___s": true }, { "comment": "/**\r\n * Split a band from this ramp into several bands, and insert them into the ramp.\r\n *\r\n * You can choose whether to \"quantize\" the bands, where each of them has\r\n * a flat color.\r\n *\r\n * @method Phaser.Display.ColorRamp#splitBand\r\n * @since 4.0.0\r\n * @param {number | Phaser.Display.ColorBand} band - The band to split, either an index on this ramp or the band instance. The band must be on this ramp.\r\n * @param {number} steps - The number of bands to create.\r\n * @param {boolean} [quantize=false] - Whether to quantize the bands to a single color.\r\n * @param {boolean} [encode=true] - Whether to rebuild the data texture.\r\n * @return {this} This ColorRamp instance.\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Split a band from this ramp into several bands, and insert them into the ramp.\r\rYou can choose whether to \"quantize\" the bands, where each of them has\ra flat color.", "kind": "function", "name": "splitBand", "since": "4.0.0", "params": [ { "type": { "names": [ "number", "Phaser.Display.ColorBand" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Display.ColorBand" } ] } }, "description": "The band to split, either an index on this ramp or the band instance. The band must be on this ramp.", "name": "band" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of bands to create.", "name": "steps" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to quantize the bands to a single color.", "name": "quantize" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether to rebuild the data texture.", "name": "encode" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ColorRamp instance." } ], "memberof": "Phaser.Display.ColorRamp", "longname": "Phaser.Display.ColorRamp#splitBand", "scope": "instance", "___id": "T000002R006067", "___s": true }, { "comment": "/**\r\n * Get the color value at the given index within this ramp.\r\n *\r\n * If there is no band at that location, the color is transparent.\r\n *\r\n * @method Phaser.Display.ColorRamp#getColor\r\n * @param {number} index - Index of the color to get, from 0 (start) to 1 (end).\r\n * @return {Phaser.Types.Display.ColorObject} The color at that index.\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 462, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Get the color value at the given index within this ramp.\r\rIf there is no band at that location, the color is transparent.", "kind": "function", "name": "getColor", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Index of the color to get, from 0 (start) to 1 (end).", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Display.ColorObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Display.ColorObject" } }, "description": "The color at that index." } ], "memberof": "Phaser.Display.ColorRamp", "longname": "Phaser.Display.ColorRamp#getColor", "scope": "instance", "___id": "T000002R006091", "___s": true }, { "comment": "/**\r\n * Destroy this ColorRamp.\r\n * If it has a data texture, destroy it.\r\n *\r\n * @method Phaser.Display.ColorRamp#destroy\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorRamp.js", "lineno": 497, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Destroy this ColorRamp.\rIf it has a data texture, destroy it.", "kind": "function", "name": "destroy", "since": "4.0.0", "memberof": "Phaser.Display.ColorRamp", "longname": "Phaser.Display.ColorRamp#destroy", "scope": "instance", "___id": "T000002R006103", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Display\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "kind": "namespace", "name": "Display", "memberof": "Phaser", "longname": "Phaser.Display", "scope": "static", "___id": "T000002R006107", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Geometry Mask can be applied to a Game Object to hide any pixels of it which don't intersect\r\n * a visible pixel from the geometry mask. The mask is essentially a clipping path which can only\r\n * make a masked pixel fully visible or fully invisible without changing its alpha (opacity).\r\n *\r\n * A Geometry Mask uses a Graphics Game Object to determine which pixels of the masked Game Object(s)\r\n * should be clipped. For any given point of a masked Game Object's texture, the pixel will only be displayed\r\n * if the Graphics Game Object of the Geometry Mask has a visible pixel at the same position. The color and\r\n * alpha of the pixel from the Geometry Mask do not matter.\r\n *\r\n * The Geometry Mask's location matches the location of its Graphics object, not the location of the masked objects.\r\n * Moving or transforming the underlying Graphics object will change the mask (and affect the visibility\r\n * of any masked objects), whereas moving or transforming a masked object will not affect the mask.\r\n * You can think of the Geometry Mask (or rather, of its Graphics object) as an invisible curtain placed\r\n * in front of all masked objects which has its own visual properties and, naturally, respects the camera's\r\n * visual properties, but isn't affected by and doesn't follow the masked objects by itself.\r\n *\r\n * GeometryMask is only supported in the Canvas Renderer.\r\n * If you want to use geometry to mask objects in WebGL,\r\n * see {@link Phaser.GameObjects.Components.FilterList#addMask}.\r\n *\r\n * @class GeometryMask\r\n * @memberof Phaser.Display.Masks\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - This parameter is not used.\r\n * @param {Phaser.GameObjects.Graphics} graphicsGeometry - The Graphics Game Object to use for the Geometry Mask. Doesn't have to be in the Display List.\r\n */", "meta": { "filename": "GeometryMask.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "classdesc": "A Geometry Mask can be applied to a Game Object to hide any pixels of it which don't intersect\ra visible pixel from the geometry mask. The mask is essentially a clipping path which can only\rmake a masked pixel fully visible or fully invisible without changing its alpha (opacity).\r\rA Geometry Mask uses a Graphics Game Object to determine which pixels of the masked Game Object(s)\rshould be clipped. For any given point of a masked Game Object's texture, the pixel will only be displayed\rif the Graphics Game Object of the Geometry Mask has a visible pixel at the same position. The color and\ralpha of the pixel from the Geometry Mask do not matter.\r\rThe Geometry Mask's location matches the location of its Graphics object, not the location of the masked objects.\rMoving or transforming the underlying Graphics object will change the mask (and affect the visibility\rof any masked objects), whereas moving or transforming a masked object will not affect the mask.\rYou can think of the Geometry Mask (or rather, of its Graphics object) as an invisible curtain placed\rin front of all masked objects which has its own visual properties and, naturally, respects the camera's\rvisual properties, but isn't affected by and doesn't follow the masked objects by itself.\r\rGeometryMask is only supported in the Canvas Renderer.\rIf you want to use geometry to mask objects in WebGL,\rsee {@link Phaser.GameObjects.Components.FilterList#addMask}.", "kind": "class", "name": "GeometryMask", "memberof": "Phaser.Display.Masks", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "This parameter is not used.", "name": "scene" }, { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R006120", "___s": true }, { "comment": "/**\r\n * The Graphics object which describes the Geometry Mask.\r\n *\r\n * @name Phaser.Display.Masks.GeometryMask#geometryMask\r\n * @type {Phaser.GameObjects.Graphics}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GeometryMask.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "The Graphics object which describes the Geometry Mask.", "name": "geometryMask", "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "since": "3.0.0", "memberof": "Phaser.Display.Masks.GeometryMask", "longname": "Phaser.Display.Masks.GeometryMask#geometryMask", "scope": "instance", "kind": "member", "___id": "T000002R006123", "___s": true }, { "comment": "/**\r\n * Sets a new Graphics object for the Geometry Mask.\r\n *\r\n * @method Phaser.Display.Masks.GeometryMask#setShape\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Graphics} graphicsGeometry - The Graphics object which will be used for the Geometry Mask.\r\n *\r\n * @return {this} This Geometry Mask\r\n */", "meta": { "filename": "GeometryMask.js", "lineno": 55, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Sets a new Graphics object for the Geometry Mask.", "kind": "function", "name": "setShape", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Graphics object which will be used for the Geometry Mask.", "name": "graphicsGeometry" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Geometry Mask" } ], "memberof": "Phaser.Display.Masks.GeometryMask", "longname": "Phaser.Display.Masks.GeometryMask#setShape", "scope": "instance", "___id": "T000002R006125", "___s": true }, { "comment": "/**\r\n * Sets the clipping path of a 2D canvas context to the Geometry Mask's underlying Graphics object.\r\n *\r\n * @method Phaser.Display.Masks.GeometryMask#preRenderCanvas\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.Canvas.CanvasRenderer} renderer - The Canvas Renderer instance to set the clipping path on.\r\n * @param {Phaser.GameObjects.GameObject} mask - The Game Object being rendered.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera the Game Object is being rendered through.\r\n */", "meta": { "filename": "GeometryMask.js", "lineno": 72, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.Canvas.CanvasRenderer" } }, "description": "The Canvas Renderer instance to set the clipping path on.", "name": "renderer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered.", "name": "mask" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R006128", "___s": true }, { "comment": "/**\r\n * Restores the canvas context's previous clipping path, thus turning off the mask for it.\r\n *\r\n * @method Phaser.Display.Masks.GeometryMask#postRenderCanvas\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Renderer.Canvas.CanvasRenderer} renderer - The Canvas Renderer instance being restored.\r\n */", "meta": { "filename": "GeometryMask.js", "lineno": 93, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Restores 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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R006131", "___s": true }, { "comment": "/**\r\n * Destroys this GeometryMask and nulls any references it holds.\r\n *\r\n * Note that if a Game Object is currently using this mask it will _not_ automatically detect you have destroyed it,\r\n * so be sure to call `clearMask` on any Game Object using it, before destroying it.\r\n *\r\n * @method Phaser.Display.Masks.GeometryMask#destroy\r\n * @since 3.7.0\r\n */", "meta": { "filename": "GeometryMask.js", "lineno": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "description": "Destroys this GeometryMask and nulls any references it holds.\r\rNote that if a Game Object is currently using this mask it will _not_ automatically detect you have destroyed it,\rso 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", "___id": "T000002R006133", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Display.Masks\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\mask", "code": {} }, "kind": "namespace", "name": "Masks", "memberof": "Phaser.Display", "longname": "Phaser.Display.Masks", "scope": "static", "___id": "T000002R006137", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The RGB class holds a single color value expressed as normalized red, green, and blue\r\n * components, each in the range 0 to 1. It is used internally by WebGL pipelines and other\r\n * Phaser systems that need to track color state efficiently. Changes to any component\r\n * automatically set the `dirty` flag and invoke an optional `onChangeCallback`, making it\r\n * straightforward to react to color mutations without manual polling.\r\n *\r\n * @class RGB\r\n * @memberof Phaser.Display\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @param {number} [red=0] - The red color value. A number between 0 and 1.\r\n * @param {number} [green=0] - The green color value. A number between 0 and 1.\r\n * @param {number} [blue=0] - The blue color value. A number between 0 and 1.\r\n */", "meta": { "filename": "RGB.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "classdesc": "The RGB class holds a single color value expressed as normalized red, green, and blue\rcomponents, each in the range 0 to 1. It is used internally by WebGL pipelines and other\rPhaser systems that need to track color state efficiently. Changes to any component\rautomatically set the `dirty` flag and invoke an optional `onChangeCallback`, making it\rstraightforward to react to color mutations without manual polling.", "kind": "class", "name": "RGB", "memberof": "Phaser.Display", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The red color value. A number between 0 and 1.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The green color value. A number between 0 and 1.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The blue color value. A number between 0 and 1.", "name": "blue" } ], "scope": "static", "longname": "Phaser.Display.RGB", "___id": "T000002R006142", "___s": true }, { "comment": "/**\r\n * This callback will be invoked each time one of the RGB color values change.\r\n *\r\n * The callback receives the red, green, and blue values as three separate numeric\r\n * arguments, each in the range 0 to 1.\r\n *\r\n * @name Phaser.Display.RGB#onChangeCallback\r\n * @type {function}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RGB.js", "lineno": 43, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "This callback will be invoked each time one of the RGB color values change.\r\rThe callback receives the red, green, and blue values as three separate numeric\rarguments, each in the range 0 to 1.", "name": "onChangeCallback", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.50.0", "memberof": "Phaser.Display.RGB", "longname": "Phaser.Display.RGB#onChangeCallback", "scope": "instance", "kind": "member", "___id": "T000002R006147", "___s": true }, { "comment": "/**\r\n * Is this color dirty?\r\n *\r\n * @name Phaser.Display.RGB#dirty\r\n * @type {boolean}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RGB.js", "lineno": 55, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Is this color dirty?", "name": "dirty", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.50.0", "memberof": "Phaser.Display.RGB", "longname": "Phaser.Display.RGB#dirty", "scope": "instance", "kind": "member", "___id": "T000002R006149", "___s": true }, { "comment": "/**\r\n * Sets the red, green and blue values of this RGB object, flags it as being\r\n * dirty and then invokes the `onChangeCallback`, if set.\r\n *\r\n * @method Phaser.Display.RGB#set\r\n * @since 3.50.0\r\n *\r\n * @param {number} [red=0] - The red color value. A number between 0 and 1.\r\n * @param {number} [green=0] - The green color value. A number between 0 and 1.\r\n * @param {number} [blue=0] - The blue color value. A number between 0 and 1.\r\n *\r\n * @return {this} This RGB instance.\r\n */", "meta": { "filename": "RGB.js", "lineno": 67, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Sets the red, green and blue values of this RGB object, flags it as being\rdirty and then invokes the `onChangeCallback`, if set.", "kind": "function", "name": "set", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The red color value. A number between 0 and 1.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The green color value. A number between 0 and 1.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The blue color value. A number between 0 and 1.", "name": "blue" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This RGB instance." } ], "memberof": "Phaser.Display.RGB", "longname": "Phaser.Display.RGB#set", "scope": "instance", "___id": "T000002R006151", "___s": true }, { "comment": "/**\r\n * Compares the given rgb parameters with those in this object and returns\r\n * a boolean `true` value if they are equal, otherwise it returns `false`.\r\n *\r\n * @method Phaser.Display.RGB#equals\r\n * @since 3.50.0\r\n *\r\n * @param {number} red - The red value to compare with this object.\r\n * @param {number} green - The green value to compare with this object.\r\n * @param {number} blue - The blue value to compare with this object.\r\n *\r\n * @return {boolean} `true` if the given values match those in this object, otherwise `false`.\r\n */", "meta": { "filename": "RGB.js", "lineno": 93, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Compares the given rgb parameters with those in this object and returns\ra boolean `true` value if they are equal, otherwise it returns `false`.", "kind": "function", "name": "equals", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The red value to compare with this object.", "name": "red" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The green value to compare with this object.", "name": "green" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blue value to compare with this object.", "name": "blue" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the given values match those in this object, otherwise `false`." } ], "memberof": "Phaser.Display.RGB", "longname": "Phaser.Display.RGB#equals", "scope": "instance", "___id": "T000002R006157", "___s": true }, { "comment": "/**\r\n * Internal on change handler. Sets this object as being dirty and\r\n * then invokes the `onChangeCallback`, if set, passing in the\r\n * new RGB values.\r\n *\r\n * @method Phaser.Display.RGB#onChange\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RGB.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Internal on change handler. Sets this object as being dirty and\rthen invokes the `onChangeCallback`, if set, passing in the\rnew RGB values.", "kind": "function", "name": "onChange", "since": "3.50.0", "memberof": "Phaser.Display.RGB", "longname": "Phaser.Display.RGB#onChange", "scope": "instance", "___id": "T000002R006160", "___s": true }, { "comment": "/**\r\n * The red color value. Between 0 and 1.\r\n *\r\n * Changing this property will flag this RGB object as being dirty\r\n * and invoke the `onChangeCallback`, if set.\r\n *\r\n * @name Phaser.Display.RGB#r\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RGB.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The red color value. Between 0 and 1.\r\rChanging this property will flag this RGB object as being dirty\rand invoke the `onChangeCallback`, if set.", "name": "r", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Display.RGB", "longname": "Phaser.Display.RGB#r", "scope": "instance", "kind": "member", "___id": "T000002R006164", "___s": true }, { "comment": "/**\r\n * The green color value. Between 0 and 1.\r\n *\r\n * Changing this property will flag this RGB object as being dirty\r\n * and invoke the `onChangeCallback`, if set.\r\n *\r\n * @name Phaser.Display.RGB#g\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RGB.js", "lineno": 155, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The green color value. Between 0 and 1.\r\rChanging this property will flag this RGB object as being dirty\rand invoke the `onChangeCallback`, if set.", "name": "g", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Display.RGB", "longname": "Phaser.Display.RGB#g", "scope": "instance", "kind": "member", "___id": "T000002R006169", "___s": true }, { "comment": "/**\r\n * The blue color value. Between 0 and 1.\r\n *\r\n * Changing this property will flag this RGB object as being dirty\r\n * and invoke the `onChangeCallback`, if set.\r\n *\r\n * @name Phaser.Display.RGB#b\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RGB.js", "lineno": 180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "The blue color value. Between 0 and 1.\r\rChanging this property will flag this RGB object as being dirty\rand invoke the `onChangeCallback`, if set.", "name": "b", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.Display.RGB", "longname": "Phaser.Display.RGB#b", "scope": "instance", "kind": "member", "___id": "T000002R006174", "___s": true }, { "comment": "/**\r\n * Destroys this RGB instance by nulling the `onChangeCallback` reference,\r\n * releasing any external listener held by this object.\r\n *\r\n * @method Phaser.Display.RGB#destroy\r\n * @since 3.50.0\r\n */", "meta": { "filename": "RGB.js", "lineno": 205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\display", "code": {} }, "description": "Destroys this RGB instance by nulling the `onChangeCallback` reference,\rreleasing any external listener held by this object.", "kind": "function", "name": "destroy", "since": "3.50.0", "memberof": "Phaser.Display.RGB", "longname": "Phaser.Display.RGB#destroy", "scope": "instance", "___id": "T000002R006179", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A BaseShader is a small resource class that contains GLSL code for a shader.\r\n *\r\n * It contains the key of the shader, the source code, and optional metadata.\r\n * Phaser does not enforce a specific shader type: the source could be a\r\n * fragment shader, a vertex shader, or even an incomplete snippet of GLSL.\r\n * It is stored as raw source code and may be retrieved and compiled as you wish.\r\n * These keys can be used by `Phaser.GameObjects.Shader` and\r\n * `Phaser.Renderer.WebGL.RenderNodes.BaseFilterShader`.\r\n *\r\n * BaseShaders are stored in the Shader Cache, available in a Scene via `this.cache.shaders` and are referenced\r\n * by a unique key-based string. Retrieve them via `this.cache.shaders.get(key)`.\r\n *\r\n * BaseShaders are created automatically by the GLSL File Loader when loading an external shader resource.\r\n * They can also be created at runtime, allowing you to use dynamically generated shader source code.\r\n *\r\n * @class BaseShader\r\n * @memberof Phaser.Display\r\n * @constructor\r\n * @since 4.0.0\r\n *\r\n * @param {string} key - The key of this shader. Must be unique within the shader cache.\r\n * @param {string} glsl - The GLSL source code for the shader.\r\n * @param {object} [metadata] - Additional metadata for this shader code.\r\n */", "meta": { "filename": "BaseShader.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\shader", "code": {} }, "classdesc": "A BaseShader is a small resource class that contains GLSL code for a shader.\r\rIt contains the key of the shader, the source code, and optional metadata.\rPhaser does not enforce a specific shader type: the source could be a\rfragment shader, a vertex shader, or even an incomplete snippet of GLSL.\rIt is stored as raw source code and may be retrieved and compiled as you wish.\rThese keys can be used by `Phaser.GameObjects.Shader` and\r`Phaser.Renderer.WebGL.RenderNodes.BaseFilterShader`.\r\rBaseShaders are stored in the Shader Cache, available in a Scene via `this.cache.shaders` and are referenced\rby a unique key-based string. Retrieve them via `this.cache.shaders.get(key)`.\r\rBaseShaders are created automatically by the GLSL File Loader when loading an external shader resource.\rThey can also be created at runtime, allowing you to use dynamically generated shader source code.", "kind": "class", "name": "BaseShader", "memberof": "Phaser.Display", "since": "4.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of this shader. Must be unique within the shader cache.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The GLSL source code for the shader.", "name": "glsl" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Additional metadata for this shader code.", "name": "metadata" } ], "scope": "static", "longname": "Phaser.Display.BaseShader", "___id": "T000002R006184", "___s": true }, { "comment": "/**\r\n * The key of this shader code,\r\n * unique within the shader cache of this Phaser game instance.\r\n *\r\n * @name Phaser.Display.BaseShader#key\r\n * @type {string}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "BaseShader.js", "lineno": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\shader", "code": {} }, "description": "The key of this shader code,\runique within the shader cache of this Phaser game instance.", "name": "key", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.17.0", "memberof": "Phaser.Display.BaseShader", "longname": "Phaser.Display.BaseShader#key", "scope": "instance", "kind": "member", "___id": "T000002R006188", "___s": true }, { "comment": "/**\r\n * GLSL source code for a shader.\r\n * The use of this code is not specified by Phaser.\r\n * You can add metadata to further describe its purpose.\r\n *\r\n * @name Phaser.Display.BaseShader#glsl\r\n * @type {string}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "BaseShader.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\shader", "code": {} }, "description": "GLSL source code for a shader.\rThe use of this code is not specified by Phaser.\rYou can add metadata to further describe its purpose.", "name": "glsl", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "4.0.0", "memberof": "Phaser.Display.BaseShader", "longname": "Phaser.Display.BaseShader#glsl", "scope": "instance", "kind": "member", "___id": "T000002R006190", "___s": true }, { "comment": "/**\r\n * Additional metadata for this shader. This is not used by Phaser,\r\n * but it may be used by your game code or external tools.\r\n * For example, you could add properties that describe\r\n * the shader's purpose, author, version, etc.\r\n *\r\n * @name Phaser.Display.BaseShader#metadata\r\n * @type {object}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "BaseShader.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\display\\shader", "code": {} }, "description": "Additional metadata for this shader. This is not used by Phaser,\rbut it may be used by your game code or external tools.\rFor example, you could add properties that describe\rthe shader's purpose, author, version, etc.", "name": "metadata", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "memberof": "Phaser.Display.BaseShader", "longname": "Phaser.Display.BaseShader#metadata", "scope": "instance", "kind": "member", "___id": "T000002R006192", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Display.ColorBandConfig\r\n * @since 4.0.0\r\n *\r\n * @property {number | string | number[] | Phaser.Display.Color} [colorStart=0x000000] - The color at the start of the band. Specify a color integer, hex string, array of RGB or RGBA in range 0-1, or a color.\r\n * @property {number | string | number[] | Phaser.Display.Color} [colorEnd] - The color at the end of the band. Defaults to `colorStart`.\r\n * @property {number} [start=0] - The start point of this band within a ColorRamp. This value should be normalized within the ramp, between 0 (ramp start) and 1 (ramp end).\r\n * @property {number} [middle=0.5] - The middle point of this band within a ColorRamp. This value should be normalized within the band, between 0 (band start) and 1 (band end). Middle point alters the shape of the color interpolation.\r\n * @property {number} [end=1] - The end point of this band within a ColorRamp. This value should be normalized within the ramp, between 0 (ramp start) and 1 (ramp end).\r\n * @property {number} [size] - The size of this band within a ColorRamp. This value should be normalized within the ramp, between 0 (ramp start) and 1 (ramp end). This is used if `end` is not specified. If being used to construct a ColorRamp, it can also set the `start` of the next band.\r\n * @property {number} [interpolation=0] - The color interpolation.\r\n * This can be one of the following codes:\r\n *\r\n * - 0: LINEAR - a straight blend.\r\n * - 1: CURVED - color changes quickly at start and end,\r\n * flattening in the middle. Good for convex surfaces.\r\n * - 2: SINUSOIDAL - color changes quickly in the middle,\r\n * flattening at start and end. Good for smooth transitions.\r\n * - 3: CURVE_START - color changes quickly at the start,\r\n * flattening at the end.\r\n * - 4: CURVE_END - color changes quickly at the end,\r\n * flattening at the start.\r\n *\r\n * Under the hood, these are similar to the circular easing function.\r\n * @property {number} [colorSpace=0] - The color space where interpolation should be done.\r\n * This can be one of the following codes:\r\n *\r\n * - 0: RGBA - channels are blended directly.\r\n * This can be inaccurate.\r\n * - 1: HSVA_NEAREST - colors are blended in HSVA space,\r\n * better preserving saturation and lightness.\r\n * The hue is blended with the shortest angle, e.g. red and blue\r\n * blend via purple, not green.\r\n * - 2: HSVA_PLUS - as HSVA_NEAREST, but hue angle always increases.\r\n * - 3: HSVA_MINUS - as HSVA_NEAREST, but hue angle always decreases.\r\n */", "meta": { "filename": "ColorBandConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\typedefs", "code": {} }, "kind": "typedef", "name": "ColorBandConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color at the start of the band. Specify a color integer, hex string, array of RGB or RGBA in range 0-1, or a color.", "name": "colorStart" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "description": "The color at the end of the band. Defaults to `colorStart`.", "name": "colorEnd" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The start point of this band within a ColorRamp. This value should be normalized within the ramp, between 0 (ramp start) and 1 (ramp end).", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The middle point of this band within a ColorRamp. This value should be normalized within the band, between 0 (band start) and 1 (band end). Middle point alters the shape of the color interpolation.", "name": "middle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The end point of this band within a ColorRamp. This value should be normalized within the ramp, between 0 (ramp start) and 1 (ramp end).", "name": "end" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The size of this band within a ColorRamp. This value should be normalized within the ramp, between 0 (ramp start) and 1 (ramp end). This is used if `end` is not specified. If being used to construct a ColorRamp, it can also set the `start` of the next band.", "name": "size" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The color interpolation.\rThis can be one of the following codes:\r\r- 0: LINEAR - a straight blend.\r- 1: CURVED - color changes quickly at start and end,\r flattening in the middle. Good for convex surfaces.\r- 2: SINUSOIDAL - color changes quickly in the middle,\r flattening at start and end. Good for smooth transitions.\r- 3: CURVE_START - color changes quickly at the start,\r flattening at the end.\r- 4: CURVE_END - color changes quickly at the end,\r flattening at the start.\r\rUnder the hood, these are similar to the circular easing function.", "name": "interpolation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The color space where interpolation should be done.\rThis can be one of the following codes:\r\r- 0: RGBA - channels are blended directly.\r This can be inaccurate.\r- 1: HSVA_NEAREST - colors are blended in HSVA space,\r better preserving saturation and lightness.\r The hue is blended with the shortest angle, e.g. red and blue\r blend via purple, not green.\r- 2: HSVA_PLUS - as HSVA_NEAREST, but hue angle always increases.\r- 3: HSVA_MINUS - as HSVA_NEAREST, but hue angle always decreases.", "name": "colorSpace" } ], "memberof": "Phaser.Types.Display", "longname": "Phaser.Types.Display.ColorBandConfig", "scope": "static", "___id": "T000002R006195", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Display.ColorObject\r\n * @since 3.0.0\r\n *\r\n * @property {number} r - The red color value in the range 0 to 255.\r\n * @property {number} g - The green color value in the range 0 to 255.\r\n * @property {number} b - The blue color value in the range 0 to 255.\r\n * @property {number} a - The alpha color value in the range 0 to 255.\r\n * @property {number} color - The combined color value.\r\n */", "meta": { "filename": "ColorObject.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\typedefs", "code": {} }, "kind": "typedef", "name": "ColorObject", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The red color value in the range 0 to 255.", "name": "r" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The green color value in the range 0 to 255.", "name": "g" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blue color value in the range 0 to 255.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha color value in the range 0 to 255.", "name": "a" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The combined color value.", "name": "color" } ], "memberof": "Phaser.Types.Display", "longname": "Phaser.Types.Display.ColorObject", "scope": "static", "___id": "T000002R006196", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Display.HSVColorObject\r\n * @since 3.0.0\r\n *\r\n * @property {number} h - The hue color value. A number between 0 and 1\r\n * @property {number} s - The saturation color value. A number between 0 and 1\r\n * @property {number} v - The lightness color value. A number between 0 and 1\r\n */", "meta": { "filename": "HSVColorObject.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\typedefs", "code": {} }, "kind": "typedef", "name": "HSVColorObject", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The hue color value. A number between 0 and 1", "name": "h" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The saturation color value. A number between 0 and 1", "name": "s" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R006197", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Display\r\n */", "meta": { "filename": "index.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\typedefs", "code": {} }, "kind": "namespace", "name": "Display", "memberof": "Phaser.Types", "longname": "Phaser.Types.Display", "scope": "static", "___id": "T000002R006198", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Display.InputColorObject\r\n * @since 3.0.0\r\n *\r\n * @property {number} [r] - The red color value in the range 0 to 255.\r\n * @property {number} [g] - The green color value in the range 0 to 255.\r\n * @property {number} [b] - The blue color value in the range 0 to 255.\r\n * @property {number} [a] - The alpha color value in the range 0 to 255.\r\n */", "meta": { "filename": "InputColorObject.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\display\\typedefs", "code": {} }, "kind": "typedef", "name": "InputColorObject", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The red color value in the range 0 to 255.", "name": "r" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The green color value in the range 0 to 255.", "name": "g" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The blue color value in the range 0 to 255.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R006199", "___s": true }, { "comment": "/**\r\n * Adds the given element to the DOM. If a parent is provided, the element is added as a child of the parent element, resolved either by\r\n * passing a string ID to `getElementById` or by using the HTMLElement directly. If no parent is given and the element already has an\r\n * existing `parentElement`, or if `parent` is explicitly `null`, the element is returned immediately without modification. If no valid\r\n * target parent can be resolved, the element is appended to `document.body` as a fallback.\r\n *\r\n * @function Phaser.DOM.AddToDOM\r\n * @since 3.0.0\r\n *\r\n * @param {HTMLElement} element - The element to be added to the DOM. Usually a Canvas object.\r\n * @param {(string|HTMLElement)} [parent] - The parent in which to add the element. Can be a string which is passed to `getElementById` or an actual DOM object.\r\n *\r\n * @return {HTMLElement} The element that was passed to this function.\r\n */", "meta": { "filename": "AddToDOM.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "Adds the given element to the DOM. If a parent is provided, the element is added as a child of the parent element, resolved either by\rpassing a string ID to `getElementById` or by using the HTMLElement directly. If no parent is given and the element already has an\rexisting `parentElement`, or if `parent` is explicitly `null`, the element is returned immediately without modification. If no valid\rtarget parent can be resolved, the element is appended to `document.body` as a fallback.", "kind": "function", "name": "AddToDOM", "since": "3.0.0", "params": [ { "type": { "names": [ "HTMLElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLElement" } }, "description": "The element to be added to the DOM. Usually a Canvas object.", "name": "element" }, { "type": { "names": [ "string", "HTMLElement" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "HTMLElement" } }, "description": "The element that was passed to this function." } ], "memberof": "Phaser.DOM", "longname": "Phaser.DOM.AddToDOM", "scope": "static", "___id": "T000002R006200", "___s": true }, { "comment": "/**\r\n * Creates a DOM container div element for use with DOM Game Objects.\r\n *\r\n * The container is an absolutely positioned div that overlays the game canvas,\r\n * matching its dimensions, and is added to the game's parent element.\r\n * It has pointer events set according to the game configuration and\r\n * serves as the parent for any DOM Element Game Objects added to a Scene.\r\n *\r\n * This function is called automatically during game boot if the game config\r\n * has both a `parent` element and `domCreateContainer` set to `true`.\r\n *\r\n * @function Phaser.DOM.CreateDOMContainer\r\n * @since 3.12.0\r\n *\r\n * @param {Phaser.Game} game - The Phaser Game instance to create the DOM container for.\r\n */", "meta": { "filename": "CreateDOMContainer.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "Creates a DOM container div element for use with DOM Game Objects.\r\rThe container is an absolutely positioned div that overlays the game canvas,\rmatching its dimensions, and is added to the game's parent element.\rIt has pointer events set according to the game configuration and\rserves as the parent for any DOM Element Game Objects added to a Scene.\r\rThis function is called automatically during game boot if the game config\rhas both a `parent` element and `domCreateContainer` set to `true`.", "kind": "function", "name": "CreateDOMContainer", "since": "3.12.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "The Phaser Game instance to create the DOM container for.", "name": "game" } ], "memberof": "Phaser.DOM", "longname": "Phaser.DOM.CreateDOMContainer", "scope": "static", "___id": "T000002R006208", "___s": true }, { "comment": "/**\r\n * A callback function to be invoked once the DOM content is fully loaded and the device is ready.\r\n *\r\n * @callback ContentLoadedCallback\r\n */", "meta": { "filename": "DOMContentLoaded.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "A callback function to be invoked once the DOM content is fully loaded and the device is ready.", "kind": "typedef", "name": "ContentLoadedCallback", "type": { "names": [ "function" ] }, "longname": "ContentLoadedCallback", "scope": "global", "___id": "T000002R006216", "___s": true }, { "comment": "/**\r\n * Inspects the readyState of the document. If the document is already complete or interactive, it invokes the given\r\n * callback immediately. If not, it registers event listeners to detect when the document becomes ready. On Cordova\r\n * environments it listens for the `deviceready` event; otherwise it listens for `DOMContentLoaded` and the window\r\n * `load` event, invoking the callback whichever fires first. If the document body is not yet available, it falls\r\n * back to a short timeout before invoking the callback.\r\n * Called automatically by the Phaser.Game instance. Should not usually be accessed directly.\r\n *\r\n * @function Phaser.DOM.DOMContentLoaded\r\n * @since 3.0.0\r\n *\r\n * @param {ContentLoadedCallback} callback - The callback to be invoked when the device is ready and the DOM content is loaded.\r\n */", "meta": { "filename": "DOMContentLoaded.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "Inspects the readyState of the document. If the document is already complete or interactive, it invokes the given\rcallback immediately. If not, it registers event listeners to detect when the document becomes ready. On Cordova\renvironments it listens for the `deviceready` event; otherwise it listens for `DOMContentLoaded` and the window\r`load` event, invoking the callback whichever fires first. If the document body is not yet available, it falls\rback to a short timeout before invoking the callback.\rCalled automatically by the Phaser.Game instance. Should not usually be accessed directly.", "kind": "function", "name": "DOMContentLoaded", "since": "3.0.0", "params": [ { "type": { "names": [ "ContentLoadedCallback" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R006217", "___s": true }, { "comment": "/**\r\n * Attempts to determine the document inner height across iOS and standard devices.\r\n * On non-iOS devices this simply returns `window.innerHeight`. On iOS, Safari's dynamic\r\n * browser chrome (such as the address bar appearing or hiding on scroll) can cause\r\n * `window.innerHeight` to report an inaccurate value. To work around this, a temporary\r\n * fixed-position element sized to `100vh` is injected into the DOM, its measured height\r\n * is used instead, and the element is immediately removed. The result is also adjusted\r\n * for landscape orientation using `window.orientation`.\r\n * Based on code by @tylerjpeterson\r\n *\r\n * @function Phaser.DOM.GetInnerHeight\r\n * @since 3.16.0\r\n *\r\n * @param {boolean} iOS - Is this running on iOS?\r\n *\r\n * @return {number} The inner height of the viewport, in pixels.\r\n */", "meta": { "filename": "GetInnerHeight.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "Attempts to determine the document inner height across iOS and standard devices.\rOn non-iOS devices this simply returns `window.innerHeight`. On iOS, Safari's dynamic\rbrowser chrome (such as the address bar appearing or hiding on scroll) can cause\r`window.innerHeight` to report an inaccurate value. To work around this, a temporary\rfixed-position element sized to `100vh` is injected into the DOM, its measured height\ris used instead, and the element is immediately removed. The result is also adjusted\rfor landscape orientation using `window.orientation`.\rBased on code by @tylerjpeterson", "kind": "function", "name": "GetInnerHeight", "since": "3.16.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this running on iOS?", "name": "iOS" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The inner height of the viewport, in pixels." } ], "memberof": "Phaser.DOM", "longname": "Phaser.DOM.GetInnerHeight", "scope": "static", "___id": "T000002R006221", "___s": true }, { "comment": "/**\r\n * Attempts to determine the screen orientation using a series of browser APIs,\r\n * falling back to comparing the viewport dimensions if none are available.\r\n *\r\n * It checks, in order: the Screen Orientation API (`screen.orientation`,\r\n * `screen.mozOrientation`, `screen.msOrientation`), the legacy `window.orientation`\r\n * property (used on iOS), the `window.matchMedia` API, and finally a simple\r\n * width-versus-height comparison as a last resort.\r\n *\r\n * @function Phaser.DOM.GetScreenOrientation\r\n * @since 3.16.0\r\n *\r\n * @param {number} width - The width of the viewport.\r\n * @param {number} height - The height of the viewport.\r\n *\r\n * @return {string} Either a `Phaser.Scale.PORTRAIT` or `Phaser.Scale.LANDSCAPE` string constant, or the raw orientation type string returned by the Screen Orientation API.\r\n */", "meta": { "filename": "GetScreenOrientation.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "Attempts to determine the screen orientation using a series of browser APIs,\rfalling back to comparing the viewport dimensions if none are available.\r\rIt checks, in order: the Screen Orientation API (`screen.orientation`,\r`screen.mozOrientation`, `screen.msOrientation`), the legacy `window.orientation`\rproperty (used on iOS), the `window.matchMedia` API, and finally a simple\rwidth-versus-height comparison as a last resort.", "kind": "function", "name": "GetScreenOrientation", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the viewport.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the viewport.", "name": "height" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Either a `Phaser.Scale.PORTRAIT` or `Phaser.Scale.LANDSCAPE` string constant, or the raw orientation type string returned by the Screen Orientation API." } ], "memberof": "Phaser.DOM", "longname": "Phaser.DOM.GetScreenOrientation", "scope": "static", "___id": "T000002R006233", "___s": true }, { "comment": "/**\r\n * Attempts to get the target DOM element based on the given value, which can be either\r\n * a string, in which case it will be looked-up by ID, or an element node. If nothing\r\n * can be found it will return a reference to the document.body.\r\n *\r\n * @function Phaser.DOM.GetTarget\r\n * @since 3.16.0\r\n *\r\n * @param {HTMLElement} element - The DOM element to look-up. Can be either a string, in which case it is used as an element ID to look up via `document.getElementById`, or a direct reference to an existing HTMLElement node.\r\n *\r\n * @return {HTMLElement} The DOM element matching the given ID or node reference, or `document.body` if no valid target was found.\r\n */", "meta": { "filename": "GetTarget.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "Attempts to get the target DOM element based on the given value, which can be either\ra string, in which case it will be looked-up by ID, or an element node. If nothing\rcan be found it will return a reference to the document.body.", "kind": "function", "name": "GetTarget", "since": "3.16.0", "params": [ { "type": { "names": [ "HTMLElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLElement" } }, "description": "The DOM element to look-up. Can be either a string, in which case it is used as an element ID to look up via `document.getElementById`, or a direct reference to an existing HTMLElement node.", "name": "element" } ], "returns": [ { "type": { "names": [ "HTMLElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLElement" } }, "description": "The DOM element matching the given ID or node reference, or `document.body` if no valid target was found." } ], "memberof": "Phaser.DOM", "longname": "Phaser.DOM.GetTarget", "scope": "static", "___id": "T000002R006238", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.DOM\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "kind": "namespace", "name": "DOM", "memberof": "Phaser", "longname": "Phaser.DOM", "scope": "static", "___id": "T000002R006245", "___s": true }, { "comment": "/**\r\n * Takes the given data string and parses it as XML.\r\n * First tries to use the window.DOMParser and reverts to the Microsoft.XMLDOM if that fails.\r\n * The parsed XML object is returned, or `null` if there was an error while parsing the data.\r\n *\r\n * @function Phaser.DOM.ParseXML\r\n * @since 3.0.0\r\n *\r\n * @param {string} data - The XML source stored in a string.\r\n *\r\n * @return {?XMLDocument} The parsed XML data, or `null` if the data could not be parsed.\r\n */", "meta": { "filename": "ParseXML.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "Takes the given data string and parses it as XML.\rFirst tries to use the window.DOMParser and reverts to the Microsoft.XMLDOM if that fails.\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The XML source stored in a string.", "name": "data" } ], "returns": [ { "type": { "names": [ "XMLDocument" ], "parsedType": { "type": "NameExpression", "name": "XMLDocument", "nullable": true } }, "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", "___id": "T000002R006256", "___s": true }, { "comment": "/**\r\n * Attempts to remove the element from its parentNode in the DOM.\r\n *\r\n * @function Phaser.DOM.RemoveFromDOM\r\n * @since 3.0.0\r\n *\r\n * @param {HTMLElement} element - The DOM element to remove from its parent node.\r\n */", "meta": { "filename": "RemoveFromDOM.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "Attempts to remove the element from its parentNode in the DOM.", "kind": "function", "name": "RemoveFromDOM", "since": "3.0.0", "params": [ { "type": { "names": [ "HTMLElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLElement" } }, "description": "The DOM element to remove from its parent node.", "name": "element" } ], "memberof": "Phaser.DOM", "longname": "Phaser.DOM.RemoveFromDOM", "scope": "static", "___id": "T000002R006264", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Abstracts away the use of `requestAnimationFrame` or `setTimeout` for the core game update loop,\r\n * providing a unified interface regardless of which mechanism is in use.\r\n *\r\n * When `requestAnimationFrame` is available and not overridden, it is used to drive the game loop,\r\n * which ties updates to the display refresh rate and pauses automatically when the tab is hidden.\r\n * If `forceSetTimeOut` is enabled in the Game Config, `setTimeout` is used instead, which runs\r\n * at a fixed interval regardless of visibility or display sync.\r\n *\r\n * This class is instantiated and managed automatically by the Phaser.Game instance.\r\n *\r\n * @class RequestAnimationFrame\r\n * @memberof Phaser.DOM\r\n * @constructor\r\n * @since 3.0.0\r\n */", "meta": { "filename": "RequestAnimationFrame.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "classdesc": "Abstracts away the use of `requestAnimationFrame` or `setTimeout` for the core game update loop,\rproviding a unified interface regardless of which mechanism is in use.\r\rWhen `requestAnimationFrame` is available and not overridden, it is used to drive the game loop,\rwhich ties updates to the display refresh rate and pauses automatically when the tab is hidden.\rIf `forceSetTimeOut` is enabled in the Game Config, `setTimeout` is used instead, which runs\rat a fixed interval regardless of visibility or display sync.\r\rThis class is instantiated and managed automatically by the Phaser.Game instance.", "kind": "class", "name": "RequestAnimationFrame", "memberof": "Phaser.DOM", "since": "3.0.0", "scope": "static", "longname": "Phaser.DOM.RequestAnimationFrame", "___id": "T000002R006269", "___s": true }, { "comment": "/**\r\n * True if RequestAnimationFrame is running, otherwise false.\r\n *\r\n * @name Phaser.DOM.RequestAnimationFrame#isRunning\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "RequestAnimationFrame.js", "lineno": 33, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "True if RequestAnimationFrame is running, otherwise false.", "name": "isRunning", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.DOM.RequestAnimationFrame", "longname": "Phaser.DOM.RequestAnimationFrame#isRunning", "scope": "instance", "kind": "member", "___id": "T000002R006272", "___s": true }, { "comment": "/**\r\n * The callback to be invoked each step.\r\n *\r\n * @name Phaser.DOM.RequestAnimationFrame#callback\r\n * @type {FrameRequestCallback}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "RequestAnimationFrame.js", "lineno": 43, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "The callback to be invoked each step.", "name": "callback", "type": { "names": [ "FrameRequestCallback" ], "parsedType": { "type": "NameExpression", "name": "FrameRequestCallback" } }, "since": "3.0.0", "memberof": "Phaser.DOM.RequestAnimationFrame", "longname": "Phaser.DOM.RequestAnimationFrame#callback", "scope": "instance", "kind": "member", "___id": "T000002R006274", "___s": true }, { "comment": "/**\r\n * True if the step is using setTimeout instead of RAF.\r\n *\r\n * @name Phaser.DOM.RequestAnimationFrame#isSetTimeOut\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "RequestAnimationFrame.js", "lineno": 52, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "True if the step is using setTimeout instead of RAF.", "name": "isSetTimeOut", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.DOM.RequestAnimationFrame", "longname": "Phaser.DOM.RequestAnimationFrame#isSetTimeOut", "scope": "instance", "kind": "member", "___id": "T000002R006276", "___s": true }, { "comment": "/**\r\n * The setTimeout or RAF callback ID used when canceling them.\r\n *\r\n * @name Phaser.DOM.RequestAnimationFrame#timeOutID\r\n * @type {?number}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "RequestAnimationFrame.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "The setTimeout or RAF callback ID used when canceling them.", "name": "timeOutID", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.DOM.RequestAnimationFrame", "longname": "Phaser.DOM.RequestAnimationFrame#timeOutID", "scope": "instance", "kind": "member", "___id": "T000002R006278", "___s": true }, { "comment": "/**\r\n * The delay, in milliseconds, between each step when using setTimeout.\r\n *\r\n * @name Phaser.DOM.RequestAnimationFrame#delay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "RequestAnimationFrame.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "The delay, in milliseconds, between each step when using setTimeout.", "name": "delay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.DOM.RequestAnimationFrame", "longname": "Phaser.DOM.RequestAnimationFrame#delay", "scope": "instance", "kind": "member", "___id": "T000002R006280", "___s": true }, { "comment": "/**\r\n * The RAF step function.\r\n *\r\n * Invokes the callback and schedules another call to requestAnimationFrame.\r\n *\r\n * @name Phaser.DOM.RequestAnimationFrame#step\r\n * @type {FrameRequestCallback}\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The timestamp passed in from RequestAnimationFrame.\r\n */", "meta": { "filename": "RequestAnimationFrame.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "The RAF step function.\r\rInvokes the callback and schedules another call to requestAnimationFrame.", "name": "step", "type": { "names": [ "FrameRequestCallback" ], "parsedType": { "type": "NameExpression", "name": "FrameRequestCallback" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The timestamp passed in from RequestAnimationFrame.", "name": "time" } ], "memberof": "Phaser.DOM.RequestAnimationFrame", "longname": "Phaser.DOM.RequestAnimationFrame#step", "scope": "instance", "kind": "member", "___id": "T000002R006283", "___s": true }, { "comment": "/**\r\n * The SetTimeout step function.\r\n *\r\n * Invokes the callback and schedules another call to setTimeout.\r\n *\r\n * @name Phaser.DOM.RequestAnimationFrame#stepTimeout\r\n * @type {function}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "RequestAnimationFrame.js", "lineno": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "The SetTimeout step function.\r\rInvokes the callback and schedules another call to setTimeout.", "name": "stepTimeout", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.0.0", "memberof": "Phaser.DOM.RequestAnimationFrame", "longname": "Phaser.DOM.RequestAnimationFrame#stepTimeout", "scope": "instance", "kind": "member", "___id": "T000002R006286", "___s": true }, { "comment": "/**\r\n * Starts the requestAnimationFrame or setTimeout process running.\r\n *\r\n * @method Phaser.DOM.RequestAnimationFrame#start\r\n * @since 3.0.0\r\n *\r\n * @param {FrameRequestCallback} callback - The callback to invoke each step.\r\n * @param {boolean} forceSetTimeOut - Should it use SetTimeout, even if RAF is available?\r\n * @param {number} delay - The delay, in milliseconds, between each step when using setTimeout.\r\n */", "meta": { "filename": "RequestAnimationFrame.js", "lineno": 126, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "description": "Starts the requestAnimationFrame or setTimeout process running.", "kind": "function", "name": "start", "since": "3.0.0", "params": [ { "type": { "names": [ "FrameRequestCallback" ], "parsedType": { "type": "NameExpression", "name": "FrameRequestCallback" } }, "description": "The callback to invoke each step.", "name": "callback" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should it use SetTimeout, even if RAF is available?", "name": "forceSetTimeOut" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delay, in milliseconds, between each step when using setTimeout.", "name": "delay" } ], "memberof": "Phaser.DOM.RequestAnimationFrame", "longname": "Phaser.DOM.RequestAnimationFrame#start", "scope": "instance", "___id": "T000002R006289", "___s": true }, { "comment": "/**\r\n * Stops the requestAnimationFrame or setTimeout from running.\r\n *\r\n * @method Phaser.DOM.RequestAnimationFrame#stop\r\n * @since 3.0.0\r\n */", "meta": { "filename": "RequestAnimationFrame.js", "lineno": 154, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "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", "___id": "T000002R006296", "___s": true }, { "comment": "/**\r\n * Stops the step from running and clears the callback reference.\r\n *\r\n * @method Phaser.DOM.RequestAnimationFrame#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "RequestAnimationFrame.js", "lineno": 174, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\dom", "code": {} }, "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", "___id": "T000002R006299", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * EventEmitter is a Scene Systems plugin compatible wrapper around the `eventemitter3` library,\r\n * providing a full-featured event emitter used throughout Phaser for event-driven communication\r\n * between game objects, scenes, and systems.\r\n *\r\n * Every Scene has an instance of this class available via `scene.events`, and many Phaser objects\r\n * extend or embed it to dispatch and receive events. It supports persistent listeners via `on` /\r\n * `addListener`, one-time listeners that auto-remove after firing via `once`, and listener removal\r\n * via `off` / `removeListener`.\r\n *\r\n * You can also instantiate it directly when you need a standalone event bus within your own code.\r\n *\r\n * @class EventEmitter\r\n * @memberof Phaser.Events\r\n * @constructor\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "classdesc": "EventEmitter is a Scene Systems plugin compatible wrapper around the `eventemitter3` library,\rproviding a full-featured event emitter used throughout Phaser for event-driven communication\rbetween game objects, scenes, and systems.\r\rEvery Scene has an instance of this class available via `scene.events`, and many Phaser objects\rextend or embed it to dispatch and receive events. It supports persistent listeners via `on` /\r`addListener`, one-time listeners that auto-remove after firing via `once`, and listener removal\rvia `off` / `removeListener`.\r\rYou can also instantiate it directly when you need a standalone event bus within your own code.", "kind": "class", "name": "EventEmitter", "memberof": "Phaser.Events", "since": "3.0.0", "scope": "static", "longname": "Phaser.Events.EventEmitter", "___id": "T000002R006306", "___s": true }, { "comment": "/**\r\n * Removes all listeners from this EventEmitter. This method is called automatically\r\n * by the Scene Systems when the parent Scene shuts down, ensuring that all event\r\n * bindings are cleared and no stale references remain.\r\n *\r\n * @method Phaser.Events.EventEmitter#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "description": "Removes all listeners from this EventEmitter. This method is called automatically\rby the Scene Systems when the parent Scene shuts down, ensuring that all event\rbindings are cleared and no stale references remain.", "kind": "function", "name": "shutdown", "since": "3.0.0", "memberof": "Phaser.Events.EventEmitter", "longname": "Phaser.Events.EventEmitter#shutdown", "scope": "instance", "___id": "T000002R006310", "___s": true }, { "comment": "/**\r\n * Removes all listeners from this EventEmitter and prepares it for garbage collection.\r\n * This method is called automatically when the parent object is destroyed and should\r\n * not be called directly unless you are tearing down the emitter manually.\r\n *\r\n * @method Phaser.Events.EventEmitter#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "description": "Removes all listeners from this EventEmitter and prepares it for garbage collection.\rThis method is called automatically when the parent object is destroyed and should\rnot be called directly unless you are tearing down the emitter manually.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.Events.EventEmitter", "longname": "Phaser.Events.EventEmitter#destroy", "scope": "instance", "___id": "T000002R006312", "___s": true }, { "comment": "/**\r\n * Return an array listing the events for which the emitter has registered listeners.\r\n *\r\n * @method Phaser.Events.EventEmitter#eventNames\r\n * @since 3.0.0\r\n *\r\n * @return {Array.}\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 68, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "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)>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } ] } } } ], "memberof": "Phaser.Events.EventEmitter", "longname": "Phaser.Events.EventEmitter#eventNames", "scope": "instance", "___id": "T000002R006314", "___s": true }, { "comment": "/**\r\n * Return the listeners registered for a given event.\r\n *\r\n * @method Phaser.Events.EventEmitter#listeners\r\n * @since 3.0.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n *\r\n * @return {Function[]} The registered listeners.\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 77, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "description": "Return the listeners registered for a given event.", "kind": "function", "name": "listeners", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.Events.EventEmitter", "longname": "Phaser.Events.EventEmitter#listeners", "scope": "instance", "___id": "T000002R006315", "___s": true }, { "comment": "/**\r\n * Return the number of listeners listening to a given event.\r\n *\r\n * @method Phaser.Events.EventEmitter#listenerCount\r\n * @since 3.0.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n *\r\n * @return {number} The number of listeners.\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 88, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "description": "Return the number of listeners listening to a given event.", "kind": "function", "name": "listenerCount", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.Events.EventEmitter", "longname": "Phaser.Events.EventEmitter#listenerCount", "scope": "instance", "___id": "T000002R006316", "___s": true }, { "comment": "/**\r\n * Calls each of the listeners registered for a given event.\r\n *\r\n * @method Phaser.Events.EventEmitter#emit\r\n * @since 3.0.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n * @param {...*} [args] - Additional arguments that will be passed to the event handler.\r\n *\r\n * @return {boolean} `true` if the event had listeners, else `false`.\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 99, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "description": "Calls each of the listeners registered for a given event.", "kind": "function", "name": "emit", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "Additional arguments that will be passed to the event handler.", "name": "args" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.Events.EventEmitter", "longname": "Phaser.Events.EventEmitter#emit", "scope": "instance", "___id": "T000002R006317", "___s": true }, { "comment": "/**\r\n * Add a listener for a given event.\r\n *\r\n * @method Phaser.Events.EventEmitter#on\r\n * @since 3.0.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n * @param {function} fn - The listener function.\r\n * @param {*} [context=this] - The context to invoke the listener with.\r\n *\r\n * @return {this} `this`.\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "description": "Add a listener for a given event.", "kind": "function", "name": "on", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The listener function.", "name": "fn" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "defaultvalue": "this", "description": "The context to invoke the listener with.", "name": "context" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Events.EventEmitter", "longname": "Phaser.Events.EventEmitter#on", "scope": "instance", "___id": "T000002R006318", "___s": true }, { "comment": "/**\r\n * Add a listener for a given event.\r\n *\r\n * @method Phaser.Events.EventEmitter#addListener\r\n * @since 3.0.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n * @param {function} fn - The listener function.\r\n * @param {*} [context=this] - The context to invoke the listener with.\r\n *\r\n * @return {this} `this`.\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 124, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "description": "Add a listener for a given event.", "kind": "function", "name": "addListener", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The listener function.", "name": "fn" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "defaultvalue": "this", "description": "The context to invoke the listener with.", "name": "context" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Events.EventEmitter", "longname": "Phaser.Events.EventEmitter#addListener", "scope": "instance", "___id": "T000002R006319", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event. The listener is automatically removed\r\n * the first time the event is emitted, so it will never be called more than once.\r\n *\r\n * @method Phaser.Events.EventEmitter#once\r\n * @since 3.0.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n * @param {function} fn - The listener function.\r\n * @param {*} [context=this] - The context to invoke the listener with.\r\n *\r\n * @return {this} `this`.\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 137, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "description": "Add a one-time listener for a given event. The listener is automatically removed\rthe first time the event is emitted, so it will never be called more than once.", "kind": "function", "name": "once", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The listener function.", "name": "fn" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "defaultvalue": "this", "description": "The context to invoke the listener with.", "name": "context" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Events.EventEmitter", "longname": "Phaser.Events.EventEmitter#once", "scope": "instance", "___id": "T000002R006320", "___s": true }, { "comment": "/**\r\n * Remove the listeners of a given event.\r\n *\r\n * @method Phaser.Events.EventEmitter#removeListener\r\n * @since 3.0.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n * @param {function} [fn] - Only remove the listeners that match this function.\r\n * @param {*} [context] - Only remove the listeners that have this context.\r\n * @param {boolean} [once] - Only remove one-time listeners.\r\n *\r\n * @return {this} `this`.\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 151, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "description": "Remove the listeners of a given event.", "kind": "function", "name": "removeListener", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "Only remove the listeners that match this function.", "name": "fn" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "Only remove the listeners that have this context.", "name": "context" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Only remove one-time listeners.", "name": "once" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Events.EventEmitter", "longname": "Phaser.Events.EventEmitter#removeListener", "scope": "instance", "___id": "T000002R006321", "___s": true }, { "comment": "/**\r\n * Remove the listeners of a given event.\r\n *\r\n * @method Phaser.Events.EventEmitter#off\r\n * @since 3.0.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n * @param {function} [fn] - Only remove the listeners that match this function.\r\n * @param {*} [context] - Only remove the listeners that have this context.\r\n * @param {boolean} [once] - Only remove one-time listeners.\r\n *\r\n * @return {this} `this`.\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 165, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "description": "Remove the listeners of a given event.", "kind": "function", "name": "off", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "Only remove the listeners that match this function.", "name": "fn" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "Only remove the listeners that have this context.", "name": "context" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Only remove one-time listeners.", "name": "once" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Events.EventEmitter", "longname": "Phaser.Events.EventEmitter#off", "scope": "instance", "___id": "T000002R006322", "___s": true }, { "comment": "/**\r\n * Remove all listeners, or those of the specified event.\r\n *\r\n * @method Phaser.Events.EventEmitter#removeAllListeners\r\n * @since 3.0.0\r\n *\r\n * @param {(string|symbol)} [event] - The event name.\r\n *\r\n * @return {this} `this`.\r\n */", "meta": { "filename": "EventEmitter.js", "lineno": 179, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "description": "Remove all listeners, or those of the specified event.", "kind": "function", "name": "removeAllListeners", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "optional": true, "description": "The event name.", "name": "event" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "`this`." } ], "memberof": "Phaser.Events.EventEmitter", "longname": "Phaser.Events.EventEmitter#removeAllListeners", "scope": "instance", "___id": "T000002R006323", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser", "longname": "Phaser.Events", "scope": "static", "___id": "T000002R006325", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Barrel Filter Controller.\r\n *\r\n * This filter controller manages the barrel distortion effect for a Camera.\r\n * A barrel effect allows you to apply either a 'pinch' or 'expand' distortion to\r\n * the view. The amount of the effect can be modified in real-time.\r\n *\r\n * A Barrel effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n *\r\n * camera.filters.internal.addBarrel();\r\n * camera.filters.external.addBarrel();\r\n * ```\r\n *\r\n * @class Barrel\r\n * @extends Phaser.Filters.Controller\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that owns this filter.\r\n * @param {number} [amount=1] - The amount of distortion applied to the barrel effect. A value of 1 is no distortion. Typically keep this within +- 1.\r\n */", "meta": { "filename": "Barrel.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Barrel Filter Controller.\r\rThis filter controller manages the barrel distortion effect for a Camera.\rA barrel effect allows you to apply either a 'pinch' or 'expand' distortion to\rthe view. The amount of the effect can be modified in real-time.\r\rA Barrel effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\r\rcamera.filters.internal.addBarrel();\rcamera.filters.external.addBarrel();\r```", "kind": "class", "name": "Barrel", "augments": [ "Phaser.Filters.Controller" ], "memberof": "Phaser.Filters", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount of distortion applied to the barrel effect. A value of 1 is no distortion. Typically keep this within +- 1.", "name": "amount" } ], "scope": "static", "longname": "Phaser.Filters.Barrel", "___id": "T000002R006330", "___s": true }, { "comment": "/**\r\n * The amount of distortion applied to the barrel effect.\r\n *\r\n * A value of 1 applies no distortion. Values above 1 expand the view outward\r\n * (barrel distortion), while values below 1 pinch the view inward (pincushion\r\n * distortion). Typically keep this within ±1 of the default value of 1.\r\n *\r\n * @name Phaser.Filters.Barrel#amount\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Barrel.js", "lineno": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The amount of distortion applied to the barrel effect.\r\rA value of 1 applies no distortion. Values above 1 expand the view outward\r(barrel distortion), while values below 1 pinch the view inward (pincushion\rdistortion). Typically keep this within ±1 of the default value of 1.", "name": "amount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Barrel", "longname": "Phaser.Filters.Barrel#amount", "scope": "instance", "kind": "member", "___id": "T000002R006335", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Blend Filter Controller.\r\n *\r\n * This filter controller manages the blend effect for a Camera.\r\n * A blend effect allows you to apply another texture to the view\r\n * using a specific blend mode.\r\n * This supports blend modes not otherwise available in WebGL.\r\n *\r\n * A Blend effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n * camera.filters.internal.addBlend();\r\n * camera.filters.external.addBlend();\r\n * ```\r\n *\r\n * @class Blend\r\n * @extends Phaser.Filters.Controller\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that owns this filter.\r\n * @param {string} [texture='__WHITE'] - The texture to apply to the view.\r\n * @param {Phaser.BlendModes} [blendMode=Phaser.BlendModes.NORMAL] - The blend mode to apply to the view.\r\n * @param {number} [amount=1] - The amount of the blend effect to apply to the view. At 0, the original image is preserved. At 1, the blend texture is fully applied. The expected range is 0 to 1, but you can go outside that range for different effects.\r\n * @param {number[]} [color=[1, 1, 1, 1]] - The color to apply to the blend texture. Each value corresponds to a color channel in RGBA. The expected range is 0 to 1, but you can go outside that range for different effects.\r\n */", "meta": { "filename": "Blend.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Blend Filter Controller.\r\rThis filter controller manages the blend effect for a Camera.\rA blend effect allows you to apply another texture to the view\rusing a specific blend mode.\rThis supports blend modes not otherwise available in WebGL.\r\rA Blend effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\rcamera.filters.internal.addBlend();\rcamera.filters.external.addBlend();\r```", "kind": "class", "name": "Blend", "augments": [ "Phaser.Filters.Controller" ], "memberof": "Phaser.Filters", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'__WHITE'", "description": "The texture to apply to the view.", "name": "texture" }, { "type": { "names": [ "Phaser.BlendModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.BlendModes" } }, "optional": true, "defaultvalue": "Phaser.BlendModes.NORMAL", "description": "The blend mode to apply to the view.", "name": "blendMode" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount of the blend effect to apply to the view. At 0, the original image is preserved. At 1, the blend texture is fully applied. The expected range is 0 to 1, but you can go outside that range for different effects.", "name": "amount" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[1, 1, 1, 1]", "description": "The color to apply to the blend texture. Each value corresponds to a color channel in RGBA. The expected range is 0 to 1, but you can go outside that range for different effects.", "name": "color" } ], "scope": "static", "longname": "Phaser.Filters.Blend", "___id": "T000002R006340", "___s": true }, { "comment": "/**\r\n * The underlying texture used for the blend.\r\n *\r\n * @name Phaser.Filters.Blend#glTexture\r\n * @type {Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Blend.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The underlying texture used for the blend.", "name": "glTexture", "type": { "names": [ "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Blend", "longname": "Phaser.Filters.Blend#glTexture", "scope": "instance", "kind": "member", "___id": "T000002R006348", "___s": true }, { "comment": "/**\r\n * The blend mode to apply to the view.\r\n * This supports blend modes not otherwise available in WebGL.\r\n *\r\n * @name Phaser.Filters.Blend#blendMode\r\n * @type {Phaser.BlendModes}\r\n * @since 4.0.0\r\n * @default Phaser.BlendModes.NORMAL\r\n */", "meta": { "filename": "Blend.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The blend mode to apply to the view.\rThis supports blend modes not otherwise available in WebGL.", "name": "blendMode", "type": { "names": [ "Phaser.BlendModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.BlendModes" } }, "since": "4.0.0", "defaultvalue": "Phaser.BlendModes.NORMAL", "memberof": "Phaser.Filters.Blend", "longname": "Phaser.Filters.Blend#blendMode", "scope": "instance", "kind": "member", "___id": "T000002R006350", "___s": true }, { "comment": "/**\r\n * The amount of the blend effect to apply to the view.\r\n * At 0, the original image is preserved. At 1, the blend texture is fully applied.\r\n *\r\n * @name Phaser.Filters.Blend#amount\r\n * @type {number}\r\n * @since 4.0.0\r\n * @default 1\r\n */", "meta": { "filename": "Blend.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The amount of the blend effect to apply to the view.\rAt 0, the original image is preserved. At 1, the blend texture is fully applied.", "name": "amount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "defaultvalue": "1", "memberof": "Phaser.Filters.Blend", "longname": "Phaser.Filters.Blend#amount", "scope": "instance", "kind": "member", "___id": "T000002R006352", "___s": true }, { "comment": "/**\r\n * The color to apply to the blend texture.\r\n * Each value corresponds to a color channel in RGBA.\r\n * The expected range is 0 to 1, but you can go outside that range for different effects.\r\n *\r\n * @name Phaser.Filters.Blend#color\r\n * @type {number[]}\r\n * @since 4.0.0\r\n * @default [1, 1, 1, 1]\r\n */", "meta": { "filename": "Blend.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The color to apply to the blend texture.\rEach value corresponds to a color channel in RGBA.\rThe expected range is 0 to 1, but you can go outside that range for different effects.", "name": "color", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "defaultvalue": "[1, 1, 1, 1]", "memberof": "Phaser.Filters.Blend", "longname": "Phaser.Filters.Blend#color", "scope": "instance", "kind": "member", "___id": "T000002R006354", "___s": true }, { "comment": "/**\r\n * Sets the texture used for the blend.\r\n *\r\n * @method Phaser.Filters.Blend#setTexture\r\n * @since 4.0.0\r\n * @param {string} [texture='__WHITE'] - The unique string-based key of the texture to use for the blend, which must exist in the Texture Manager.\r\n * @return {this} This Filter Controller.\r\n */", "meta": { "filename": "Blend.js", "lineno": 96, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets the texture used for the blend.", "kind": "function", "name": "setTexture", "since": "4.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'__WHITE'", "description": "The unique string-based key of the texture to use for the blend, which must exist in the Texture Manager.", "name": "texture" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Filter Controller." } ], "memberof": "Phaser.Filters.Blend", "longname": "Phaser.Filters.Blend#setTexture", "scope": "instance", "___id": "T000002R006356", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Blocky Filter Controller.\r\n *\r\n * This filter controller manages a blocky effect.\r\n *\r\n * The blocky effect works by taking the central pixel of a block of pixels\r\n * and using it to fill the entire block, creating a pixelated effect.\r\n *\r\n * It reduces the resolution of an image,\r\n * creating a pixelated or blocky appearance.\r\n * This is often used for stylistic purposes, such as pixel art.\r\n * One technique is to render the game at a higher resolution,\r\n * scaled up by a factor of N,\r\n * and then apply the blocky effect at size N.\r\n * This creates large, visible pixels, suitable for further stylization.\r\n * The effect can also be used to obscure certain elements within the game,\r\n * such as during a transition or to censor specific content.\r\n *\r\n * Blocky works best on games with no anti-aliasing,\r\n * so it can read unfiltered pixel colors from the original image.\r\n * It preserves the colors of the original art, instead of blending them\r\n * like the Pixelate filter.\r\n *\r\n * A Blocky effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n * camera.filters.internal.addBlocky({ size: 4 });\r\n * camera.filters.external.addBlocky({ size: { x: 2, y: 4 }, offset: { x: 1, y: 2 } });\r\n * ```\r\n *\r\n * @class Blocky\r\n * @extends Phaser.Filters.Controller\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that owns this filter.\r\n * @param {Phaser.Types.Filters.BlockyConfig} [config] - The configuration object for the Blocky effect.\r\n */", "meta": { "filename": "Blocky.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Blocky Filter Controller.\r\rThis filter controller manages a blocky effect.\r\rThe blocky effect works by taking the central pixel of a block of pixels\rand using it to fill the entire block, creating a pixelated effect.\r\rIt reduces the resolution of an image,\rcreating a pixelated or blocky appearance.\rThis is often used for stylistic purposes, such as pixel art.\rOne technique is to render the game at a higher resolution,\rscaled up by a factor of N,\rand then apply the blocky effect at size N.\rThis creates large, visible pixels, suitable for further stylization.\rThe effect can also be used to obscure certain elements within the game,\rsuch as during a transition or to censor specific content.\r\rBlocky works best on games with no anti-aliasing,\rso it can read unfiltered pixel colors from the original image.\rIt preserves the colors of the original art, instead of blending them\rlike the Pixelate filter.\r\rA Blocky effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\rcamera.filters.internal.addBlocky({ size: 4 });\rcamera.filters.external.addBlocky({ size: { x: 2, y: 4 }, offset: { x: 1, y: 2 } });\r```", "kind": "class", "name": "Blocky", "augments": [ "Phaser.Filters.Controller" ], "memberof": "Phaser.Filters", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "Phaser.Types.Filters.BlockyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Filters.BlockyConfig" } }, "optional": true, "description": "The configuration object for the Blocky effect.", "name": "config" } ], "scope": "static", "longname": "Phaser.Filters.Blocky", "___id": "T000002R006363", "___s": true }, { "comment": "/**\r\n * The size of the blocks.\r\n * You can set the x and y values to any numbers,\r\n * but the filter will limit them to a minimum of 1.\r\n *\r\n * @name Phaser.Filters.Blocky#size\r\n * @type {Phaser.Types.Math.Vector2Like}\r\n * @default { x: 4, y: 4 }\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Blocky.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The size of the blocks.\rYou can set the x and y values to any numbers,\rbut the filter will limit them to a minimum of 1.", "name": "size", "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "defaultvalue": "{ x: 4, y: 4 }", "since": "4.0.0", "memberof": "Phaser.Filters.Blocky", "longname": "Phaser.Filters.Blocky#size", "scope": "instance", "kind": "member", "___id": "T000002R006367", "___s": true }, { "comment": "/**\r\n * The offset of the blocks from the top left corner of the image.\r\n *\r\n * @name Phaser.Filters.Blocky#offset\r\n * @type {Phaser.Types.Math.Vector2Like}\r\n * @default { x: 0, y: 0 }\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Blocky.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The offset of the blocks from the top left corner of the image.", "name": "offset", "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "defaultvalue": "{ x: 0, y: 0 }", "since": "4.0.0", "memberof": "Phaser.Filters.Blocky", "longname": "Phaser.Filters.Blocky#offset", "scope": "instance", "kind": "member", "___id": "T000002R006371", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Blur Filter Controller.\r\n *\r\n * This filter controller manages a blur effect.\r\n *\r\n * A Gaussian blur is the result of blurring an image by a Gaussian function. It is a widely used effect,\r\n * typically to reduce image noise and reduce detail. The visual effect of this blurring technique is a\r\n * smooth blur resembling that of viewing the image through a translucent screen, distinctly different\r\n * from the bokeh effect produced by an out-of-focus lens or the shadow of an object under usual illumination.\r\n *\r\n * This effect samples across an area. To avoid missing data at the edges,\r\n * use `controller.setPaddingOverride(null)` to automatically pad game objects,\r\n * or `camera.getPaddingWrapper(x)` to enlarge a camera.\r\n *\r\n * A Blur effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n *\r\n * camera.filters.internal.addBlur();\r\n * camera.filters.external.addBlur();\r\n * ```\r\n *\r\n * @class Blur\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @extends Phaser.Filters.Controller\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that owns this filter.\r\n * @param {number} [quality=0] - The quality of the blur effect. Can be either 0 for Low Quality, 1 for Medium Quality or 2 for High Quality.\r\n * @param {number} [x=2] - The horizontal offset of the blur effect.\r\n * @param {number} [y=2] - The vertical offset of the blur effect.\r\n * @param {number} [strength=1] - The strength of the blur effect.\r\n * @param {number} [color=0xffffff] - The color of the blur, as a hex value.\r\n * @param {number} [steps=4] - The number of steps to run the blur effect for. This value should always be an integer.\r\n */", "meta": { "filename": "Blur.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Blur Filter Controller.\r\rThis filter controller manages a blur effect.\r\rA Gaussian blur is the result of blurring an image by a Gaussian function. It is a widely used effect,\rtypically to reduce image noise and reduce detail. The visual effect of this blurring technique is a\rsmooth blur resembling that of viewing the image through a translucent screen, distinctly different\rfrom the bokeh effect produced by an out-of-focus lens or the shadow of an object under usual illumination.\r\rThis effect samples across an area. To avoid missing data at the edges,\ruse `controller.setPaddingOverride(null)` to automatically pad game objects,\ror `camera.getPaddingWrapper(x)` to enlarge a camera.\r\rA Blur effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\r\rcamera.filters.internal.addBlur();\rcamera.filters.external.addBlur();\r```", "kind": "class", "name": "Blur", "memberof": "Phaser.Filters", "since": "4.0.0", "augments": [ "Phaser.Filters.Controller" ], "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The quality of the blur effect. Can be either 0 for Low Quality, 1 for Medium Quality or 2 for High Quality.", "name": "quality" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "The horizontal offset of the blur effect.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "The vertical offset of the blur effect.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blur effect.", "name": "strength" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color of the blur, as a hex value.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "The number of steps to run the blur effect for. This value should always be an integer.", "name": "steps" } ], "scope": "static", "longname": "Phaser.Filters.Blur", "___id": "T000002R006386", "___s": true }, { "comment": "/**\r\n * The quality of the blur effect.\r\n *\r\n * This can be:\r\n *\r\n * 0 for Low Quality\r\n * 1 for Medium Quality\r\n * 2 for High Quality\r\n *\r\n * The higher the quality, the more complex the shader used,\r\n * and the more processing time is spent on the GPU calculating\r\n * the final blur. This value is used in conjunction with the\r\n * `steps` value, as one has a direct impact on the other.\r\n *\r\n * Keep this value as low as you can, while still achieving the\r\n * desired effect you need for your game.\r\n *\r\n * @name Phaser.Filters.Blur#quality\r\n * @type {number}\r\n * @default 0\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Blur.js", "lineno": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The quality of the blur effect.\r\rThis can be:\r\r0 for Low Quality\r1 for Medium Quality\r2 for High Quality\r\rThe higher the quality, the more complex the shader used,\rand the more processing time is spent on the GPU calculating\rthe final blur. This value is used in conjunction with the\r`steps` value, as one has a direct impact on the other.\r\rKeep this value as low as you can, while still achieving the\rdesired effect you need for your game.", "name": "quality", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.0.0", "memberof": "Phaser.Filters.Blur", "longname": "Phaser.Filters.Blur#quality", "scope": "instance", "kind": "member", "___id": "T000002R006395", "___s": true }, { "comment": "/**\r\n * The horizontal offset of the blur effect. This controls the distance\r\n * between blur sample points along the x axis. A larger value increases\r\n * the spread of the blur horizontally.\r\n *\r\n * @name Phaser.Filters.Blur#x\r\n * @type {number}\r\n * @default 2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Blur.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The horizontal offset of the blur effect. This controls the distance\rbetween blur sample points along the x axis. A larger value increases\rthe spread of the blur horizontally.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "4.0.0", "memberof": "Phaser.Filters.Blur", "longname": "Phaser.Filters.Blur#x", "scope": "instance", "kind": "member", "___id": "T000002R006397", "___s": true }, { "comment": "/**\r\n * The vertical offset of the blur effect. This controls the distance\r\n * between blur sample points along the y axis. A larger value increases\r\n * the spread of the blur vertically.\r\n *\r\n * @name Phaser.Filters.Blur#y\r\n * @type {number}\r\n * @default 2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Blur.js", "lineno": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The vertical offset of the blur effect. This controls the distance\rbetween blur sample points along the y axis. A larger value increases\rthe spread of the blur vertically.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "4.0.0", "memberof": "Phaser.Filters.Blur", "longname": "Phaser.Filters.Blur#y", "scope": "instance", "kind": "member", "___id": "T000002R006399", "___s": true }, { "comment": "/**\r\n * The strength of the blur effect. This value is multiplied with the\r\n * x and y offsets and the number of steps to determine the total blur\r\n * radius. Increase this to make the blur more pronounced without\r\n * changing the quality or step count.\r\n *\r\n * @name Phaser.Filters.Blur#strength\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Blur.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The strength of the blur effect. This value is multiplied with the\rx and y offsets and the number of steps to determine the total blur\rradius. Increase this to make the blur more pronounced without\rchanging the quality or step count.", "name": "strength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.Filters.Blur", "longname": "Phaser.Filters.Blur#strength", "scope": "instance", "kind": "member", "___id": "T000002R006401", "___s": true }, { "comment": "/**\r\n * The internal gl color array.\r\n *\r\n * @name Phaser.Filters.Blur#glcolor\r\n * @type {number[]}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Blur.js", "lineno": 121, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The internal gl color array.", "name": "glcolor", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "memberof": "Phaser.Filters.Blur", "longname": "Phaser.Filters.Blur#glcolor", "scope": "instance", "kind": "member", "___id": "T000002R006403", "___s": true }, { "comment": "/**\r\n * The number of steps to run the Blur effect for.\r\n *\r\n * This value should always be an integer.\r\n *\r\n * The higher the value, the smoother the blur,\r\n * but at the cost of exponentially more gl operations.\r\n *\r\n * Keep this to the lowest possible number you can have it, while\r\n * still looking correct for your game.\r\n *\r\n * @name Phaser.Filters.Blur#steps\r\n * @type {number}\r\n * @default 4\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Blur.js", "lineno": 135, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The number of steps to run the Blur effect for.\r\rThis value should always be an integer.\r\rThe higher the value, the smoother the blur,\rbut at the cost of exponentially more gl operations.\r\rKeep this to the lowest possible number you can have it, while\rstill looking correct for your game.", "name": "steps", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "4", "since": "4.0.0", "memberof": "Phaser.Filters.Blur", "longname": "Phaser.Filters.Blur#steps", "scope": "instance", "kind": "member", "___id": "T000002R006406", "___s": true }, { "comment": "/**\r\n * The color of the blur effect, as a packed RGB hex integer (e.g. `0xff0000`\r\n * for red). This tints the blur samples, allowing colored bloom-style effects.\r\n * Defaults to white (`0xffffff`), which produces a neutral blur with no tint.\r\n *\r\n * @name Phaser.Filters.Blur#color\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Blur.js", "lineno": 154, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The color of the blur effect, as a packed RGB hex integer (e.g. `0xff0000`\rfor red). This tints the blur samples, allowing colored bloom-style effects.\rDefaults to white (`0xffffff`), which produces a neutral blur with no tint.", "name": "color", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Blur", "longname": "Phaser.Filters.Blur#color", "scope": "instance", "kind": "member", "___id": "T000002R006408", "___s": true }, { "comment": "/**\r\n * Returns the amount of extra padding, in pixels, that this filter requires when rendering.\r\n * This accounts for the blur radius extending beyond the original bounds of the\r\n * filtered Game Object.\r\n *\r\n * @method Phaser.Filters.Blur#getPadding\r\n * @since 4.0.0\r\n *\r\n * @return {Phaser.Geom.Rectangle} The padding Rectangle.\r\n */", "meta": { "filename": "Blur.js", "lineno": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Returns the amount of extra padding, in pixels, that this filter requires when rendering.\rThis accounts for the blur radius extending beyond the original bounds of the\rfiltered Game Object.", "kind": "function", "name": "getPadding", "since": "4.0.0", "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The padding Rectangle." } ], "memberof": "Phaser.Filters.Blur", "longname": "Phaser.Filters.Blur#getPadding", "scope": "instance", "overrides": "Phaser.Filters.Controller#getPadding", "___id": "T000002R006417", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Bokeh Filter Controller.\r\n *\r\n * This filter controller manages the bokeh effect for a Camera.\r\n *\r\n * Bokeh refers to a visual effect that mimics the photographic technique of creating a shallow depth of field.\r\n * This effect is used to emphasize the game's main subject or action, by blurring the background or foreground\r\n * elements, resulting in a more immersive and visually appealing experience. It is achieved through rendering\r\n * techniques that simulate the out-of-focus areas, giving a sense of depth and realism to the game's graphics.\r\n *\r\n * This effect can also be used to generate a Tilt Shift effect, which is a technique used to create a miniature\r\n * effect by blurring everything except a small area of the image. This effect is achieved by blurring the\r\n * top and bottom elements, while keeping the center area in focus.\r\n *\r\n * This effect samples across an area. To avoid missing data at the edges,\r\n * use `controller.setPaddingOverride(null)` to automatically pad game objects,\r\n * or `camera.getPaddingWrapper(x)` to enlarge a camera.\r\n *\r\n * A Bokeh effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n *\r\n * camera.filters.internal.addBokeh();\r\n * camera.filters.external.addBokeh();\r\n * ```\r\n *\r\n * @class Bokeh\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @extends Phaser.Filters.Controller\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that owns this filter.\r\n * @param {number} [radius=0.5] - The radius of the bokeh effect.\r\n * @param {number} [amount=1] - The amount of the bokeh effect.\r\n * @param {number} [contrast=0.2] - The color contrast of the bokeh effect.\r\n * @param {boolean} [isTiltShift=false] - Is this a bokeh or Tilt Shift effect?\r\n * @param {number} [blurX=1] - If Tilt Shift, the amount of horizontal blur.\r\n * @param {number} [blurY=1] - If Tilt Shift, the amount of vertical blur.\r\n * @param {number} [strength=1] - If Tilt Shift, the strength of the blur.\r\n * */", "meta": { "filename": "Bokeh.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Bokeh Filter Controller.\r\rThis filter controller manages the bokeh effect for a Camera.\r\rBokeh refers to a visual effect that mimics the photographic technique of creating a shallow depth of field.\rThis effect is used to emphasize the game's main subject or action, by blurring the background or foreground\relements, resulting in a more immersive and visually appealing experience. It is achieved through rendering\rtechniques that simulate the out-of-focus areas, giving a sense of depth and realism to the game's graphics.\r\rThis effect can also be used to generate a Tilt Shift effect, which is a technique used to create a miniature\reffect by blurring everything except a small area of the image. This effect is achieved by blurring the\rtop and bottom elements, while keeping the center area in focus.\r\rThis effect samples across an area. To avoid missing data at the edges,\ruse `controller.setPaddingOverride(null)` to automatically pad game objects,\ror `camera.getPaddingWrapper(x)` to enlarge a camera.\r\rA Bokeh effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\r\rcamera.filters.internal.addBokeh();\rcamera.filters.external.addBokeh();\r```", "kind": "class", "name": "Bokeh", "memberof": "Phaser.Filters", "since": "4.0.0", "augments": [ "Phaser.Filters.Controller" ], "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The radius of the bokeh effect.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount of the bokeh effect.", "name": "amount" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.2, "description": "The color contrast of the bokeh effect.", "name": "contrast" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is this a bokeh or Tilt Shift effect?", "name": "isTiltShift" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "If Tilt Shift, the amount of horizontal blur.", "name": "blurX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "If Tilt Shift, the amount of vertical blur.", "name": "blurY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "If Tilt Shift, the strength of the blur.", "name": "strength" } ], "scope": "static", "longname": "Phaser.Filters.Bokeh", "___id": "T000002R006428", "___s": true }, { "comment": "/**\r\n * The radius of the bokeh effect.\r\n *\r\n * This is a float value, where a radius of 0 will result in no effect being applied,\r\n * and a radius of 1 will result in a strong bokeh. However, you can exceed this value\r\n * for even stronger effects.\r\n *\r\n * @name Phaser.Filters.Bokeh#radius\r\n * @type {number}\r\n * @default 0.5\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The radius of the bokeh effect.\r\rThis is a float value, where a radius of 0 will result in no effect being applied,\rand a radius of 1 will result in a strong bokeh. However, you can exceed this value\rfor even stronger effects.", "name": "radius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.5", "since": "4.0.0", "memberof": "Phaser.Filters.Bokeh", "longname": "Phaser.Filters.Bokeh#radius", "scope": "instance", "kind": "member", "___id": "T000002R006439", "___s": true }, { "comment": "/**\r\n * The amount of the bokeh effect. This controls how many samples are taken\r\n * during the blur pass. Higher values produce a denser, more pronounced bokeh\r\n * at the cost of additional GPU work. This property applies to the standard\r\n * bokeh effect only; use `strength` to adjust the intensity of a Tilt Shift effect.\r\n *\r\n * @name Phaser.Filters.Bokeh#amount\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The amount of the bokeh effect. This controls how many samples are taken\rduring the blur pass. Higher values produce a denser, more pronounced bokeh\rat the cost of additional GPU work. This property applies to the standard\rbokeh effect only; use `strength` to adjust the intensity of a Tilt Shift effect.", "name": "amount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.Filters.Bokeh", "longname": "Phaser.Filters.Bokeh#amount", "scope": "instance", "kind": "member", "___id": "T000002R006441", "___s": true }, { "comment": "/**\r\n * The color contrast of the bokeh effect. This controls how strongly the\r\n * out-of-focus areas differ in luminance from the in-focus areas. Higher values\r\n * increase the brightness contrast between the bokeh highlights and their surroundings,\r\n * making the effect more visually distinct.\r\n *\r\n * @name Phaser.Filters.Bokeh#contrast\r\n * @type {number}\r\n * @default 0.2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The color contrast of the bokeh effect. This controls how strongly the\rout-of-focus areas differ in luminance from the in-focus areas. Higher values\rincrease the brightness contrast between the bokeh highlights and their surroundings,\rmaking the effect more visually distinct.", "name": "contrast", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.2", "since": "4.0.0", "memberof": "Phaser.Filters.Bokeh", "longname": "Phaser.Filters.Bokeh#contrast", "scope": "instance", "kind": "member", "___id": "T000002R006443", "___s": true }, { "comment": "/**\r\n * Is this a Tilt Shift effect or a standard bokeh effect?\r\n *\r\n * @name Phaser.Filters.Bokeh#isTiltShift\r\n * @type {boolean}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Is this a Tilt Shift effect or a standard bokeh effect?", "name": "isTiltShift", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Bokeh", "longname": "Phaser.Filters.Bokeh#isTiltShift", "scope": "instance", "kind": "member", "___id": "T000002R006445", "___s": true }, { "comment": "/**\r\n * If a Tilt Shift effect this controls the amount of horizontal blur.\r\n *\r\n * Setting this value on a non-Tilt Shift effect will have no effect.\r\n *\r\n * @name Phaser.Filters.Bokeh#blurX\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "If a Tilt Shift effect this controls the amount of horizontal blur.\r\rSetting this value on a non-Tilt Shift effect will have no effect.", "name": "blurX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.Filters.Bokeh", "longname": "Phaser.Filters.Bokeh#blurX", "scope": "instance", "kind": "member", "___id": "T000002R006447", "___s": true }, { "comment": "/**\r\n * If a Tilt Shift effect this controls the amount of vertical blur.\r\n *\r\n * Setting this value on a non-Tilt Shift effect will have no effect.\r\n *\r\n * @name Phaser.Filters.Bokeh#blurY\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 129, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "If a Tilt Shift effect this controls the amount of vertical blur.\r\rSetting this value on a non-Tilt Shift effect will have no effect.", "name": "blurY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.Filters.Bokeh", "longname": "Phaser.Filters.Bokeh#blurY", "scope": "instance", "kind": "member", "___id": "T000002R006449", "___s": true }, { "comment": "/**\r\n * If a Tilt Shift effect this controls the strength of the blur.\r\n *\r\n * Setting this value on a non-Tilt Shift effect will have no effect.\r\n *\r\n * @name Phaser.Filters.Bokeh#strength\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "If a Tilt Shift effect this controls the strength of the blur.\r\rSetting this value on a non-Tilt Shift effect will have no effect.", "name": "strength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.Filters.Bokeh", "longname": "Phaser.Filters.Bokeh#strength", "scope": "instance", "kind": "member", "___id": "T000002R006451", "___s": true }, { "comment": "/**\r\n * Returns the amount of extra padding, in pixels, that this filter requires when rendering.\r\n * The padding accounts for the bokeh effect extending beyond the original bounds\r\n * of the filtered Camera.\r\n *\r\n * @method Phaser.Filters.Bokeh#getPadding\r\n * @since 4.0.0\r\n *\r\n * @return {Phaser.Geom.Rectangle} The padding Rectangle.\r\n */", "meta": { "filename": "Bokeh.js", "lineno": 154, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Returns the amount of extra padding, in pixels, that this filter requires when rendering.\rThe padding accounts for the bokeh effect extending beyond the original bounds\rof the filtered Camera.", "kind": "function", "name": "getPadding", "since": "4.0.0", "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The padding Rectangle." } ], "memberof": "Phaser.Filters.Bokeh", "longname": "Phaser.Filters.Bokeh#getPadding", "scope": "instance", "overrides": "Phaser.Filters.Controller#getPadding", "___id": "T000002R006453", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The ColorMatrix Filter Controller.\r\n *\r\n * This filter controller manages the color matrix effect for a Camera.\r\n *\r\n * The color matrix effect is a visual technique that involves manipulating the colors of an image\r\n * or scene using a mathematical matrix. This process can adjust hue, saturation, brightness, and contrast,\r\n * allowing developers to create various stylistic appearances or mood settings within the game.\r\n * Common applications include simulating different lighting conditions, applying color filters,\r\n * or achieving a specific visual style.\r\n *\r\n * A ColorMatrix effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n *\r\n * const cmFilter = camera.filters.internal.addColorMatrix();\r\n * camera.filters.external.addColorMatrix();\r\n *\r\n * // To set the matrix values:\r\n * cmFilter.colorMatrix.sepia();\r\n * ```\r\n *\r\n * @class ColorMatrix\r\n * @extends Phaser.Filters.Controller\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that owns this filter.\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The ColorMatrix Filter Controller.\r\rThis filter controller manages the color matrix effect for a Camera.\r\rThe color matrix effect is a visual technique that involves manipulating the colors of an image\ror scene using a mathematical matrix. This process can adjust hue, saturation, brightness, and contrast,\rallowing developers to create various stylistic appearances or mood settings within the game.\rCommon applications include simulating different lighting conditions, applying color filters,\ror achieving a specific visual style.\r\rA ColorMatrix effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\r\rconst cmFilter = camera.filters.internal.addColorMatrix();\rcamera.filters.external.addColorMatrix();\r\r// To set the matrix values:\rcmFilter.colorMatrix.sepia();\r```", "kind": "class", "name": "ColorMatrix", "augments": [ "Phaser.Filters.Controller" ], "memberof": "Phaser.Filters", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that owns this filter.", "name": "camera" } ], "scope": "static", "longname": "Phaser.Filters.ColorMatrix", "___id": "T000002R006461", "___s": true }, { "comment": "/**\r\n * The color matrix instance for this effect. Use this to apply\r\n * preset or custom color transformations such as sepia, grayscale,\r\n * saturation, brightness, hue rotation, and more.\r\n *\r\n * @name Phaser.Filters.ColorMatrix#colorMatrix\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The color matrix instance for this effect. Use this to apply\rpreset or custom color transformations such as sepia, grayscale,\rsaturation, brightness, hue rotation, and more.", "name": "colorMatrix", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "4.0.0", "memberof": "Phaser.Filters.ColorMatrix", "longname": "Phaser.Filters.ColorMatrix#colorMatrix", "scope": "instance", "kind": "member", "___id": "T000002R006465", "___s": true }, { "comment": "/**\r\n * Destroys this filter, releasing all references and resources.\r\n *\r\n * @method Phaser.Filters.ColorMatrix#destroy\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ColorMatrix.js", "lineno": 61, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Destroys this filter, releasing all references and resources.", "kind": "function", "name": "destroy", "since": "4.0.0", "memberof": "Phaser.Filters.ColorMatrix", "longname": "Phaser.Filters.ColorMatrix#destroy", "scope": "instance", "overrides": "Phaser.Filters.Controller#destroy", "___id": "T000002R006467", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The CombineColorMatrix Filter controller.\r\n *\r\n * This filter combines color channels from two textures: a base input and a\r\n * secondary transfer texture. Each source is transformed independently by its\r\n * own `ColorMatrix` (`colorMatrixSelf` and `colorMatrixTransfer`), and the\r\n * results are then blended per-channel using configurable addition weights\r\n * (`additions`) and multiplication weights (`multiplications`). This makes it\r\n * suitable for a wide range of compositing effects, though its primary use is\r\n * alpha channel manipulation — for example, using a greyscale transfer texture\r\n * as a soft mask or applying a brightness-derived alpha to the base image.\r\n * Use `setupAlphaTransfer` to configure the matrices and weights for common\r\n * alpha-transfer patterns, or set the `colorMatrixSelf`, `colorMatrixTransfer`,\r\n * `additions`, and `multiplications` properties directly for custom effects.\r\n *\r\n * A CombineColorMatrix filter is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n * camera.filters.internal.addCombineColorMatrix();\r\n * camera.filters.external.addCombineColorMatrix();\r\n * ```\r\n *\r\n * @class CombineColorMatrix\r\n * @extends Phaser.Filters.Controller\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that owns this filter.\r\n * @param {string | Phaser.Textures.Texture} [texture='__WHITE'] - The texture or texture key to use for the transfer texture.\r\n */", "meta": { "filename": "CombineColorMatrix.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The CombineColorMatrix Filter controller.\r\rThis filter combines color channels from two textures: a base input and a\rsecondary transfer texture. Each source is transformed independently by its\rown `ColorMatrix` (`colorMatrixSelf` and `colorMatrixTransfer`), and the\rresults are then blended per-channel using configurable addition weights\r(`additions`) and multiplication weights (`multiplications`). This makes it\rsuitable for a wide range of compositing effects, though its primary use is\ralpha channel manipulation — for example, using a greyscale transfer texture\ras a soft mask or applying a brightness-derived alpha to the base image.\rUse `setupAlphaTransfer` to configure the matrices and weights for common\ralpha-transfer patterns, or set the `colorMatrixSelf`, `colorMatrixTransfer`,\r`additions`, and `multiplications` properties directly for custom effects.\r\rA CombineColorMatrix filter is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\rcamera.filters.internal.addCombineColorMatrix();\rcamera.filters.external.addCombineColorMatrix();\r```", "kind": "class", "name": "CombineColorMatrix", "augments": [ "Phaser.Filters.Controller" ], "memberof": "Phaser.Filters", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "defaultvalue": "'__WHITE'", "description": "The texture or texture key to use for the transfer texture.", "name": "texture" } ], "scope": "static", "longname": "Phaser.Filters.CombineColorMatrix", "___id": "T000002R006474", "___s": true }, { "comment": "/**\r\n * The transfer texture used to provide extra channels.\r\n *\r\n * @name Phaser.Filters.CombineColorMatrix#glTexture\r\n * @type {Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "CombineColorMatrix.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The transfer texture used to provide extra channels.", "name": "glTexture", "type": { "names": [ "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" } }, "since": "4.0.0", "memberof": "Phaser.Filters.CombineColorMatrix", "longname": "Phaser.Filters.CombineColorMatrix#glTexture", "scope": "instance", "kind": "member", "___id": "T000002R006478", "___s": true }, { "comment": "/**\r\n * The color matrix which contributes values from the base input.\r\n *\r\n * @name Phaser.Filters.CombineColorMatrix#colorMatrixSelf\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "CombineColorMatrix.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The color matrix which contributes values from the base input.", "name": "colorMatrixSelf", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "4.0.0", "memberof": "Phaser.Filters.CombineColorMatrix", "longname": "Phaser.Filters.CombineColorMatrix#colorMatrixSelf", "scope": "instance", "kind": "member", "___id": "T000002R006480", "___s": true }, { "comment": "/**\r\n * The color matrix which contributes values from the transfer texture.\r\n *\r\n * @name Phaser.Filters.CombineColorMatrix#colorMatrixTransfer\r\n * @type {Phaser.Display.ColorMatrix}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "CombineColorMatrix.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The color matrix which contributes values from the transfer texture.", "name": "colorMatrixTransfer", "type": { "names": [ "Phaser.Display.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorMatrix" } }, "since": "4.0.0", "memberof": "Phaser.Filters.CombineColorMatrix", "longname": "Phaser.Filters.CombineColorMatrix#colorMatrixTransfer", "scope": "instance", "kind": "member", "___id": "T000002R006482", "___s": true }, { "comment": "/**\r\n * Weight of addition for each channel (R, G, B, A).\r\n * The final output includes values from the self and transfer matrices\r\n * added together; those values are multiplied by this array.\r\n * So values of 1 are kept, while values of 0 are discarded.\r\n *\r\n * By default, RGB values are added together in the final output.\r\n *\r\n * @name Phaser.Filters.CombineColorMatrix#additions\r\n * @type {number[]}\r\n * @since 4.0.0\r\n * @default [ 1, 1, 1, 0 ]\r\n */", "meta": { "filename": "CombineColorMatrix.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Weight of addition for each channel (R, G, B, A).\rThe final output includes values from the self and transfer matrices\radded together; those values are multiplied by this array.\rSo values of 1 are kept, while values of 0 are discarded.\r\rBy default, RGB values are added together in the final output.", "name": "additions", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "defaultvalue": "[ 1, 1, 1, 0 ]", "memberof": "Phaser.Filters.CombineColorMatrix", "longname": "Phaser.Filters.CombineColorMatrix#additions", "scope": "instance", "kind": "member", "___id": "T000002R006484", "___s": true }, { "comment": "/**\r\n * Weight of multiplication for each channel (R, G, B, A).\r\n * The final output includes values from the self and transfer matrices\r\n * multiplied together; those values are multiplied by this array.\r\n * So values of 1 are kept, while values of 0 are discarded.\r\n *\r\n * By default, alpha values are multiplied together in the final output.\r\n *\r\n * @name Phaser.Filters.CombineColorMatrix#multiplications\r\n * @type {number[]}\r\n * @since 4.0.0\r\n * @default [ 0, 0, 0, 1 ]\r\n */", "meta": { "filename": "CombineColorMatrix.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Weight of multiplication for each channel (R, G, B, A).\rThe final output includes values from the self and transfer matrices\rmultiplied together; those values are multiplied by this array.\rSo values of 1 are kept, while values of 0 are discarded.\r\rBy default, alpha values are multiplied together in the final output.", "name": "multiplications", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "defaultvalue": "[ 0, 0, 0, 1 ]", "memberof": "Phaser.Filters.CombineColorMatrix", "longname": "Phaser.Filters.CombineColorMatrix#multiplications", "scope": "instance", "kind": "member", "___id": "T000002R006486", "___s": true }, { "comment": "/**\r\n * Set the transfer texture. This is used as an extra channel source,\r\n * transferring its data into the filtered image.\r\n *\r\n * @method Phaser.Filters.CombineColorMatrix#setTexture\r\n * @since 4.0.0\r\n * @param {string | Phaser.Textures.Texture} texture - The texture or texture key to use for the transfer texture.\r\n *\r\n * @return {this} This filter instance.\r\n */", "meta": { "filename": "CombineColorMatrix.js", "lineno": 110, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Set the transfer texture. This is used as an extra channel source,\rtransferring its data into the filtered image.", "kind": "function", "name": "setTexture", "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The texture or texture key to use for the transfer texture.", "name": "texture" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This filter instance." } ], "memberof": "Phaser.Filters.CombineColorMatrix", "longname": "Phaser.Filters.CombineColorMatrix#setTexture", "scope": "instance", "___id": "T000002R006488", "___s": true }, { "comment": "/**\r\n * Resets both color matrices and the `additions` and `multiplications`\r\n * weighting arrays, then applies a preset configuration for alpha transfer\r\n * — a common use case for this filter. In the preset, RGB channels are\r\n * combined by addition and the alpha channel is combined by multiplication.\r\n * The boolean parameters control which color and brightness-to-alpha\r\n * transformations are applied to each source before blending.\r\n *\r\n * @example\r\n * // Use just the base image, with unified alpha, like Mask.\r\n * myFilter.setupAlphaTransfer(true, false);\r\n *\r\n * @example\r\n * // Use just the transfer image, with unified alpha,\r\n * // where the base alpha is derived from inverted base brightness.\r\n * myFilter.setupAlphaTransfer(false, true, false, false, true);\r\n *\r\n * @method Phaser.Filters.CombineColorMatrix#setupAlphaTransfer\r\n * @since 4.0.0\r\n * @param {boolean} [colorSelf] - Whether to keep color from the base image.\r\n * @param {boolean} [colorTransfer] - Whether to keep color from the transfer texture.\r\n * @param {boolean} [brightnessToAlphaSelf] - Whether to determine the base alpha from the base brightness.\r\n * @param {boolean} [brightnessToAlphaTransfer] - Whether to determine the transfer alpha from the transfer brightness.\r\n * @param {boolean} [brightnessToAlphaInverseSelf] - Whether to determine the base alpha from the base brightness, inverted. This overrides `brightnessToAlphaSelf`.\r\n * @param {boolean} [brightnessToAlphaInverseTransfer] - Whether to determine the transfer alpha from the transfer brightness, inverted. This overrides `brightnessToAlphaTransfer`.\r\n *\r\n * @return {this} This filter instance.\r\n */", "meta": { "filename": "CombineColorMatrix.js", "lineno": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Resets both color matrices and the `additions` and `multiplications`\rweighting arrays, then applies a preset configuration for alpha transfer\r— a common use case for this filter. In the preset, RGB channels are\rcombined by addition and the alpha channel is combined by multiplication.\rThe boolean parameters control which color and brightness-to-alpha\rtransformations are applied to each source before blending.", "examples": [ "// Use just the base image, with unified alpha, like Mask.\rmyFilter.setupAlphaTransfer(true, false);", "// Use just the transfer image, with unified alpha,\r// where the base alpha is derived from inverted base brightness.\rmyFilter.setupAlphaTransfer(false, true, false, false, true);" ], "kind": "function", "name": "setupAlphaTransfer", "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to keep color from the base image.", "name": "colorSelf" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to keep color from the transfer texture.", "name": "colorTransfer" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to determine the base alpha from the base brightness.", "name": "brightnessToAlphaSelf" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to determine the transfer alpha from the transfer brightness.", "name": "brightnessToAlphaTransfer" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to determine the base alpha from the base brightness, inverted. This overrides `brightnessToAlphaSelf`.", "name": "brightnessToAlphaInverseSelf" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to determine the transfer alpha from the transfer brightness, inverted. This overrides `brightnessToAlphaTransfer`.", "name": "brightnessToAlphaInverseTransfer" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This filter instance." } ], "memberof": "Phaser.Filters.CombineColorMatrix", "longname": "Phaser.Filters.CombineColorMatrix#setupAlphaTransfer", "scope": "instance", "___id": "T000002R006492", "___s": true }, { "comment": "/**\r\n * Destroys this filter, releasing all references and resources.\r\n *\r\n * @method Phaser.Filters.CombineColorMatrix#destroy\r\n * @since 4.0.0\r\n */", "meta": { "filename": "CombineColorMatrix.js", "lineno": 178, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Destroys this filter, releasing all references and resources.", "kind": "function", "name": "destroy", "since": "4.0.0", "memberof": "Phaser.Filters.CombineColorMatrix", "longname": "Phaser.Filters.CombineColorMatrix#destroy", "scope": "instance", "overrides": "Phaser.Filters.Controller#destroy", "___id": "T000002R006498", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The base class for a post-processing filter effect applied to a Camera.\r\n *\r\n * Filters are visual effects rendered on top of a Camera's output, such as blur, glow, or color grading.\r\n * Each filter is managed by a Controller, which holds its configuration and provides padding information to the renderer.\r\n *\r\n * You should not normally create an instance of this class directly, but instead use one of the built-in filters that extend it,\r\n * such as those found in the `Phaser.Filters` namespace.\r\n *\r\n * You should not use a Controller for more than one Camera.\r\n * Create a new instance for each Camera that you wish to apply the filter to.\r\n * If you share Controllers, and destroy one owner, the Controller will be destroyed.\r\n *\r\n * @class Controller\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that owns this filter.\r\n * @param {string} renderNode - The ID of the RenderNode that this filter uses.\r\n */", "meta": { "filename": "Controller.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The base class for a post-processing filter effect applied to a Camera.\r\rFilters are visual effects rendered on top of a Camera's output, such as blur, glow, or color grading.\rEach filter is managed by a Controller, which holds its configuration and provides padding information to the renderer.\r\rYou should not normally create an instance of this class directly, but instead use one of the built-in filters that extend it,\rsuch as those found in the `Phaser.Filters` namespace.\r\rYou should not use a Controller for more than one Camera.\rCreate a new instance for each Camera that you wish to apply the filter to.\rIf you share Controllers, and destroy one owner, the Controller will be destroyed.", "kind": "class", "name": "Controller", "memberof": "Phaser.Filters", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The ID of the RenderNode that this filter uses.", "name": "renderNode" } ], "scope": "static", "longname": "Phaser.Filters.Controller", "___id": "T000002R006505", "___s": true }, { "comment": "/**\r\n * Toggle this boolean to enable or disable this filter,\r\n * without removing it from and re-adding it to the Camera's filter list.\r\n *\r\n * @name Phaser.Filters.Controller#active\r\n * @type {boolean}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 34, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Toggle this boolean to enable or disable this filter,\rwithout removing it from and re-adding it to the Camera's filter list.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Controller", "longname": "Phaser.Filters.Controller#active", "scope": "instance", "kind": "member", "___id": "T000002R006508", "___s": true }, { "comment": "/**\r\n * A reference to the Camera that owns this filter.\r\n *\r\n * @name Phaser.Filters.Controller#camera\r\n * @type {Phaser.Cameras.Scene2D.Camera}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "A reference to the Camera that owns this filter.", "name": "camera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Controller", "longname": "Phaser.Filters.Controller#camera", "scope": "instance", "kind": "member", "___id": "T000002R006510", "___s": true }, { "comment": "/**\r\n * The ID of the RenderNode that this filter uses.\r\n *\r\n * @name Phaser.Filters.Controller#renderNode\r\n * @type {string}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The ID of the RenderNode that this filter uses.", "name": "renderNode", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Controller", "longname": "Phaser.Filters.Controller#renderNode", "scope": "instance", "kind": "member", "___id": "T000002R006512", "___s": true }, { "comment": "/**\r\n * Padding override. This is on by default. If this is set,\r\n * the filter will use this padding instead of calculating it.\r\n * Prefer using `setPaddingOverride` instead of modifying this directly.\r\n *\r\n * @name Phaser.Filters.Controller#paddingOverride\r\n * @type {Phaser.Geom.Rectangle}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Padding override. This is on by default. If this is set,\rthe filter will use this padding instead of calculating it.\rPrefer using `setPaddingOverride` instead of modifying this directly.", "name": "paddingOverride", "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Controller", "longname": "Phaser.Filters.Controller#paddingOverride", "scope": "instance", "kind": "member", "___id": "T000002R006514", "___s": true }, { "comment": "/**\r\n * The padding currently being used by this filter.\r\n * This is read during rendering via `getPadding`, and may be updated by subclass implementations.\r\n * It is necessary for filters being used in an external list.\r\n * You should not modify this value directly.\r\n *\r\n * @name Phaser.Filters.Controller#currentPadding\r\n * @type {Phaser.Geom.Rectangle}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The padding currently being used by this filter.\rThis is read during rendering via `getPadding`, and may be updated by subclass implementations.\rIt is necessary for filters being used in an external list.\rYou should not modify this value directly.", "name": "currentPadding", "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Controller", "longname": "Phaser.Filters.Controller#currentPadding", "scope": "instance", "kind": "member", "___id": "T000002R006516", "___s": true }, { "comment": "/**\r\n * If `true`, this filter will be permitted to draw to the base texture.\r\n * This can be unwanted if, for example, the filter doesn't actually\r\n * draw anything.\r\n *\r\n * This is an internal flag used by the renderer.\r\n * You should not modify this value directly.\r\n *\r\n * @name Phaser.Filters.Controller#allowBaseDraw\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default true\r\n * @readonly\r\n */", "meta": { "filename": "Controller.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "If `true`, this filter will be permitted to draw to the base texture.\rThis can be unwanted if, for example, the filter doesn't actually\rdraw anything.\r\rThis is an internal flag used by the renderer.\rYou should not modify this value directly.", "name": "allowBaseDraw", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "true", "readonly": true, "memberof": "Phaser.Filters.Controller", "longname": "Phaser.Filters.Controller#allowBaseDraw", "scope": "instance", "kind": "member", "___id": "T000002R006518", "___s": true }, { "comment": "/**\r\n * Whether this filter controller will be destroyed when the FilterList\r\n * that owns it is destroyed. If you enable this, you must ensure that\r\n * you clean up the filter controller at an appropriate time.\r\n * This allows you to reuse a controller for multiple objects;\r\n * this is not recommended unless you know what you're doing.\r\n * It tends to work best with external filters.\r\n *\r\n * @name Phaser.Filters.Controller#ignoreDestroy\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default false\r\n */", "meta": { "filename": "Controller.js", "lineno": 101, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Whether this filter controller will be destroyed when the FilterList\rthat owns it is destroyed. If you enable this, you must ensure that\ryou clean up the filter controller at an appropriate time.\rThis allows you to reuse a controller for multiple objects;\rthis is not recommended unless you know what you're doing.\rIt tends to work best with external filters.", "name": "ignoreDestroy", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "false", "memberof": "Phaser.Filters.Controller", "longname": "Phaser.Filters.Controller#ignoreDestroy", "scope": "instance", "kind": "member", "___id": "T000002R006520", "___s": true }, { "comment": "/**\r\n * Returns the raw padding required for this filter.\r\n * This is typically not what you want to call; use `getPaddingCeil` instead.\r\n * Values from this method are not rounded, which can cause quality loss.\r\n *\r\n * Override this method when creating a Filter that requires extra room,\r\n * e.g. a blur or glow effect.\r\n *\r\n * @method Phaser.Filters.Controller#getPadding\r\n * @since 4.0.0\r\n * @return {Phaser.Geom.Rectangle} The padding required by this filter.\r\n */", "meta": { "filename": "Controller.js", "lineno": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Returns the raw padding required for this filter.\rThis is typically not what you want to call; use `getPaddingCeil` instead.\rValues from this method are not rounded, which can cause quality loss.\r\rOverride this method when creating a Filter that requires extra room,\re.g. a blur or glow effect.", "kind": "function", "name": "getPadding", "since": "4.0.0", "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The padding required by this filter." } ], "memberof": "Phaser.Filters.Controller", "longname": "Phaser.Filters.Controller#getPadding", "scope": "instance", "___id": "T000002R006522", "___s": true }, { "comment": "/**\r\n * Returns the rounded padding required for this filter.\r\n *\r\n * Most filters don't need extra padding,\r\n * but some may sample beyond the texture boundaries, such as a blur or glow effect.\r\n *\r\n * The bounds are encoded as a Rectangle.\r\n * To enlarge the bounds, the top and left values should be negative,\r\n * and the bottom and right values should be positive.\r\n *\r\n * This method calls `getPadding()` to get the raw padding values,\r\n * and uses `Math.ceil()` to set the values of `paddingOverride`\r\n * and `currentPadding`.\r\n *\r\n * @method Phaser.Filters.Controller#getPaddingCeil\r\n * @since 4.1.0\r\n * @returns {Phaser.Geom.Rectangle} The rounded padding required by this filter.\r\n */", "meta": { "filename": "Controller.js", "lineno": 134, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Returns the rounded padding required for this filter.\r\rMost filters don't need extra padding,\rbut some may sample beyond the texture boundaries, such as a blur or glow effect.\r\rThe bounds are encoded as a Rectangle.\rTo enlarge the bounds, the top and left values should be negative,\rand the bottom and right values should be positive.\r\rThis method calls `getPadding()` to get the raw padding values,\rand uses `Math.ceil()` to set the values of `paddingOverride`\rand `currentPadding`.", "kind": "function", "name": "getPaddingCeil", "since": "4.1.0", "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The rounded padding required by this filter." } ], "memberof": "Phaser.Filters.Controller", "longname": "Phaser.Filters.Controller#getPaddingCeil", "scope": "instance", "___id": "T000002R006524", "___s": true }, { "comment": "/**\r\n * Sets the padding override.\r\n * If this is set, the filter will use this padding instead of calculating it.\r\n * Call `setPaddingOverride(null)` to clear the override.\r\n * Call `setPaddingOverride()` to set the padding to 0.\r\n *\r\n * @method Phaser.Filters.Controller#setPaddingOverride\r\n * @since 4.0.0\r\n * @param {number|null} [left=0] - The left padding.\r\n * @param {number} [top=0] - The top padding.\r\n * @param {number} [right=0] - The right padding.\r\n * @param {number} [bottom=0] - The bottom padding.\r\n */", "meta": { "filename": "Controller.js", "lineno": 170, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets the padding override.\rIf this is set, the filter will use this padding instead of calculating it.\rCall `setPaddingOverride(null)` to clear the override.\rCall `setPaddingOverride()` to set the padding to 0.", "kind": "function", "name": "setPaddingOverride", "since": "4.0.0", "params": [ { "type": { "names": [ "number", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NullLiteral" } ] } }, "optional": true, "defaultvalue": 0, "description": "The left padding.", "name": "left" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The top padding.", "name": "top" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The right padding.", "name": "right" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The bottom padding.", "name": "bottom" } ], "memberof": "Phaser.Filters.Controller", "longname": "Phaser.Filters.Controller#setPaddingOverride", "scope": "instance", "___id": "T000002R006528", "___s": true }, { "comment": "/**\r\n * Sets the active state of this filter.\r\n *\r\n * A disabled filter will not be used.\r\n *\r\n * @method Phaser.Filters.Controller#setActive\r\n * @since 4.0.0\r\n * @param {boolean} value - `true` to enable this filter, or `false` to disable it.\r\n * @return {this} This filter instance.\r\n */", "meta": { "filename": "Controller.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets the active state of this filter.\r\rA disabled filter will not be used.", "kind": "function", "name": "setActive", "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to enable this filter, or `false` to disable it.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This filter instance." } ], "memberof": "Phaser.Filters.Controller", "longname": "Phaser.Filters.Controller#setActive", "scope": "instance", "___id": "T000002R006536", "___s": true }, { "comment": "/**\r\n * Destroys this Controller and nulls any references it holds.\r\n *\r\n * @method Phaser.Filters.Controller#destroy\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Controller.js", "lineno": 218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Destroys this Controller and nulls any references it holds.", "kind": "function", "name": "destroy", "since": "4.0.0", "memberof": "Phaser.Filters.Controller", "longname": "Phaser.Filters.Controller#destroy", "scope": "instance", "___id": "T000002R006539", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Displacement Filter Controller.\r\n *\r\n * This Filter controller manages the displacement effect.\r\n *\r\n * The displacement effect is a visual technique that alters the position of pixels in an image\r\n * or texture based on the values of a displacement map. This effect is used to create the illusion\r\n * of depth, surface irregularities, or distortion in otherwise flat elements. It can be applied to\r\n * characters, objects, or backgrounds to enhance realism, convey movement, or achieve various\r\n * stylistic appearances.\r\n *\r\n * This effect samples across an area. To avoid missing data at the edges,\r\n * use `controller.setPaddingOverride(null)` to automatically pad game objects,\r\n * or `camera.getPaddingWrapper(x)` to enlarge a camera.\r\n *\r\n * A Displacement effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n *\r\n * camera.filters.internal.addDisplacement();\r\n * camera.filters.external.addDisplacement();\r\n * ```\r\n *\r\n * @class Displacement\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @extends Phaser.Filters.Controller\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that owns this filter.\r\n * @param {string} [texture='__WHITE'] - The unique string-based key of the texture to use for displacement, which must exist in the Texture Manager.\r\n * @param {number} [x=0.005] - The amount of horizontal displacement to apply. A very small float number, such as 0.005.\r\n * @param {number} [y=0.005] - The amount of vertical displacement to apply. A very small float number, such as 0.005.\r\n */", "meta": { "filename": "Displacement.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Displacement Filter Controller.\r\rThis Filter controller manages the displacement effect.\r\rThe displacement effect is a visual technique that alters the position of pixels in an image\ror texture based on the values of a displacement map. This effect is used to create the illusion\rof depth, surface irregularities, or distortion in otherwise flat elements. It can be applied to\rcharacters, objects, or backgrounds to enhance realism, convey movement, or achieve various\rstylistic appearances.\r\rThis effect samples across an area. To avoid missing data at the edges,\ruse `controller.setPaddingOverride(null)` to automatically pad game objects,\ror `camera.getPaddingWrapper(x)` to enlarge a camera.\r\rA Displacement effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\r\rcamera.filters.internal.addDisplacement();\rcamera.filters.external.addDisplacement();\r```", "kind": "class", "name": "Displacement", "memberof": "Phaser.Filters", "since": "4.0.0", "augments": [ "Phaser.Filters.Controller" ], "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'__WHITE'", "description": "The unique string-based key of the texture to use for displacement, which must exist in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.005, "description": "The amount of horizontal displacement to apply. A very small float number, such as 0.005.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.005, "description": "The amount of vertical displacement to apply. A very small float number, such as 0.005.", "name": "y" } ], "scope": "static", "longname": "Phaser.Filters.Displacement", "___id": "T000002R006547", "___s": true }, { "comment": "/**\r\n * The amount of horizontal displacement to apply.\r\n * The maximum horizontal displacement in pixels is `x`\r\n * multiplied by 0.5 times the width of the camera rendering the filter.\r\n *\r\n * @name Phaser.Filters.Displacement#x\r\n * @type {number}\r\n * @since 4.0.0\r\n * @default 0.005\r\n */", "meta": { "filename": "Displacement.js", "lineno": 56, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The amount of horizontal displacement to apply.\rThe maximum horizontal displacement in pixels is `x`\rmultiplied by 0.5 times the width of the camera rendering the filter.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "defaultvalue": "0.005", "memberof": "Phaser.Filters.Displacement", "longname": "Phaser.Filters.Displacement#x", "scope": "instance", "kind": "member", "___id": "T000002R006554", "___s": true }, { "comment": "/**\r\n * The amount of vertical displacement to apply.\r\n * The maximum vertical displacement in pixels is `y`\r\n * multiplied by 0.5 times the height of the camera rendering the filter.\r\n *\r\n * @name Phaser.Filters.Displacement#y\r\n * @type {number}\r\n * @since 4.0.0\r\n * @default 0.005\r\n */", "meta": { "filename": "Displacement.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The amount of vertical displacement to apply.\rThe maximum vertical displacement in pixels is `y`\rmultiplied by 0.5 times the height of the camera rendering the filter.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "defaultvalue": "0.005", "memberof": "Phaser.Filters.Displacement", "longname": "Phaser.Filters.Displacement#y", "scope": "instance", "kind": "member", "___id": "T000002R006556", "___s": true }, { "comment": "/**\r\n * The underlying texture used for displacement.\r\n *\r\n * @name Phaser.Filters.Displacement#texture\r\n * @type {Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Displacement.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The underlying texture used for displacement.", "name": "texture", "type": { "names": [ "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Displacement", "longname": "Phaser.Filters.Displacement#texture", "scope": "instance", "kind": "member", "___id": "T000002R006558", "___s": true }, { "comment": "/**\r\n * Sets the Texture to be used for the displacement effect.\r\n *\r\n * You can only use a whole texture, not a frame from a texture atlas or sprite sheet.\r\n *\r\n * @method Phaser.Filters.Displacement#setTexture\r\n * @since 4.0.0\r\n * @param {string} [texture='__WHITE'] - The unique string-based key of the texture to use for displacement, which must exist in the Texture Manager.\r\n * @return {this} This Filter Controller.\r\n */", "meta": { "filename": "Displacement.js", "lineno": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets the Texture to be used for the displacement effect.\r\rYou can only use a whole texture, not a frame from a texture atlas or sprite sheet.", "kind": "function", "name": "setTexture", "since": "4.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'__WHITE'", "description": "The unique string-based key of the texture to use for displacement, which must exist in the Texture Manager.", "name": "texture" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Filter Controller." } ], "memberof": "Phaser.Filters.Displacement", "longname": "Phaser.Filters.Displacement#setTexture", "scope": "instance", "___id": "T000002R006560", "___s": true }, { "comment": "/**\r\n * Returns the amount of extra padding, in pixels, that this filter requires when rendering.\r\n * The padding accounts for the displacement effect extending beyond the original bounds\r\n * of the Camera's rendered output.\r\n *\r\n * @method Phaser.Filters.Displacement#getPadding\r\n * @since 4.0.0\r\n *\r\n * @return {Phaser.Geom.Rectangle} The padding Rectangle.\r\n */", "meta": { "filename": "Displacement.js", "lineno": 114, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Returns the amount of extra padding, in pixels, that this filter requires when rendering.\rThe padding accounts for the displacement effect extending beyond the original bounds\rof the Camera's rendered output.", "kind": "function", "name": "getPadding", "since": "4.0.0", "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The padding Rectangle." } ], "memberof": "Phaser.Filters.Displacement", "longname": "Phaser.Filters.Displacement#getPadding", "scope": "instance", "overrides": "Phaser.Filters.Controller#getPadding", "___id": "T000002R006564", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Glow Filter controller.\r\n *\r\n * This filter controller manages the glow effect for a Camera.\r\n *\r\n * The glow effect is a visual technique that creates a soft, luminous halo around game objects,\r\n * characters, or UI elements. This effect is used to emphasize importance, enhance visual appeal,\r\n * or convey a sense of energy, magic, or otherworldly presence. The effect can also be set on\r\n * the inside of edges. The color and strength of the glow can be modified.\r\n *\r\n * This effect samples across an area. To avoid missing data at the edges,\r\n * use `controller.setPaddingOverride(null)` to automatically pad game objects,\r\n * or `camera.getPaddingWrapper(x)` to enlarge a camera.\r\n *\r\n * A Glow effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n *\r\n * camera.filters.internal.addGlow();\r\n * camera.filters.external.addGlow();\r\n * ```\r\n *\r\n * Conversion note from Phaser 3:\r\n * - The shader now uses stochastic sampling instead of sampling along straight lines. This improves quality, especially around corners.\r\n * - `scale` has been added to the parameter list, before `knockout`.\r\n * - `quality` is no longer a fraction, but an integer value. The default has changed from 0.1 to 10. This is not a linear conversion, because of the quality improvement. Judge the quality by eye and adjust the value accordingly.\r\n *\r\n * @class Glow\r\n * @extends Phaser.Filters.Controller\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that owns this filter.\r\n * @param {number} [color=0xffffff] - The color of the glow effect as a number value.\r\n * @param {number} [outerStrength=4] - The strength of the glow outward from the edge of textures.\r\n * @param {number} [innerStrength=0] - The strength of the glow inward from the edge of textures.\r\n * @param {number} [scale=1] - The scale of the glow effect. This multiplies the fixed distance.\r\n * @param {boolean} [knockout=false] - If `true` only the glow is drawn, not the texture itself.\r\n * @param {number} [quality=10] - The quality of the glow effect. This cannot be changed after the filter has been created.\r\n * @param {number} [distance=10] - The distance of the glow effect. This cannot be changed after the filter has been created.\r\n */", "meta": { "filename": "Glow.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Glow Filter controller.\r\rThis filter controller manages the glow effect for a Camera.\r\rThe glow effect is a visual technique that creates a soft, luminous halo around game objects,\rcharacters, or UI elements. This effect is used to emphasize importance, enhance visual appeal,\ror convey a sense of energy, magic, or otherworldly presence. The effect can also be set on\rthe inside of edges. The color and strength of the glow can be modified.\r\rThis effect samples across an area. To avoid missing data at the edges,\ruse `controller.setPaddingOverride(null)` to automatically pad game objects,\ror `camera.getPaddingWrapper(x)` to enlarge a camera.\r\rA Glow effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\r\rcamera.filters.internal.addGlow();\rcamera.filters.external.addGlow();\r```\r\rConversion note from Phaser 3:\r- The shader now uses stochastic sampling instead of sampling along straight lines. This improves quality, especially around corners.\r- `scale` has been added to the parameter list, before `knockout`.\r- `quality` is no longer a fraction, but an integer value. The default has changed from 0.1 to 10. This is not a linear conversion, because of the quality improvement. Judge the quality by eye and adjust the value accordingly.", "kind": "class", "name": "Glow", "augments": [ "Phaser.Filters.Controller" ], "memberof": "Phaser.Filters", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color of the glow effect as a number value.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "The strength of the glow outward from the edge of textures.", "name": "outerStrength" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The strength of the glow inward from the edge of textures.", "name": "innerStrength" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The scale of the glow effect. This multiplies the fixed distance.", "name": "scale" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true` only the glow is drawn, not the texture itself.", "name": "knockout" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The quality of the glow effect. This cannot be changed after the filter has been created.", "name": "quality" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The distance of the glow effect. This cannot be changed after the filter has been created.", "name": "distance" } ], "scope": "static", "longname": "Phaser.Filters.Glow", "___id": "T000002R006573", "___s": true }, { "comment": "/**\r\n * The strength of the glow outward from the edge of textures.\r\n *\r\n * @name Phaser.Filters.Glow#outerStrength\r\n * @type {number}\r\n * @since 4.0.0\r\n * @default 4\r\n */", "meta": { "filename": "Glow.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The strength of the glow outward from the edge of textures.", "name": "outerStrength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "defaultvalue": "4", "memberof": "Phaser.Filters.Glow", "longname": "Phaser.Filters.Glow#outerStrength", "scope": "instance", "kind": "member", "___id": "T000002R006583", "___s": true }, { "comment": "/**\r\n * The strength of the glow inward from the edge of textures.\r\n *\r\n * @name Phaser.Filters.Glow#innerStrength\r\n * @type {number}\r\n * @since 4.0.0\r\n * @default 0\r\n */", "meta": { "filename": "Glow.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The strength of the glow inward from the edge of textures.", "name": "innerStrength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "defaultvalue": "0", "memberof": "Phaser.Filters.Glow", "longname": "Phaser.Filters.Glow#innerStrength", "scope": "instance", "kind": "member", "___id": "T000002R006585", "___s": true }, { "comment": "/**\r\n * The scale of the glow effect. This multiplies the fixed distance.\r\n *\r\n * @name Phaser.Filters.Glow#scale\r\n * @type {number}\r\n * @since 4.0.0\r\n * @default 1\r\n */", "meta": { "filename": "Glow.js", "lineno": 87, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The scale of the glow effect. This multiplies the fixed distance.", "name": "scale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "defaultvalue": "1", "memberof": "Phaser.Filters.Glow", "longname": "Phaser.Filters.Glow#scale", "scope": "instance", "kind": "member", "___id": "T000002R006587", "___s": true }, { "comment": "/**\r\n * If `true` only the glow is drawn, not the texture itself.\r\n *\r\n * @name Phaser.Filters.Glow#knockout\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default false\r\n */", "meta": { "filename": "Glow.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "If `true` only the glow is drawn, not the texture itself.", "name": "knockout", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "false", "memberof": "Phaser.Filters.Glow", "longname": "Phaser.Filters.Glow#knockout", "scope": "instance", "kind": "member", "___id": "T000002R006589", "___s": true }, { "comment": "/**\r\n * The internal RGBA color of the glow, stored as four normalized\r\n * floating-point values (red, green, blue, alpha) in the range 0 to 1,\r\n * for direct use by the WebGL renderer. To set the glow color, use the\r\n * `color` property instead.\r\n *\r\n * @name Phaser.Filters.Glow#glcolor\r\n * @type {number[]}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Glow.js", "lineno": 138, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The internal RGBA color of the glow, stored as four normalized\rfloating-point values (red, green, blue, alpha) in the range 0 to 1,\rfor direct use by the WebGL renderer. To set the glow color, use the\r`color` property instead.", "name": "glcolor", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "memberof": "Phaser.Filters.Glow", "longname": "Phaser.Filters.Glow#glcolor", "scope": "instance", "kind": "member", "___id": "T000002R006595", "___s": true }, { "comment": "/**\r\n * The color of the glow effect, expressed as a hex color value in the\r\n * format 0xRRGGBB. Getting this value converts it from the internal\r\n * normalized `glcolor` array. Setting it updates `glcolor` for use by\r\n * the WebGL renderer.\r\n *\r\n * @name Phaser.Filters.Glow#color\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Glow.js", "lineno": 156, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The color of the glow effect, expressed as a hex color value in the\rformat 0xRRGGBB. Getting this value converts it from the internal\rnormalized `glcolor` array. Setting it updates `glcolor` for use by\rthe WebGL renderer.", "name": "color", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Glow", "longname": "Phaser.Filters.Glow#color", "scope": "instance", "kind": "member", "___id": "T000002R006598", "___s": true }, { "comment": "/**\r\n * The distance of the glow effect.\r\n * This cannot be changed after the filter has been created.\r\n * This controls the distance of the glow effect, in pixels.\r\n * Integer values only.\r\n *\r\n * @name Phaser.Filters.Glow#distance\r\n * @type {number}\r\n * @since 4.0.0\r\n * @readonly\r\n */", "meta": { "filename": "Glow.js", "lineno": 186, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The distance of the glow effect.\rThis cannot be changed after the filter has been created.\rThis controls the distance of the glow effect, in pixels.\rInteger values only.", "name": "distance", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "readonly": true, "memberof": "Phaser.Filters.Glow", "longname": "Phaser.Filters.Glow#distance", "scope": "instance", "kind": "member", "___id": "T000002R006607", "___s": true }, { "comment": "/**\r\n * The quality of the glow effect.\r\n * This cannot be changed after the filter has been created.\r\n * This controls the number of samples that the glow effect will run for.\r\n * A higher number is higher quality, but slower to process.\r\n * Integer values only.\r\n *\r\n * @name Phaser.Filters.Glow#quality\r\n * @type {number}\r\n * @since 4.0.0\r\n * @readonly\r\n */", "meta": { "filename": "Glow.js", "lineno": 206, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The quality of the glow effect.\rThis cannot be changed after the filter has been created.\rThis controls the number of samples that the glow effect will run for.\rA higher number is higher quality, but slower to process.\rInteger values only.", "name": "quality", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "readonly": true, "memberof": "Phaser.Filters.Glow", "longname": "Phaser.Filters.Glow#quality", "scope": "instance", "kind": "member", "___id": "T000002R006610", "___s": true }, { "comment": "/**\r\n * Returns the amount of extra padding, in pixels, that this filter requires when rendering.\r\n * The padding accounts for the glow effect extending beyond the original bounds\r\n * of the Camera's rendered output.\r\n *\r\n * @method Phaser.Filters.Glow#getPadding\r\n * @since 4.0.0\r\n *\r\n * @return {Phaser.Geom.Rectangle} The padding Rectangle.\r\n */", "meta": { "filename": "Glow.js", "lineno": 226, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Returns the amount of extra padding, in pixels, that this filter requires when rendering.\rThe padding accounts for the glow effect extending beyond the original bounds\rof the Camera's rendered output.", "kind": "function", "name": "getPadding", "since": "4.0.0", "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The padding Rectangle." } ], "memberof": "Phaser.Filters.Glow", "longname": "Phaser.Filters.Glow#getPadding", "scope": "instance", "overrides": "Phaser.Filters.Controller#getPadding", "___id": "T000002R006613", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The GradientMap Filter Controller.\r\n *\r\n * This controller manages the GradientMap effect for a Camera.\r\n *\r\n * GradientMap recolors an image using a ColorRamp.\r\n * The image is converted to a progress value at each point,\r\n * and that progress is evaluated as a color along the ramp.\r\n *\r\n * The progress value is normally the brightness of the image.\r\n * You can use the `colorFactor` and `color` properties to customize it.\r\n *\r\n * @example\r\n * const camera = this.cameras.main;\r\n * camera.filters.internal.addGradientMap(); // Basic effect.\r\n * camera.filters.external.addGradientMap({\r\n * colorFactor: [ -0.3, -0.6, -0.1, 0 ],\r\n * color: [ 0.3, 0.6, 0.1, 0 ]\r\n * }); // Invert brightness.\r\n *\r\n * @class GradientMap\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @extends Phaser.Filters.Controller\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that owns this filter.\r\n * @param {Phaser.Types.Filters.GradientMapConfig} [config] - The configuration object for the GradientMap effect.\r\n */", "meta": { "filename": "GradientMap.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The GradientMap Filter Controller.\r\rThis controller manages the GradientMap effect for a Camera.\r\rGradientMap recolors an image using a ColorRamp.\rThe image is converted to a progress value at each point,\rand that progress is evaluated as a color along the ramp.\r\rThe progress value is normally the brightness of the image.\rYou can use the `colorFactor` and `color` properties to customize it.", "examples": [ "const camera = this.cameras.main;\rcamera.filters.internal.addGradientMap(); // Basic effect.\rcamera.filters.external.addGradientMap({\r colorFactor: [ -0.3, -0.6, -0.1, 0 ],\r color: [ 0.3, 0.6, 0.1, 0 ]\r}); // Invert brightness." ], "kind": "class", "name": "GradientMap", "memberof": "Phaser.Filters", "since": "4.0.0", "augments": [ "Phaser.Filters.Controller" ], "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "Phaser.Types.Filters.GradientMapConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Filters.GradientMapConfig" } }, "optional": true, "description": "The configuration object for the GradientMap effect.", "name": "config" } ], "scope": "static", "longname": "Phaser.Filters.GradientMap", "___id": "T000002R006626", "___s": true }, { "comment": "/**\r\n * The ColorRamp used to recolor the image. Each pixel's brightness\r\n * (or custom progress value derived from `colorFactor` and `color`)\r\n * is looked up along this ramp to determine its output color.\r\n *\r\n * @name Phaser.Filters.GradientMap#ramp\r\n * @type {Phaser.Display.ColorRamp}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "GradientMap.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The ColorRamp used to recolor the image. Each pixel's brightness\r(or custom progress value derived from `colorFactor` and `color`)\ris looked up along this ramp to determine its output color.", "name": "ramp", "type": { "names": [ "Phaser.Display.ColorRamp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorRamp" } }, "since": "4.0.0", "memberof": "Phaser.Filters.GradientMap", "longname": "Phaser.Filters.GradientMap#ramp", "scope": "instance", "kind": "member", "___id": "T000002R006637", "___s": true }, { "comment": "/**\r\n * Whether to use Interleaved Gradient Noise to dither the ramp.\r\n * This can reduce banding, but the effect is easily lost if the image\r\n * is later transformed.\r\n *\r\n * @name Phaser.Filters.GradientMap#dither\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default false\r\n */", "meta": { "filename": "GradientMap.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Whether to use Interleaved Gradient Noise to dither the ramp.\rThis can reduce banding, but the effect is easily lost if the image\ris later transformed.", "name": "dither", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "false", "memberof": "Phaser.Filters.GradientMap", "longname": "Phaser.Filters.GradientMap#dither", "scope": "instance", "kind": "member", "___id": "T000002R006639", "___s": true }, { "comment": "/**\r\n * RGBA offset values added directly to the ramp progress after `colorFactor`\r\n * has been applied. Each element corresponds to a channel: red, green, blue,\r\n * and alpha. For example, setting a channel to `1` when its corresponding\r\n * `colorFactor` entry is `-1` effectively inverts that channel's contribution\r\n * to the progress value.\r\n *\r\n * @name Phaser.Filters.GradientMap#color\r\n * @type {number[]}\r\n * @since 4.0.0\r\n * @default [ 0, 0, 0, 0 ]\r\n */", "meta": { "filename": "GradientMap.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "RGBA offset values added directly to the ramp progress after `colorFactor`\rhas been applied. Each element corresponds to a channel: red, green, blue,\rand alpha. For example, setting a channel to `1` when its corresponding\r`colorFactor` entry is `-1` effectively inverts that channel's contribution\rto the progress value.", "name": "color", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "defaultvalue": "[ 0, 0, 0, 0 ]", "memberof": "Phaser.Filters.GradientMap", "longname": "Phaser.Filters.GradientMap#color", "scope": "instance", "kind": "member", "___id": "T000002R006641", "___s": true }, { "comment": "/**\r\n * RGBA multipliers applied to each channel of the source image to compute\r\n * the ramp progress value. The results are summed together. The defaults\r\n * `[ 0.3, 0.6, 0.1, 0 ]` approximate standard luminance weights, producing\r\n * a perceptually accurate grayscale progress. Keep the sum of factors equal\r\n * to 1 for a normalized result, or use negative values (paired with `color`\r\n * offsets) to invert a channel's contribution.\r\n *\r\n * @name Phaser.Filters.GradientMap#colorFactor\r\n * @type {number[]}\r\n * @since 4.0.0\r\n * @default [ 0.3, 0.6, 0.1, 0 ]\r\n */", "meta": { "filename": "GradientMap.js", "lineno": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "RGBA multipliers applied to each channel of the source image to compute\rthe ramp progress value. The results are summed together. The defaults\r`[ 0.3, 0.6, 0.1, 0 ]` approximate standard luminance weights, producing\ra perceptually accurate grayscale progress. Keep the sum of factors equal\rto 1 for a normalized result, or use negative values (paired with `color`\roffsets) to invert a channel's contribution.", "name": "colorFactor", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "defaultvalue": "[ 0.3, 0.6, 0.1, 0 ]", "memberof": "Phaser.Filters.GradientMap", "longname": "Phaser.Filters.GradientMap#colorFactor", "scope": "instance", "kind": "member", "___id": "T000002R006647", "___s": true }, { "comment": "/**\r\n * Whether the input should be unpremultiplied before computing progress.\r\n * This means that transparent colors are considered at full brightness.\r\n * It is usually desirable.\r\n *\r\n * @name Phaser.Filters.GradientMap#unpremultiply\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default true\r\n */", "meta": { "filename": "GradientMap.js", "lineno": 128, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Whether the input should be unpremultiplied before computing progress.\rThis means that transparent colors are considered at full brightness.\rIt is usually desirable.", "name": "unpremultiply", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "true", "memberof": "Phaser.Filters.GradientMap", "longname": "Phaser.Filters.GradientMap#unpremultiply", "scope": "instance", "kind": "member", "___id": "T000002R006653", "___s": true }, { "comment": "/**\r\n * The blend strength of the gradient map effect over the original image,\r\n * in the range 0 (no effect, original image fully visible) to 1 (full\r\n * gradient map effect, original image fully replaced).\r\n *\r\n * @name Phaser.Filters.GradientMap#alpha\r\n * @type {number}\r\n * @since 4.0.0\r\n * @default 1\r\n */", "meta": { "filename": "GradientMap.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The blend strength of the gradient map effect over the original image,\rin the range 0 (no effect, original image fully visible) to 1 (full\rgradient map effect, original image fully replaced).", "name": "alpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "defaultvalue": "1", "memberof": "Phaser.Filters.GradientMap", "longname": "Phaser.Filters.GradientMap#alpha", "scope": "instance", "kind": "member", "___id": "T000002R006655", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The ImageLight Filter Controller.\r\n *\r\n * This filter controller manages the ImageLight effect for a Camera.\r\n *\r\n * ImageLight is a filter for image based lighting (IBL).\r\n * It is used to simulate the lighting of an image\r\n * using an environment map and a normal map.\r\n *\r\n * The environment map is an image that describes the lighting of the scene.\r\n * This filter uses a single panorama image as the environment map.\r\n * The top of the image is the sky, the bottom is the ground,\r\n * and the X axis covers a full rotation.\r\n * This kind of image is distorted towards the top and bottom,\r\n * as the X axis is stretched wider and wider,\r\n * so be careful if you're creating your own environment maps.\r\n *\r\n * Cube maps are not supported by Phaser at the time of writing.\r\n *\r\n * The effect is basically a reflection of the environment at infinite range.\r\n * A sharp environment map will produce a sharp reflection,\r\n * while a blurry environment map will produce a diffuse reflection.\r\n * Use the PanoramaBlur filter to create correctly blurred environment maps.\r\n * Use the NormalTools filter to manipulate the normal map if necessary,\r\n * using a DynamicTexture to capture the output.\r\n *\r\n * An ImageLight effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n *\r\n * camera.filters.internal.addImageLight({ texture: 'lightmap' });\r\n * camera.filters.external.addImageLight({ texture: 'lightmap' });\r\n * ```\r\n *\r\n * @class ImageLight\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @extends Phaser.Filters.Controller\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that owns this filter.\r\n * @param {Phaser.Types.Filters.ImageLightConfig} [config] - The configuration object for the ImageLight effect.\r\n */", "meta": { "filename": "ImageLight.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The ImageLight Filter Controller.\r\rThis filter controller manages the ImageLight effect for a Camera.\r\rImageLight is a filter for image based lighting (IBL).\rIt is used to simulate the lighting of an image\rusing an environment map and a normal map.\r\rThe environment map is an image that describes the lighting of the scene.\rThis filter uses a single panorama image as the environment map.\rThe top of the image is the sky, the bottom is the ground,\rand the X axis covers a full rotation.\rThis kind of image is distorted towards the top and bottom,\ras the X axis is stretched wider and wider,\rso be careful if you're creating your own environment maps.\r\rCube maps are not supported by Phaser at the time of writing.\r\rThe effect is basically a reflection of the environment at infinite range.\rA sharp environment map will produce a sharp reflection,\rwhile a blurry environment map will produce a diffuse reflection.\rUse the PanoramaBlur filter to create correctly blurred environment maps.\rUse the NormalTools filter to manipulate the normal map if necessary,\rusing a DynamicTexture to capture the output.\r\rAn ImageLight effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\r\rcamera.filters.internal.addImageLight({ texture: 'lightmap' });\rcamera.filters.external.addImageLight({ texture: 'lightmap' });\r```", "kind": "class", "name": "ImageLight", "memberof": "Phaser.Filters", "since": "4.0.0", "augments": [ "Phaser.Filters.Controller" ], "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "Phaser.Types.Filters.ImageLightConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Filters.ImageLightConfig" } }, "optional": true, "description": "The configuration object for the ImageLight effect.", "name": "config" } ], "scope": "static", "longname": "Phaser.Filters.ImageLight", "___id": "T000002R006662", "___s": true }, { "comment": "/**\r\n * The underlying texture used for the ImageLight effect normal map.\r\n *\r\n * @name Phaser.Filters.ImageLight#normalGlTexture\r\n * @type {Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ImageLight.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The underlying texture used for the ImageLight effect normal map.", "name": "normalGlTexture", "type": { "names": [ "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" } }, "since": "4.0.0", "memberof": "Phaser.Filters.ImageLight", "longname": "Phaser.Filters.ImageLight#normalGlTexture", "scope": "instance", "kind": "member", "___id": "T000002R006666", "___s": true }, { "comment": "/**\r\n * The underlying texture used for the ImageLight effect environment map.\r\n *\r\n * @name Phaser.Filters.ImageLight#environmentGlTexture\r\n * @type {Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ImageLight.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The underlying texture used for the ImageLight effect environment map.", "name": "environmentGlTexture", "type": { "names": [ "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" } }, "since": "4.0.0", "memberof": "Phaser.Filters.ImageLight", "longname": "Phaser.Filters.ImageLight#environmentGlTexture", "scope": "instance", "kind": "member", "___id": "T000002R006668", "___s": true }, { "comment": "/**\r\n * The view matrix used for the ImageLight effect.\r\n * This controls the orientation of the environment map.\r\n * You should set this to reflect the perspective of the camera.\r\n *\r\n * @name Phaser.Filters.ImageLight#viewMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ImageLight.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The view matrix used for the ImageLight effect.\rThis controls the orientation of the environment map.\rYou should set this to reflect the perspective of the camera.", "name": "viewMatrix", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "4.0.0", "memberof": "Phaser.Filters.ImageLight", "longname": "Phaser.Filters.ImageLight#viewMatrix", "scope": "instance", "kind": "member", "___id": "T000002R006670", "___s": true }, { "comment": "/**\r\n * The initial rotation of the model in radians.\r\n * This will be overridden by the modelRotationSource if it is set.\r\n *\r\n * @name Phaser.Filters.ImageLight#modelRotation\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ImageLight.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The initial rotation of the model in radians.\rThis will be overridden by the modelRotationSource if it is set.", "name": "modelRotation", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.ImageLight", "longname": "Phaser.Filters.ImageLight#modelRotation", "scope": "instance", "kind": "member", "___id": "T000002R006672", "___s": true }, { "comment": "/**\r\n * The source of the model rotation, used when the filter renders.\r\n * If a function, it will be called to get the rotation.\r\n * If a GameObject, it will be used to get the rotation from the GameObject's world transform.\r\n * If null, the model rotation will be taken from the modelRotation property.\r\n *\r\n * @name Phaser.Filters.ImageLight#modelRotationSource\r\n * @type {Phaser.GameObjects.GameObject | Phaser.Types.Filters.ImageLightSourceCallback | null}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ImageLight.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The source of the model rotation, used when the filter renders.\rIf a function, it will be called to get the rotation.\rIf a GameObject, it will be used to get the rotation from the GameObject's world transform.\rIf null, the model rotation will be taken from the modelRotation property.", "name": "modelRotationSource", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Types.Filters.ImageLightSourceCallback", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Types.Filters.ImageLightSourceCallback" }, { "type": "NullLiteral" } ] } }, "since": "4.0.0", "memberof": "Phaser.Filters.ImageLight", "longname": "Phaser.Filters.ImageLight#modelRotationSource", "scope": "instance", "kind": "member", "___id": "T000002R006674", "___s": true }, { "comment": "/**\r\n * The amount of bulge to apply to the ImageLight effect.\r\n * This distorts the surface slightly, preventing flat areas in the normal map from reflecting a single flat color.\r\n * A value of 0.1 is often plenty.\r\n *\r\n * @name Phaser.Filters.ImageLight#bulge\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ImageLight.js", "lineno": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The amount of bulge to apply to the ImageLight effect.\rThis distorts the surface slightly, preventing flat areas in the normal map from reflecting a single flat color.\rA value of 0.1 is often plenty.", "name": "bulge", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.ImageLight", "longname": "Phaser.Filters.ImageLight#bulge", "scope": "instance", "kind": "member", "___id": "T000002R006676", "___s": true }, { "comment": "/**\r\n * The color factor to apply to the ImageLight effect. This multiplies the intensity of the light in each color channel. Use values above 1 to substitute for high dynamic range lighting.\r\n *\r\n * @name Phaser.Filters.ImageLight#colorFactor\r\n * @type {number[]}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ImageLight.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The color factor to apply to the ImageLight effect. This multiplies the intensity of the light in each color channel. Use values above 1 to substitute for high dynamic range lighting.", "name": "colorFactor", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "memberof": "Phaser.Filters.ImageLight", "longname": "Phaser.Filters.ImageLight#colorFactor", "scope": "instance", "kind": "member", "___id": "T000002R006678", "___s": true }, { "comment": "/**\r\n * Sets the texture to use for the ImageLight effect environment map.\r\n *\r\n * @method Phaser.Filters.ImageLight#setEnvironmentMap\r\n * @since 4.0.0\r\n * @param {string|Phaser.Textures.Texture} texture - The texture to use for the ImageLight effect environment map.\r\n * @return {this} This ImageLight instance.\r\n */", "meta": { "filename": "ImageLight.js", "lineno": 162, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets the texture to use for the ImageLight effect environment map.", "kind": "function", "name": "setEnvironmentMap", "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The texture to use for the ImageLight effect environment map.", "name": "texture" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ImageLight instance." } ], "memberof": "Phaser.Filters.ImageLight", "longname": "Phaser.Filters.ImageLight#setEnvironmentMap", "scope": "instance", "___id": "T000002R006684", "___s": true }, { "comment": "/**\r\n * Sets the texture to use for the ImageLight effect normal map.\r\n * This should match the object being filtered.\r\n *\r\n * @method Phaser.Filters.ImageLight#setNormalMap\r\n * @since 4.0.0\r\n * @param {string|Phaser.Textures.Texture} texture - The texture to use for the ImageLight effect normal map.\r\n * @return {this} This ImageLight instance.\r\n */", "meta": { "filename": "ImageLight.js", "lineno": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets the texture to use for the ImageLight effect normal map.\rThis should match the object being filtered.", "kind": "function", "name": "setNormalMap", "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The texture to use for the ImageLight effect normal map.", "name": "texture" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ImageLight instance." } ], "memberof": "Phaser.Filters.ImageLight", "longname": "Phaser.Filters.ImageLight#setNormalMap", "scope": "instance", "___id": "T000002R006688", "___s": true }, { "comment": "/**\r\n * Sets the normal texture to use for the ImageLight effect from a GameObject.\r\n * This will use the first data source image in the object's texture.\r\n * Use this to extract a normal map which was loaded as a data source.\r\n *\r\n * @method Phaser.Filters.ImageLight#setNormalMapFromGameObject\r\n * @since 4.0.0\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The GameObject to use for the ImageLight effect normal map.\r\n * @return {this} This ImageLight instance.\r\n */", "meta": { "filename": "ImageLight.js", "lineno": 203, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets the normal texture to use for the ImageLight effect from a GameObject.\rThis will use the first data source image in the object's texture.\rUse this to extract a normal map which was loaded as a data source.", "kind": "function", "name": "setNormalMapFromGameObject", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The GameObject to use for the ImageLight effect normal map.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This ImageLight instance." } ], "memberof": "Phaser.Filters.ImageLight", "longname": "Phaser.Filters.ImageLight#setNormalMapFromGameObject", "scope": "instance", "___id": "T000002R006692", "___s": true }, { "comment": "/**\r\n * Gets the rotation to use for the ImageLight effect.\r\n * This will use the modelRotationSource if it is set.\r\n *\r\n * @method Phaser.Filters.ImageLight#getModelRotation\r\n * @since 4.0.0\r\n * @return {number} The rotation to use for the ImageLight effect in radians.\r\n */", "meta": { "filename": "ImageLight.js", "lineno": 225, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Gets the rotation to use for the ImageLight effect.\rThis will use the modelRotationSource if it is set.", "kind": "function", "name": "getModelRotation", "since": "4.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rotation to use for the ImageLight effect in radians." } ], "memberof": "Phaser.Filters.ImageLight", "longname": "Phaser.Filters.ImageLight#getModelRotation", "scope": "instance", "___id": "T000002R006697", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Filters\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "kind": "namespace", "name": "Filters", "memberof": "Phaser", "longname": "Phaser.Filters", "scope": "static", "___id": "T000002R006700", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Key filter controller.\r\n *\r\n * The Key effect removes or isolates a specific color from an image.\r\n * It can be used to remove a background color from an image,\r\n * or to isolate a specific color for further processing.\r\n *\r\n * By default, Key will remove pixels that match the key color.\r\n * You can instead keep only the matching pixels by setting `isolate`.\r\n *\r\n * The threshold and feather settings control how closely the key color matches.\r\n * A match is measured by \"distance between color vectors\";\r\n * that is, how close the RGB values of the pixel are to the RGB values of the key color.\r\n *\r\n * A Key filter is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n * camera.filters.internal.addKey({ color: '#ff00ff' });\r\n * camera.filters.external.addKey({ color: 0x00ff00 });\r\n * ```\r\n *\r\n * @class Key\r\n * @extends Phaser.Filters.Controller\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that owns this filter.\r\n * @param {Phaser.Types.Filters.KeyConfig} [config={}] - The configuration for the filter.\r\n */", "meta": { "filename": "Key.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Key filter controller.\r\rThe Key effect removes or isolates a specific color from an image.\rIt can be used to remove a background color from an image,\ror to isolate a specific color for further processing.\r\rBy default, Key will remove pixels that match the key color.\rYou can instead keep only the matching pixels by setting `isolate`.\r\rThe threshold and feather settings control how closely the key color matches.\rA match is measured by \"distance between color vectors\";\rthat is, how close the RGB values of the pixel are to the RGB values of the key color.\r\rA Key filter is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\rcamera.filters.internal.addKey({ color: '#ff00ff' });\rcamera.filters.external.addKey({ color: 0x00ff00 });\r```", "kind": "class", "name": "Key", "augments": [ "Phaser.Filters.Controller" ], "memberof": "Phaser.Filters", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "Phaser.Types.Filters.KeyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Filters.KeyConfig" } }, "optional": true, "defaultvalue": "{}", "description": "The configuration for the filter.", "name": "config" } ], "scope": "static", "longname": "Phaser.Filters.Key", "___id": "T000002R006730", "___s": true }, { "comment": "/**\r\n * The color to use for the key.\r\n * It is an array of 4 numbers between 0 and 1, representing the RGBA values.\r\n *\r\n * @name Phaser.Filters.Key#color\r\n * @type {number[]}\r\n * @since 4.0.0\r\n * @default [ 1, 1, 1, 1 ]\r\n */", "meta": { "filename": "Key.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The color to use for the key.\rIt is an array of 4 numbers between 0 and 1, representing the RGBA values.", "name": "color", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "defaultvalue": "[ 1, 1, 1, 1 ]", "memberof": "Phaser.Filters.Key", "longname": "Phaser.Filters.Key#color", "scope": "instance", "kind": "member", "___id": "T000002R006735", "___s": true }, { "comment": "/**\r\n * Whether to keep the region matching the key color.\r\n * If true, the region matching the key color will be kept,\r\n * and the rest will be removed.\r\n * If false, the region matching the key color will be removed,\r\n * and the rest will be kept.\r\n *\r\n * @name Phaser.Filters.Key#isolate\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default false\r\n */", "meta": { "filename": "Key.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Whether to keep the region matching the key color.\rIf true, the region matching the key color will be kept,\rand the rest will be removed.\rIf false, the region matching the key color will be removed,\rand the rest will be kept.", "name": "isolate", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "false", "memberof": "Phaser.Filters.Key", "longname": "Phaser.Filters.Key#isolate", "scope": "instance", "kind": "member", "___id": "T000002R006737", "___s": true }, { "comment": "/**\r\n * The threshold for the key color.\r\n * A pixel is considered to be the key color if the difference between\r\n * the pixel and the key color is less than the threshold.\r\n * This should be between 0 and 1.\r\n * The default threshold is 1 / 16, which is a good starting point for most images.\r\n *\r\n * @name Phaser.Filters.Key#threshold\r\n * @type {number}\r\n * @since 4.0.0\r\n * @default 0.0625\r\n */", "meta": { "filename": "Key.js", "lineno": 78, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The threshold for the key color.\rA pixel is considered to be the key color if the difference between\rthe pixel and the key color is less than the threshold.\rThis should be between 0 and 1.\rThe default threshold is 1 / 16, which is a good starting point for most images.", "name": "threshold", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "defaultvalue": "0.0625", "memberof": "Phaser.Filters.Key", "longname": "Phaser.Filters.Key#threshold", "scope": "instance", "kind": "member", "___id": "T000002R006740", "___s": true }, { "comment": "/**\r\n * The feathering amount for the key color.\r\n * Pixels outside the threshold, but still within the feather,\r\n * will be a partial match.\r\n * This should be a value between 0 and 1.\r\n *\r\n * @name Phaser.Filters.Key#feather\r\n * @type {number}\r\n * @since 4.0.0\r\n * @default 0\r\n */", "meta": { "filename": "Key.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The feathering amount for the key color.\rPixels outside the threshold, but still within the feather,\rwill be a partial match.\rThis should be a value between 0 and 1.", "name": "feather", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "defaultvalue": "0", "memberof": "Phaser.Filters.Key", "longname": "Phaser.Filters.Key#feather", "scope": "instance", "kind": "member", "___id": "T000002R006743", "___s": true }, { "comment": "/**\r\n * Sets the alpha value to use for the key.\r\n * Alpha controls the opacity of pixels matched by the key color, in the range 0 to 1.\r\n * This is stored in the fourth element of the color array.\r\n * The RGB color values are preserved.\r\n *\r\n * @method Phaser.Filters.Key#setAlpha\r\n * @since 4.0.0\r\n * @param {number} alpha - The alpha value to set on the key texture, between 0 (fully transparent) and 1 (fully opaque).\r\n * @return {this} This Filter Controller.\r\n */", "meta": { "filename": "Key.js", "lineno": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets the alpha value to use for the key.\rAlpha controls the opacity of pixels matched by the key color, in the range 0 to 1.\rThis is stored in the fourth element of the color array.\rThe RGB color values are preserved.", "kind": "function", "name": "setAlpha", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha value to set on the key texture, between 0 (fully transparent) and 1 (fully opaque).", "name": "alpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Filter Controller." } ], "memberof": "Phaser.Filters.Key", "longname": "Phaser.Filters.Key#setAlpha", "scope": "instance", "___id": "T000002R006746", "___s": true }, { "comment": "/**\r\n * Sets the color to use for the key.\r\n * This is stored in the first three elements of the color array.\r\n * The alpha value is preserved.\r\n *\r\n * @method Phaser.Filters.Key#setColor\r\n * @since 4.0.0\r\n * @param {number | string | number[] | Phaser.Display.Color} color - The color to use for the key. It can be a hexcode number or string, an array of 3 numbers between 0 and 1, or a Color object.\r\n * @return {this} This Filter Controller.\r\n */", "meta": { "filename": "Key.js", "lineno": 125, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets the color to use for the key.\rThis is stored in the first three elements of the color array.\rThe alpha value is preserved.", "kind": "function", "name": "setColor", "since": "4.0.0", "params": [ { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "description": "The color to use for the key. It can be a hexcode number or string, an array of 3 numbers between 0 and 1, or a Color object.", "name": "color" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Filter Controller." } ], "memberof": "Phaser.Filters.Key", "longname": "Phaser.Filters.Key#setColor", "scope": "instance", "___id": "T000002R006749", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Mask Filter Controller.\r\n *\r\n * This filter controller manages a mask effect.\r\n *\r\n * A mask uses a texture to hide parts of an input.\r\n * It multiplies the color and alpha of the input\r\n * by the alpha of the mask in the corresponding texel.\r\n *\r\n * Masks can be inverted, which switches what they hide and what they show.\r\n *\r\n * Masks can use either a texture or a GameObject.\r\n * If a GameObject is used, the mask will render the GameObject\r\n * to a DynamicTexture and use that.\r\n * The mask will automatically update when the GameObject changes,\r\n * unless the `autoUpdate` flag is set to `false`.\r\n *\r\n * When the mask filter is used as an internal filter,\r\n * the mask will match the object/view being filtered.\r\n * This is useful for creating effects that follow the object,\r\n * such as effects intended to match an animated sprite.\r\n *\r\n * When the mask filter is used as an external filter,\r\n * the mask will match the context of the camera.\r\n * This is useful for creating effects that cover the entire view.\r\n *\r\n * An optional `viewCamera` can be specified when creating the mask.\r\n * If not used, mask objects will be viewed through the current camera,\r\n * or through a default camera if no other option is set.\r\n * For example, when rendering to a DynamicTexture outside the normal rendering\r\n * flow.\r\n *\r\n * A Mask effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n * const texture = 'MyMask';\r\n *\r\n * camera.filters.internal.addMask(texture);\r\n * camera.filters.external.addMask(texture, true, myCamera);\r\n * ```\r\n *\r\n * @class Mask\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @extends Phaser.Filters.Controller\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that owns this filter.\r\n * @param {string|Phaser.GameObjects.GameObject} [mask='__WHITE'] - The source of the mask. This can be a unique string-based key of the texture to use for the mask, which must exist in the Texture Manager. Or it can be a GameObject, in which case the mask will render the GameObject to a DynamicTexture and use that.\r\n * @param {boolean} [invert=false] - Whether to invert the mask.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [viewCamera] - The Camera to use when rendering the mask with a GameObject. If not specified, uses the scene's `main` camera.\r\n * @param {'local'|'world'} [viewTransform='world'] - The transform to use when rendering the mask with a GameObject. 'local' uses the GameObject's own properties. 'world' uses the GameObject's `parentContainer` value to compute a world position.\r\n * @param {number} [scaleFactor=1] - The scale factor to apply to the underlying mask texture. Can be used to balance memory usage and needed mask precision. This just adjusts the size of the texture; you must also adjust mask size to match, e.g. if scaleFactor is 0.5, your mask might be a Container with scale 0.5. It's easy to make things complicated when combining scale factor, object transform, and camera transform, so try to be precise when using this option.\r\n */", "meta": { "filename": "Mask.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Mask Filter Controller.\r\rThis filter controller manages a mask effect.\r\rA mask uses a texture to hide parts of an input.\rIt multiplies the color and alpha of the input\rby the alpha of the mask in the corresponding texel.\r\rMasks can be inverted, which switches what they hide and what they show.\r\rMasks can use either a texture or a GameObject.\rIf a GameObject is used, the mask will render the GameObject\rto a DynamicTexture and use that.\rThe mask will automatically update when the GameObject changes,\runless the `autoUpdate` flag is set to `false`.\r\rWhen the mask filter is used as an internal filter,\rthe mask will match the object/view being filtered.\rThis is useful for creating effects that follow the object,\rsuch as effects intended to match an animated sprite.\r\rWhen the mask filter is used as an external filter,\rthe mask will match the context of the camera.\rThis is useful for creating effects that cover the entire view.\r\rAn optional `viewCamera` can be specified when creating the mask.\rIf not used, mask objects will be viewed through the current camera,\ror through a default camera if no other option is set.\rFor example, when rendering to a DynamicTexture outside the normal rendering\rflow.\r\rA Mask effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\rconst texture = 'MyMask';\r\rcamera.filters.internal.addMask(texture);\rcamera.filters.external.addMask(texture, true, myCamera);\r```", "kind": "class", "name": "Mask", "memberof": "Phaser.Filters", "since": "4.0.0", "augments": [ "Phaser.Filters.Controller" ], "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "string", "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "optional": true, "defaultvalue": "'__WHITE'", "description": "The source of the mask. This can be a unique string-based key of the texture to use for the mask, which must exist in the Texture Manager. Or it can be a GameObject, in which case the mask will render the GameObject to a DynamicTexture and use that.", "name": "mask" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to invert the mask.", "name": "invert" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when rendering the mask with a GameObject. If not specified, uses the scene's `main` camera.", "name": "viewCamera" }, { "type": { "names": [ "'local'", "'world'" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "'local'" }, { "type": "NameExpression", "name": "'world'" } ] } }, "optional": true, "defaultvalue": "'world'", "description": "The transform to use when rendering the mask with a GameObject. 'local' uses the GameObject's own properties. 'world' uses the GameObject's `parentContainer` value to compute a world position.", "name": "viewTransform" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The scale factor to apply to the underlying mask texture. Can be used to balance memory usage and needed mask precision. This just adjusts the size of the texture; you must also adjust mask size to match, e.g. if scaleFactor is 0.5, your mask might be a Container with scale 0.5. It's easy to make things complicated when combining scale factor, object transform, and camera transform, so try to be precise when using this option.", "name": "scaleFactor" } ], "scope": "static", "longname": "Phaser.Filters.Mask", "___id": "T000002R006762", "___s": true }, { "comment": "/**\r\n * The underlying texture used for the mask.\r\n *\r\n * @name Phaser.Filters.Mask#glTexture\r\n * @type {Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The underlying texture used for the mask.", "name": "glTexture", "type": { "names": [ "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Mask", "longname": "Phaser.Filters.Mask#glTexture", "scope": "instance", "kind": "member", "___id": "T000002R006769", "___s": true }, { "comment": "/**\r\n * The GameObject used for the mask.\r\n * This is only set if the mask is a GameObject.\r\n *\r\n * @name Phaser.Filters.Mask#maskGameObject\r\n * @type {Phaser.GameObjects.GameObject}\r\n * @since 4.0.0\r\n * @default null\r\n */", "meta": { "filename": "Mask.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The GameObject used for the mask.\rThis is only set if the mask is a GameObject.", "name": "maskGameObject", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "since": "4.0.0", "defaultvalue": "null", "memberof": "Phaser.Filters.Mask", "longname": "Phaser.Filters.Mask#maskGameObject", "scope": "instance", "kind": "member", "___id": "T000002R006773", "___s": true }, { "comment": "/**\r\n * Whether to invert the mask.\r\n * An inverted mask switches what it hides and what it shows.\r\n *\r\n * @name Phaser.Filters.Mask#invert\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default false\r\n */", "meta": { "filename": "Mask.js", "lineno": 109, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Whether to invert the mask.\rAn inverted mask switches what it hides and what it shows.", "name": "invert", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "false", "memberof": "Phaser.Filters.Mask", "longname": "Phaser.Filters.Mask#invert", "scope": "instance", "kind": "member", "___id": "T000002R006775", "___s": true }, { "comment": "/**\r\n * Whether the mask should automatically update.\r\n * This only applies when the mask is a GameObject.\r\n * If `false`, the mask will not change even if the GameObject changes.\r\n *\r\n * @name Phaser.Filters.Mask#autoUpdate\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default true\r\n */", "meta": { "filename": "Mask.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Whether the mask should automatically update.\rThis only applies when the mask is a GameObject.\rIf `false`, the mask will not change even if the GameObject changes.", "name": "autoUpdate", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "true", "memberof": "Phaser.Filters.Mask", "longname": "Phaser.Filters.Mask#autoUpdate", "scope": "instance", "kind": "member", "___id": "T000002R006777", "___s": true }, { "comment": "/**\r\n * Whether the mask needs updating, once.\r\n * This only applies when the mask is a GameObject.\r\n * If `true`, the mask will be updated before the next render.\r\n * This is automatically set to `true` when the mask is a GameObject,\r\n * but it turns off after the mask is updated.\r\n *\r\n * @name Phaser.Filters.Mask#needsUpdate\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default false\r\n */", "meta": { "filename": "Mask.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Whether the mask needs updating, once.\rThis only applies when the mask is a GameObject.\rIf `true`, the mask will be updated before the next render.\rThis is automatically set to `true` when the mask is a GameObject,\rbut it turns off after the mask is updated.", "name": "needsUpdate", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "false", "memberof": "Phaser.Filters.Mask", "longname": "Phaser.Filters.Mask#needsUpdate", "scope": "instance", "kind": "member", "___id": "T000002R006779", "___s": true }, { "comment": "/**\r\n * The transform type to use when rendering the mask with a GameObject.\r\n * 'local' uses the GameObject's own properties.\r\n * 'world' uses the GameObject's `parentContainer` value to compute a world position.\r\n * This only applies when the mask is a GameObject.\r\n *\r\n * @name Phaser.Filters.Mask#viewTransform\r\n * @type {'local'|'world'}\r\n * @since 4.0.0\r\n * @default 'world'\r\n */", "meta": { "filename": "Mask.js", "lineno": 146, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The transform type to use when rendering the mask with a GameObject.\r'local' uses the GameObject's own properties.\r'world' uses the GameObject's `parentContainer` value to compute a world position.\rThis only applies when the mask is a GameObject.", "name": "viewTransform", "type": { "names": [ "'local'", "'world'" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "'local'" }, { "type": "NameExpression", "name": "'world'" } ] } }, "since": "4.0.0", "defaultvalue": "'world'", "memberof": "Phaser.Filters.Mask", "longname": "Phaser.Filters.Mask#viewTransform", "scope": "instance", "kind": "member", "___id": "T000002R006781", "___s": true }, { "comment": "/**\r\n * The Camera to use when rendering the mask.\r\n * If not specified, uses the currently rendering camera,\r\n * or failing that, an internal Camera.\r\n *\r\n * @name Phaser.Filters.Mask#viewCamera\r\n * @type {?Phaser.Cameras.Scene2D.Camera}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 159, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The Camera to use when rendering the mask.\rIf not specified, uses the currently rendering camera,\ror failing that, an internal Camera.", "name": "viewCamera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera", "nullable": true } }, "nullable": true, "since": "4.0.0", "memberof": "Phaser.Filters.Mask", "longname": "Phaser.Filters.Mask#viewCamera", "scope": "instance", "kind": "member", "___id": "T000002R006783", "___s": true }, { "comment": "/**\r\n * The scale factor to apply to the underlying mask texture.\r\n * A value less than 1 reduces the texture resolution to save memory\r\n * at the cost of mask precision. A value greater than 1 increases\r\n * resolution for sharper masking but uses more memory. When changing\r\n * this value, you must also scale the mask GameObject or Container\r\n * to match, so that its rendered output fills the texture correctly.\r\n *\r\n * @name Phaser.Filters.Mask#scaleFactor\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 170, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The scale factor to apply to the underlying mask texture.\rA value less than 1 reduces the texture resolution to save memory\rat the cost of mask precision. A value greater than 1 increases\rresolution for sharper masking but uses more memory. When changing\rthis value, you must also scale the mask GameObject or Container\rto match, so that its rendered output fills the texture correctly.", "name": "scaleFactor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.Filters.Mask", "longname": "Phaser.Filters.Mask#scaleFactor", "scope": "instance", "kind": "member", "___id": "T000002R006785", "___s": true }, { "comment": "/**\r\n * Updates the DynamicTexture for the mask.\r\n * The DynamicTexture is created or resized if necessary.\r\n * This is called automatically during rendering\r\n * when the mask is a GameObject\r\n * and the `needsUpdate` or `autoUpdate` flags are set.\r\n * It should not be called directly.\r\n *\r\n * @method Phaser.Filters.Mask#updateDynamicTexture\r\n * @since 4.0.0\r\n * @param {number} width - The width of the DynamicTexture.\r\n * @param {number} height - The height of the DynamicTexture.\r\n */", "meta": { "filename": "Mask.js", "lineno": 195, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Updates the DynamicTexture for the mask.\rThe DynamicTexture is created or resized if necessary.\rThis is called automatically during rendering\rwhen the mask is a GameObject\rand the `needsUpdate` or `autoUpdate` flags are set.\rIt should not be called directly.", "kind": "function", "name": "updateDynamicTexture", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the DynamicTexture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the DynamicTexture.", "name": "height" } ], "memberof": "Phaser.Filters.Mask", "longname": "Phaser.Filters.Mask#updateDynamicTexture", "scope": "instance", "___id": "T000002R006787", "___s": true }, { "comment": "/**\r\n * Sets the GameObject used for the mask. The GameObject will be rendered\r\n * to an internal DynamicTexture on the next render pass. Setting a new\r\n * GameObject also sets `needsUpdate` to `true`, ensuring the texture is\r\n * refreshed before the next frame is drawn.\r\n *\r\n * @method Phaser.Filters.Mask#setGameObject\r\n * @since 4.0.0\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The GameObject to use for the mask.\r\n * @return {this} This Filter Controller.\r\n */", "meta": { "filename": "Mask.js", "lineno": 246, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets the GameObject used for the mask. The GameObject will be rendered\rto an internal DynamicTexture on the next render pass. Setting a new\rGameObject also sets `needsUpdate` to `true`, ensuring the texture is\rrefreshed before the next frame is drawn.", "kind": "function", "name": "setGameObject", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The GameObject to use for the mask.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Filter Controller." } ], "memberof": "Phaser.Filters.Mask", "longname": "Phaser.Filters.Mask#setGameObject", "scope": "instance", "___id": "T000002R006800", "___s": true }, { "comment": "/**\r\n * Sets a static texture to use as the mask, looked up by key from the\r\n * Texture Manager. Any previously assigned mask GameObject is cleared.\r\n * Unlike a GameObject mask, a static texture mask does not update\r\n * automatically between frames.\r\n *\r\n * @method Phaser.Filters.Mask#setTexture\r\n * @since 4.0.0\r\n * @param {string} [texture='__WHITE'] - The unique string-based key of the texture to use for the mask, which must exist in the Texture Manager.\r\n * @return {this} This Filter Controller.\r\n */", "meta": { "filename": "Mask.js", "lineno": 270, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets a static texture to use as the mask, looked up by key from the\rTexture Manager. Any previously assigned mask GameObject is cleared.\rUnlike a GameObject mask, a static texture mask does not update\rautomatically between frames.", "kind": "function", "name": "setTexture", "since": "4.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'__WHITE'", "description": "The unique string-based key of the texture to use for the mask, which must exist in the Texture Manager.", "name": "texture" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Filter Controller." } ], "memberof": "Phaser.Filters.Mask", "longname": "Phaser.Filters.Mask#setTexture", "scope": "instance", "___id": "T000002R006804", "___s": true }, { "comment": "/**\r\n * Destroys this filter, releasing all references and resources.\r\n *\r\n * If a dynamic texture was created for a mask GameObject,\r\n * it will also be destroyed.\r\n *\r\n * @method Phaser.Filters.Mask#destroy\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 294, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Destroys this filter, releasing all references and resources.\r\rIf a dynamic texture was created for a mask GameObject,\rit will also be destroyed.", "kind": "function", "name": "destroy", "since": "4.0.0", "memberof": "Phaser.Filters.Mask", "longname": "Phaser.Filters.Mask#destroy", "scope": "instance", "overrides": "Phaser.Filters.Controller#destroy", "___id": "T000002R006809", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The NormalTools Filter Controller.\r\n *\r\n * This filter controller manages the NormalTools effect for a Camera.\r\n *\r\n * NormalTools is a filter for manipulating the normals of a normal map.\r\n * It has several functions:\r\n *\r\n * - Rotate or reorient the normal map.\r\n * - Change how strongly the normals face the camera.\r\n * - Output a grayscale texture showing how strongly the normals face the camera, or some other vector.\r\n *\r\n * The output can be used for various purposes, such as:\r\n *\r\n * - Editing a normal map for special applications.\r\n * - Altering the apparent visual depth of a normal map by manipulating the facing power.\r\n * - Creating a base for other effects, such as a mask for a gradient or other effect.\r\n *\r\n * You can even use the output as a normal map for regular lighting.\r\n * Ordinarily, normal maps are loaded alongside the main texture,\r\n * but you can override this.\r\n *\r\n * ```js\r\n * // Given a dynamic texture `dyn` where the filter output is drawn,\r\n * // and a texture `spiderTex` with lighting enabled,\r\n * // we can inject the WebGL texture straight into the scene lighting as a normal map.\r\n * spiderTex.setDataSource(dyn.getWebGLTexture());\r\n * ```\r\n *\r\n * A NormalTools effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n * camera.filters.internal.addNormalTools({\r\n * rotation: 0,\r\n * facingPower: 1,\r\n * outputRatio: false,\r\n * ratioVector: [ 0, 0, 1 ],\r\n * ratioRadius: 1\r\n * });\r\n * camera.filters.external.addNormalTools({});\r\n * ```\r\n *\r\n * @class NormalTools\r\n * @extends Phaser.Filters.Controller\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that owns this filter.\r\n * @param {Phaser.Types.Filters.NormalToolsConfig} [config] - The configuration object for the NormalTools effect.\r\n */", "meta": { "filename": "NormalTools.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The NormalTools Filter Controller.\r\rThis filter controller manages the NormalTools effect for a Camera.\r\rNormalTools is a filter for manipulating the normals of a normal map.\rIt has several functions:\r\r- Rotate or reorient the normal map.\r- Change how strongly the normals face the camera.\r- Output a grayscale texture showing how strongly the normals face the camera, or some other vector.\r\rThe output can be used for various purposes, such as:\r\r- Editing a normal map for special applications.\r- Altering the apparent visual depth of a normal map by manipulating the facing power.\r- Creating a base for other effects, such as a mask for a gradient or other effect.\r\rYou can even use the output as a normal map for regular lighting.\rOrdinarily, normal maps are loaded alongside the main texture,\rbut you can override this.\r\r```js\r// Given a dynamic texture `dyn` where the filter output is drawn,\r// and a texture `spiderTex` with lighting enabled,\r// we can inject the WebGL texture straight into the scene lighting as a normal map.\rspiderTex.setDataSource(dyn.getWebGLTexture());\r```\r\rA NormalTools effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\rcamera.filters.internal.addNormalTools({\r rotation: 0,\r facingPower: 1,\r outputRatio: false,\r ratioVector: [ 0, 0, 1 ],\r ratioRadius: 1\r});\rcamera.filters.external.addNormalTools({});\r```", "kind": "class", "name": "NormalTools", "augments": [ "Phaser.Filters.Controller" ], "memberof": "Phaser.Filters", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "Phaser.Types.Filters.NormalToolsConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Filters.NormalToolsConfig" } }, "optional": true, "description": "The configuration object for the NormalTools effect.", "name": "config" } ], "scope": "static", "longname": "Phaser.Filters.NormalTools", "___id": "T000002R006818", "___s": true }, { "comment": "/**\r\n * The view matrix used for the NormalTools effect.\r\n * This controls the orientation of the normal map.\r\n * Use this to control 3D rotation of the normal map.\r\n * Ordinarily, you would just use `setRotation` for 2D rotation.\r\n *\r\n * @name Phaser.Filters.NormalTools#viewMatrix\r\n * @type {Phaser.Math.Matrix4}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NormalTools.js", "lineno": 87, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The view matrix used for the NormalTools effect.\rThis controls the orientation of the normal map.\rUse this to control 3D rotation of the normal map.\rOrdinarily, you would just use `setRotation` for 2D rotation.", "name": "viewMatrix", "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "since": "4.0.0", "memberof": "Phaser.Filters.NormalTools", "longname": "Phaser.Filters.NormalTools#viewMatrix", "scope": "instance", "kind": "member", "___id": "T000002R006825", "___s": true }, { "comment": "/**\r\n * The source of the rotation.\r\n * If a function, it will be called to get the rotation.\r\n * If a GameObject, it will be used to get the rotation from the GameObject's world transform.\r\n * If null, the rotation will not be updated by the filter.\r\n *\r\n * @name Phaser.Filters.NormalTools#rotationSource\r\n * @type {Phaser.GameObjects.GameObject | Phaser.Types.Filters.NormalToolsSourceCallback | null}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NormalTools.js", "lineno": 101, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The source of the rotation.\rIf a function, it will be called to get the rotation.\rIf a GameObject, it will be used to get the rotation from the GameObject's world transform.\rIf null, the rotation will not be updated by the filter.", "name": "rotationSource", "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Types.Filters.NormalToolsSourceCallback", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Types.Filters.NormalToolsSourceCallback" }, { "type": "NullLiteral" } ] } }, "since": "4.0.0", "memberof": "Phaser.Filters.NormalTools", "longname": "Phaser.Filters.NormalTools#rotationSource", "scope": "instance", "kind": "member", "___id": "T000002R006827", "___s": true }, { "comment": "/**\r\n * The power of the facing effect.\r\n * Higher values bend normals toward the camera; lower values bend them away.\r\n * This can be useful for suggesting depth in a 2D scene.\r\n *\r\n * @name Phaser.Filters.NormalTools#facingPower\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NormalTools.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The power of the facing effect.\rHigher values bend normals toward the camera; lower values bend them away.\rThis can be useful for suggesting depth in a 2D scene.", "name": "facingPower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.Filters.NormalTools", "longname": "Phaser.Filters.NormalTools#facingPower", "scope": "instance", "kind": "member", "___id": "T000002R006829", "___s": true }, { "comment": "/**\r\n * Whether to output the ratio of the normal map.\r\n * If true, the output will be a grayscale texture, with the white area\r\n * being the areas where the normals are facing the camera,\r\n * fading to black when they're orthogonal.\r\n * You can manipulate this ratio with `ratioVector` and `ratioRadius`.\r\n * This can be useful as a base for other effects.\r\n *\r\n * @name Phaser.Filters.NormalTools#outputRatio\r\n * @type {boolean}\r\n * @default false\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NormalTools.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Whether to output the ratio of the normal map.\rIf true, the output will be a grayscale texture, with the white area\rbeing the areas where the normals are facing the camera,\rfading to black when they're orthogonal.\rYou can manipulate this ratio with `ratioVector` and `ratioRadius`.\rThis can be useful as a base for other effects.", "name": "outputRatio", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "4.0.0", "memberof": "Phaser.Filters.NormalTools", "longname": "Phaser.Filters.NormalTools#outputRatio", "scope": "instance", "kind": "member", "___id": "T000002R006831", "___s": true }, { "comment": "/**\r\n * The vector to use for the ratio output.\r\n * This is the direction in which the ratio will be calculated.\r\n * The default is the camera's forward direction.\r\n * Manipulate this to highlight parts of the map which are facing in a specific direction.\r\n *\r\n * This is only used if outputRatio is true.\r\n *\r\n * @name Phaser.Filters.NormalTools#ratioVector\r\n * @type {Phaser.Math.Vector3}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NormalTools.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The vector to use for the ratio output.\rThis is the direction in which the ratio will be calculated.\rThe default is the camera's forward direction.\rManipulate this to highlight parts of the map which are facing in a specific direction.\r\rThis is only used if outputRatio is true.", "name": "ratioVector", "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "since": "4.0.0", "memberof": "Phaser.Filters.NormalTools", "longname": "Phaser.Filters.NormalTools#ratioVector", "scope": "instance", "kind": "member", "___id": "T000002R006833", "___s": true }, { "comment": "/**\r\n * How much of a hemisphere to consider for the ratio output.\r\n * At 1, the ratio will be calculated for the entire hemisphere.\r\n * At 0, the ratio will be calculated for a single point.\r\n * This uses the same algorithm as `PanoramaBlur.radius`.\r\n *\r\n * This is only used if outputRatio is true.\r\n *\r\n * @name Phaser.Filters.NormalTools#ratioRadius\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NormalTools.js", "lineno": 158, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "How much of a hemisphere to consider for the ratio output.\rAt 1, the ratio will be calculated for the entire hemisphere.\rAt 0, the ratio will be calculated for a single point.\rThis uses the same algorithm as `PanoramaBlur.radius`.\r\rThis is only used if outputRatio is true.", "name": "ratioRadius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.Filters.NormalTools", "longname": "Phaser.Filters.NormalTools#ratioRadius", "scope": "instance", "kind": "member", "___id": "T000002R006835", "___s": true }, { "comment": "/**\r\n * Gets the 2D rotation of the normal map,\r\n * as set by `setRotation` or the `rotationSource`.\r\n *\r\n * This value is not accurate if the `viewMatrix` is manipulated directly,\r\n * e.g. for 3D rotation. There is no single value which can\r\n * accurately represent 3D rotation.\r\n *\r\n * @method Phaser.Filters.NormalTools#getRotation\r\n * @since 4.0.0\r\n * @return {number} The rotation in radians.\r\n */", "meta": { "filename": "NormalTools.js", "lineno": 174, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Gets the 2D rotation of the normal map,\ras set by `setRotation` or the `rotationSource`.\r\rThis value is not accurate if the `viewMatrix` is manipulated directly,\re.g. for 3D rotation. There is no single value which can\raccurately represent 3D rotation.", "kind": "function", "name": "getRotation", "since": "4.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rotation in radians." } ], "memberof": "Phaser.Filters.NormalTools", "longname": "Phaser.Filters.NormalTools#getRotation", "scope": "instance", "___id": "T000002R006837", "___s": true }, { "comment": "/**\r\n * Sets the rotation of the normal map.\r\n * This sets the `viewMatrix` to a rotation around the Z axis,\r\n * suitable for 2D rotation.\r\n * For more advanced controls, manipulate the filter's `viewMatrix` to control 3D rotation.\r\n *\r\n * @method Phaser.Filters.NormalTools#setRotation\r\n * @since 4.0.0\r\n * @param {number} rotation - The rotation in radians.\r\n * @return {this} This NormalTools instance.\r\n */", "meta": { "filename": "NormalTools.js", "lineno": 204, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets the rotation of the normal map.\rThis sets the `viewMatrix` to a rotation around the Z axis,\rsuitable for 2D rotation.\rFor more advanced controls, manipulate the filter's `viewMatrix` to control 3D rotation.", "kind": "function", "name": "setRotation", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rotation in radians.", "name": "rotation" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This NormalTools instance." } ], "memberof": "Phaser.Filters.NormalTools", "longname": "Phaser.Filters.NormalTools#setRotation", "scope": "instance", "___id": "T000002R006839", "___s": true }, { "comment": "/**\r\n * Updates the rotation of the normal map from the rotationSource,\r\n * if it is set. This is called automatically during rendering.\r\n *\r\n * @method Phaser.Filters.NormalTools#updateRotation\r\n * @since 4.0.0\r\n * @return {this} This NormalTools instance.\r\n */", "meta": { "filename": "NormalTools.js", "lineno": 223, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Updates the rotation of the normal map from the rotationSource,\rif it is set. This is called automatically during rendering.", "kind": "function", "name": "updateRotation", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This NormalTools instance." } ], "memberof": "Phaser.Filters.NormalTools", "longname": "Phaser.Filters.NormalTools#updateRotation", "scope": "instance", "___id": "T000002R006842", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The PanoramaBlur Filter Controller.\r\n *\r\n * This filter controller manages the PanoramaBlur effect for a Camera.\r\n *\r\n * PanoramaBlur is a filter for blurring a panorama image.\r\n * This is intended for use with filters like ImageLight that use a panorama image as the environment map.\r\n * The blur treats a rectangular map as a sphere,\r\n * and applies heavy distortion close to the poles to get a correct result.\r\n * You should not use it for general purpose blurring.\r\n *\r\n * The effect can be very slow, as it uses a grid of samples.\r\n * Total samples equals samplesX * samplesY. This can get very high,\r\n * very quickly, so be careful when increasing these values.\r\n * They don't need to be too high for good results.\r\n *\r\n * By default, the blur is fully diffuse, sampling an entire hemisphere per point.\r\n * If you reduce the radius, the effect will be more focused.\r\n * Use this to control different levels of glossiness in objects using environment maps.\r\n *\r\n * A PanoramaBlur effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n *\r\n * camera.filters.internal.addPanoramaBlur({});\r\n * camera.filters.external.addPanoramaBlur({});\r\n * ```\r\n *\r\n * @example\r\n * // Cache a panorama image in a scene.\r\n * // Assume there is a panorama texture called 'panorama'.\r\n * var panorama = this.add.image(0, 0, 'panorama');\r\n * panorama.setPosition(panorama.width / 2, panorama.height / 2);\r\n * panorama.enableFilters().filters.internal.addPanoramaBlur({});\r\n *\r\n * var panoramaBlurred = this.textures.addDynamicTexture('panorama-blurred', panorama.width, panorama.height);\r\n * panoramaBlurred.draw(panorama).render();\r\n *\r\n * panorama.destroy();\r\n *\r\n * // Use the blurred panorama in a filter.\r\n * anotherObject.enableFilters().filters.internal.addImageLight({ environmentMap: 'panorama-blurred' });\r\n *\r\n * @class PanoramaBlur\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @extends Phaser.Filters.Controller\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that owns this filter.\r\n * @param {Phaser.Types.Filters.PanoramaBlurConfig} [config] - The configuration object for the PanoramaBlur effect.\r\n */", "meta": { "filename": "PanoramaBlur.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The PanoramaBlur Filter Controller.\r\rThis filter controller manages the PanoramaBlur effect for a Camera.\r\rPanoramaBlur is a filter for blurring a panorama image.\rThis is intended for use with filters like ImageLight that use a panorama image as the environment map.\rThe blur treats a rectangular map as a sphere,\rand applies heavy distortion close to the poles to get a correct result.\rYou should not use it for general purpose blurring.\r\rThe effect can be very slow, as it uses a grid of samples.\rTotal samples equals samplesX * samplesY. This can get very high,\rvery quickly, so be careful when increasing these values.\rThey don't need to be too high for good results.\r\rBy default, the blur is fully diffuse, sampling an entire hemisphere per point.\rIf you reduce the radius, the effect will be more focused.\rUse this to control different levels of glossiness in objects using environment maps.\r\rA PanoramaBlur effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\r\rcamera.filters.internal.addPanoramaBlur({});\rcamera.filters.external.addPanoramaBlur({});\r```", "examples": [ "// Cache a panorama image in a scene.\r// Assume there is a panorama texture called 'panorama'.\rvar panorama = this.add.image(0, 0, 'panorama');\rpanorama.setPosition(panorama.width / 2, panorama.height / 2);\rpanorama.enableFilters().filters.internal.addPanoramaBlur({});\r\rvar panoramaBlurred = this.textures.addDynamicTexture('panorama-blurred', panorama.width, panorama.height);\rpanoramaBlurred.draw(panorama).render();\r\rpanorama.destroy();\r\r// Use the blurred panorama in a filter.\ranotherObject.enableFilters().filters.internal.addImageLight({ environmentMap: 'panorama-blurred' });" ], "kind": "class", "name": "PanoramaBlur", "memberof": "Phaser.Filters", "since": "4.0.0", "augments": [ "Phaser.Filters.Controller" ], "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "Phaser.Types.Filters.PanoramaBlurConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Filters.PanoramaBlurConfig" } }, "optional": true, "description": "The configuration object for the PanoramaBlur effect.", "name": "config" } ], "scope": "static", "longname": "Phaser.Filters.PanoramaBlur", "___id": "T000002R006849", "___s": true }, { "comment": "/**\r\n * The radius of the blur effect. 1 samples an entire hemisphere; 0 samples a single point.\r\n *\r\n * @name Phaser.Filters.PanoramaBlur#radius\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "PanoramaBlur.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The radius of the blur effect. 1 samples an entire hemisphere; 0 samples a single point.", "name": "radius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.PanoramaBlur", "longname": "Phaser.Filters.PanoramaBlur#radius", "scope": "instance", "kind": "member", "___id": "T000002R006854", "___s": true }, { "comment": "/**\r\n * The number of samples to take along the X axis. More samples produces a more accurate blur, but at the cost of performance. The X axis in a panorama is usually wider than the Y axis.\r\n *\r\n * Altering this value triggers a shader re-compile.\r\n *\r\n * @name Phaser.Filters.PanoramaBlur#samplesX\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "PanoramaBlur.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The number of samples to take along the X axis. More samples produces a more accurate blur, but at the cost of performance. The X axis in a panorama is usually wider than the Y axis.\r\rAltering this value triggers a shader re-compile.", "name": "samplesX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.PanoramaBlur", "longname": "Phaser.Filters.PanoramaBlur#samplesX", "scope": "instance", "kind": "member", "___id": "T000002R006856", "___s": true }, { "comment": "/**\r\n * The number of samples to take along the Y axis. More samples produces a more accurate blur, but at the cost of performance.\r\n *\r\n * Altering this value triggers a shader re-compile.\r\n *\r\n * @name Phaser.Filters.PanoramaBlur#samplesY\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "PanoramaBlur.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The number of samples to take along the Y axis. More samples produces a more accurate blur, but at the cost of performance.\r\rAltering this value triggers a shader re-compile.", "name": "samplesY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.PanoramaBlur", "longname": "Phaser.Filters.PanoramaBlur#samplesY", "scope": "instance", "kind": "member", "___id": "T000002R006858", "___s": true }, { "comment": "/**\r\n * An exponent applied to samples. Power above 1 darkens the samples overall, but bright colors are suppressed less than dark ones, causing them to become relatively more dominant in the result. Power below 1 brightens samples overall, reducing the contrast between bright and dark colors. To simulate an HDR environment with bright sunlight that cannot be represented in sRGB color, use high power.\r\n *\r\n * @name Phaser.Filters.PanoramaBlur#power\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "PanoramaBlur.js", "lineno": 103, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "An exponent applied to samples. Power above 1 darkens the samples overall, but bright colors are suppressed less than dark ones, causing them to become relatively more dominant in the result. Power below 1 brightens samples overall, reducing the contrast between bright and dark colors. To simulate an HDR environment with bright sunlight that cannot be represented in sRGB color, use high power.", "name": "power", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.PanoramaBlur", "longname": "Phaser.Filters.PanoramaBlur#power", "scope": "instance", "kind": "member", "___id": "T000002R006860", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Parallel Filters Controller.\r\n *\r\n * This filter controller splits the input into two lists of filters,\r\n * runs each list separately, and then blends the results together.\r\n *\r\n * The Parallel Filters effect is useful for reusing an input.\r\n * Ordinarily, a filter modifies the input and passes it to the next filter.\r\n * This effect allows you to split the input and re-use it elsewhere.\r\n * It does not gain performance benefits from parallel processing;\r\n * it is a convenience for reusing the input.\r\n *\r\n * The Parallel Filters effect is not a filter itself.\r\n * It is a controller that manages two FilterLists,\r\n * and the final Blend filter that combines the results.\r\n * The FilterLists are named 'top' and 'bottom'.\r\n * The 'top' output is applied as a blend texture to the 'bottom' output.\r\n *\r\n * You do not have to populate both lists. If only one is populated,\r\n * it will be blended with the original input at the end.\r\n * This is useful when you want to retain image data that would be lost\r\n * in the filter process.\r\n *\r\n * A Parallel Filters effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n * camera.filters.internal.addParallelFilters();\r\n * camera.filters.external.addParallelFilters();\r\n * ```\r\n *\r\n * @example\r\n * // Create a customizable Bloom effect.\r\n * const camera = this.cameras.main;\r\n * const parallelFilters = camera.filters.internal.addParallelFilters();\r\n * parallelFilters.top.addThreshold(0.5, 1);\r\n * parallelFilters.top.addBlur();\r\n * parallelFilters.blend.blendMode = Phaser.BlendModes.ADD;\r\n * parallelFilters.blend.amount = 0.5;\r\n *\r\n * @class ParallelFilters\r\n * @extends Phaser.Filters.Controller\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that owns this filter.\r\n */", "meta": { "filename": "ParallelFilters.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Parallel Filters Controller.\r\rThis filter controller splits the input into two lists of filters,\rruns each list separately, and then blends the results together.\r\rThe Parallel Filters effect is useful for reusing an input.\rOrdinarily, a filter modifies the input and passes it to the next filter.\rThis effect allows you to split the input and re-use it elsewhere.\rIt does not gain performance benefits from parallel processing;\rit is a convenience for reusing the input.\r\rThe Parallel Filters effect is not a filter itself.\rIt is a controller that manages two FilterLists,\rand the final Blend filter that combines the results.\rThe FilterLists are named 'top' and 'bottom'.\rThe 'top' output is applied as a blend texture to the 'bottom' output.\r\rYou do not have to populate both lists. If only one is populated,\rit will be blended with the original input at the end.\rThis is useful when you want to retain image data that would be lost\rin the filter process.\r\rA Parallel Filters effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\rcamera.filters.internal.addParallelFilters();\rcamera.filters.external.addParallelFilters();\r```", "examples": [ "// Create a customizable Bloom effect.\rconst camera = this.cameras.main;\rconst parallelFilters = camera.filters.internal.addParallelFilters();\rparallelFilters.top.addThreshold(0.5, 1);\rparallelFilters.top.addBlur();\rparallelFilters.blend.blendMode = Phaser.BlendModes.ADD;\rparallelFilters.blend.amount = 0.5;" ], "kind": "class", "name": "ParallelFilters", "augments": [ "Phaser.Filters.Controller" ], "memberof": "Phaser.Filters", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that owns this filter.", "name": "camera" } ], "scope": "static", "longname": "Phaser.Filters.ParallelFilters", "___id": "T000002R006867", "___s": true }, { "comment": "/**\r\n * The top FilterList. Filters added to this list receive the original\r\n * input and are processed independently from the bottom list. The final\r\n * output of this list is passed to the Blend controller as a blend\r\n * texture, which is then composited onto the bottom output.\r\n *\r\n * @name Phaser.Filters.ParallelFilters#top\r\n * @type {Phaser.GameObjects.Components.FilterList}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ParallelFilters.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The top FilterList. Filters added to this list receive the original\rinput and are processed independently from the bottom list. The final\routput of this list is passed to the Blend controller as a blend\rtexture, which is then composited onto the bottom output.", "name": "top", "type": { "names": [ "Phaser.GameObjects.Components.FilterList" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FilterList" } }, "since": "4.0.0", "memberof": "Phaser.Filters.ParallelFilters", "longname": "Phaser.Filters.ParallelFilters#top", "scope": "instance", "kind": "member", "___id": "T000002R006871", "___s": true }, { "comment": "/**\r\n * The bottom FilterList. Filters added to this list receive the original\r\n * input and are processed independently from the top list. The final\r\n * output of this list serves as the base image onto which the top\r\n * output is blended by the Blend controller.\r\n *\r\n * @name Phaser.Filters.ParallelFilters#bottom\r\n * @type {Phaser.GameObjects.Components.FilterList}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ParallelFilters.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The bottom FilterList. Filters added to this list receive the original\rinput and are processed independently from the top list. The final\routput of this list serves as the base image onto which the top\routput is blended by the Blend controller.", "name": "bottom", "type": { "names": [ "Phaser.GameObjects.Components.FilterList" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FilterList" } }, "since": "4.0.0", "memberof": "Phaser.Filters.ParallelFilters", "longname": "Phaser.Filters.ParallelFilters#bottom", "scope": "instance", "kind": "member", "___id": "T000002R006873", "___s": true }, { "comment": "/**\r\n * The Blend filter controller that composites the top and bottom\r\n * FilterList outputs into a single result. It is a standard\r\n * {@link Phaser.Filters.Blend} controller whose blend mode and amount\r\n * can be configured to control how the two outputs are combined.\r\n * See {@link Phaser.Filters.Blend} for more information.\r\n *\r\n * The `texture` property of the Blend controller will be\r\n * overwritten during rendering.\r\n *\r\n * @name Phaser.Filters.ParallelFilters#blend\r\n * @type {Phaser.Filters.Blend}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ParallelFilters.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The Blend filter controller that composites the top and bottom\rFilterList outputs into a single result. It is a standard\r{@link Phaser.Filters.Blend} controller whose blend mode and amount\rcan be configured to control how the two outputs are combined.\rSee {@link Phaser.Filters.Blend} for more information.\r\rThe `texture` property of the Blend controller will be\roverwritten during rendering.", "name": "blend", "type": { "names": [ "Phaser.Filters.Blend" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Blend" } }, "since": "4.0.0", "memberof": "Phaser.Filters.ParallelFilters", "longname": "Phaser.Filters.ParallelFilters#blend", "scope": "instance", "kind": "member", "___id": "T000002R006875", "___s": true }, { "comment": "/**\r\n * Adds a Parallel Filters effect.\r\n *\r\n * This filter controller splits the input into two lists of filters,\r\n * runs each list separately, and then blends the results together.\r\n *\r\n * The Parallel Filters effect is useful for reusing an input.\r\n * Ordinarily, a filter modifies the input and passes it to the next filter.\r\n * This effect allows you to split the input and re-use it elsewhere.\r\n * It does not gain performance benefits from parallel processing;\r\n * it is a convenience for reusing the input.\r\n *\r\n * The Parallel Filters effect is not a filter itself.\r\n * It is a controller that manages two FilterLists,\r\n * and the final Blend filter that combines the results.\r\n * The FilterLists are named 'top' and 'bottom'.\r\n * The 'top' output is applied as a blend texture to the 'bottom' output.\r\n *\r\n * You do not have to populate both lists. If only one is populated,\r\n * it will be blended with the original input at the end.\r\n * This is useful when you want to retain image data that would be lost\r\n * in the filter process.\r\n *\r\n * @example\r\n * // Create a customizable Bloom effect.\r\n * const camera = this.cameras.main;\r\n * const parallelFilters = camera.filters.internal.addParallelFilters();\r\n * parallelFilters.top.addThreshold(0.5, 1);\r\n * parallelFilters.top.addBlur();\r\n * parallelFilters.blend.blendMode = Phaser.BlendModes.ADD;\r\n * parallelFilters.blend.amount = 0.5;\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addParallelFilters\r\n * @since 4.0.0\r\n * @return {Phaser.Filters.ParallelFilters} The new Parallel Filters filter controller.\r\n */", "meta": { "filename": "ParallelFilters.js", "lineno": 112, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Adds a Parallel Filters effect.\r\rThis filter controller splits the input into two lists of filters,\rruns each list separately, and then blends the results together.\r\rThe Parallel Filters effect is useful for reusing an input.\rOrdinarily, a filter modifies the input and passes it to the next filter.\rThis effect allows you to split the input and re-use it elsewhere.\rIt does not gain performance benefits from parallel processing;\rit is a convenience for reusing the input.\r\rThe Parallel Filters effect is not a filter itself.\rIt is a controller that manages two FilterLists,\rand the final Blend filter that combines the results.\rThe FilterLists are named 'top' and 'bottom'.\rThe 'top' output is applied as a blend texture to the 'bottom' output.\r\rYou do not have to populate both lists. If only one is populated,\rit will be blended with the original input at the end.\rThis is useful when you want to retain image data that would be lost\rin the filter process.", "examples": [ "// Create a customizable Bloom effect.\rconst camera = this.cameras.main;\rconst parallelFilters = camera.filters.internal.addParallelFilters();\rparallelFilters.top.addThreshold(0.5, 1);\rparallelFilters.top.addBlur();\rparallelFilters.blend.blendMode = Phaser.BlendModes.ADD;\rparallelFilters.blend.amount = 0.5;" ], "kind": "function", "name": "addParallelFilters", "since": "4.0.0", "returns": [ { "type": { "names": [ "Phaser.Filters.ParallelFilters" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.ParallelFilters" } }, "description": "The new Parallel Filters filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addParallelFilters", "scope": "instance", "___id": "T000002R006877", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Pixelate Filter Controller.\r\n *\r\n * This filter controller manages the pixelate effect for a Camera.\r\n * The pixelate effect is a visual technique that deliberately reduces the resolution or detail of an image,\r\n * creating a blocky or mosaic appearance composed of large, visible pixels. This effect can be used for stylistic\r\n * purposes, as a homage to retro gaming, or as a means to obscure certain elements within the game, such as\r\n * during a transition or to censor specific content.\r\n *\r\n * A Pixelate effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n * camera.filters.internal.addPixelate();\r\n * ```\r\n *\r\n * @class Pixelate\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @extends Phaser.Filters.Controller\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that owns this filter.\r\n * @param {number} [amount=1] - The amount of pixelation to apply.\r\n */", "meta": { "filename": "Pixelate.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Pixelate Filter Controller.\r\rThis filter controller manages the pixelate effect for a Camera.\rThe pixelate effect is a visual technique that deliberately reduces the resolution or detail of an image,\rcreating a blocky or mosaic appearance composed of large, visible pixels. This effect can be used for stylistic\rpurposes, as a homage to retro gaming, or as a means to obscure certain elements within the game, such as\rduring a transition or to censor specific content.\r\rA Pixelate effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\rcamera.filters.internal.addPixelate();\r```", "kind": "class", "name": "Pixelate", "memberof": "Phaser.Filters", "since": "4.0.0", "augments": [ "Phaser.Filters.Controller" ], "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount of pixelation to apply.", "name": "amount" } ], "scope": "static", "longname": "Phaser.Filters.Pixelate", "___id": "T000002R006882", "___s": true }, { "comment": "/**\r\n * The amount of pixelation to apply.\r\n *\r\n * The size of the pixels is equal to 2 + the amount.\r\n *\r\n * @name Phaser.Filters.Pixelate#amount\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Pixelate.js", "lineno": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The amount of pixelation to apply.\r\rThe size of the pixels is equal to 2 + the amount.", "name": "amount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.Filters.Pixelate", "longname": "Phaser.Filters.Pixelate#amount", "scope": "instance", "kind": "member", "___id": "T000002R006887", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Quantize Filter Controller.\r\n *\r\n * This controller manages the Quantize effect on a Camera.\r\n *\r\n * Quantization reduces the unique number of colors in an image,\r\n * based on some limited number of steps per color channel.\r\n * This is good for creating a retro or stylized effect.\r\n *\r\n * Basic quantization breaks each channel up into a number of `steps`.\r\n * These steps are normally regular. You can bias them towards the top or bottom\r\n * by changing that channel's `gamma` value.\r\n * You can adjust the lowest step, thus all subsequent steps, with the `offset`.\r\n *\r\n * Quantization is done in either RGBA or HSVA space.\r\n * The steps, gamma, and offset always apply in the same order,\r\n * but depending on color mode, they are either applied to\r\n * `[ red, green, blue, alpha ]` or `[ hue, saturation, value, alpha ]`.\r\n *\r\n * The output may optionally be dithered, to eliminate banding\r\n * and create the illusion that there are many more colors in use.\r\n *\r\n * @example\r\n * const camera = this.cameras.main;\r\n * camera.filters.internal.addQuantize(); // Default effect.\r\n * camera.filters.external.addQuantize({\r\n * steps: [ 16, 1, 1, 1 ],\r\n * dither: true,\r\n * mode: 1\r\n * }); // Quantize into 16 fully saturated rainbow hues, and dither.\r\n *\r\n * @class Quantize\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @extends Phaser.Filters.Controller\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that owns this filter.\r\n * @param {Phaser.Types.Filters.QuantizeConfig} [config] - The configuration object for the Quantize effect.\r\n */", "meta": { "filename": "Quantize.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Quantize Filter Controller.\r\rThis controller manages the Quantize effect on a Camera.\r\rQuantization reduces the unique number of colors in an image,\rbased on some limited number of steps per color channel.\rThis is good for creating a retro or stylized effect.\r\rBasic quantization breaks each channel up into a number of `steps`.\rThese steps are normally regular. You can bias them towards the top or bottom\rby changing that channel's `gamma` value.\rYou can adjust the lowest step, thus all subsequent steps, with the `offset`.\r\rQuantization is done in either RGBA or HSVA space.\rThe steps, gamma, and offset always apply in the same order,\rbut depending on color mode, they are either applied to\r`[ red, green, blue, alpha ]` or `[ hue, saturation, value, alpha ]`.\r\rThe output may optionally be dithered, to eliminate banding\rand create the illusion that there are many more colors in use.", "examples": [ "const camera = this.cameras.main;\rcamera.filters.internal.addQuantize(); // Default effect.\rcamera.filters.external.addQuantize({\r steps: [ 16, 1, 1, 1 ],\r dither: true,\r mode: 1\r}); // Quantize into 16 fully saturated rainbow hues, and dither." ], "kind": "class", "name": "Quantize", "memberof": "Phaser.Filters", "since": "4.0.0", "augments": [ "Phaser.Filters.Controller" ], "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "Phaser.Types.Filters.QuantizeConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Filters.QuantizeConfig" } }, "optional": true, "description": "The configuration object for the Quantize effect.", "name": "config" } ], "scope": "static", "longname": "Phaser.Filters.Quantize", "___id": "T000002R006892", "___s": true }, { "comment": "/**\r\n * How many steps to divide each channel into.\r\n *\r\n * It's often useful to drop the last place to 1,\r\n * because it's alpha in both RGBA and HSVA,\r\n * and alpha is often either on or off.\r\n *\r\n * In RGBA mode, the first 3 channels (RGB) should\r\n * probably be the same, unless there's a stylistic need.\r\n * In HSVA mode, the first channel (H) should probably have\r\n * many divisions to distinguish different hues,\r\n * while the second and third channels (SV) may need fewer steps.\r\n *\r\n * @name Phaser.Filters.Quantize#steps\r\n * @type {number[]}\r\n * @since 4.0.0\r\n * @default [ 8, 8, 8, 8 ]\r\n */", "meta": { "filename": "Quantize.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "How many steps to divide each channel into.\r\rIt's often useful to drop the last place to 1,\rbecause it's alpha in both RGBA and HSVA,\rand alpha is often either on or off.\r\rIn RGBA mode, the first 3 channels (RGB) should\rprobably be the same, unless there's a stylistic need.\rIn HSVA mode, the first channel (H) should probably have\rmany divisions to distinguish different hues,\rwhile the second and third channels (SV) may need fewer steps.", "name": "steps", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "defaultvalue": "[ 8, 8, 8, 8 ]", "memberof": "Phaser.Filters.Quantize", "longname": "Phaser.Filters.Quantize#steps", "scope": "instance", "kind": "member", "___id": "T000002R006897", "___s": true }, { "comment": "/**\r\n * Gamma curve applied to the input channels.\r\n * This can help prioritize nuances in dark or light areas.\r\n *\r\n * In RGBA mode, the RGB channels can be treated the same.\r\n * In HSVA mode, you probably want to apply gamma to just\r\n * the value and saturation channels.\r\n *\r\n * @name Phaser.Filters.Quantize#gamma\r\n * @type {number[]}\r\n * @since 4.0.0\r\n * @default [ 1, 1, 1, 1 ]\r\n */", "meta": { "filename": "Quantize.js", "lineno": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Gamma curve applied to the input channels.\rThis can help prioritize nuances in dark or light areas.\r\rIn RGBA mode, the RGB channels can be treated the same.\rIn HSVA mode, you probably want to apply gamma to just\rthe value and saturation channels.", "name": "gamma", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "defaultvalue": "[ 1, 1, 1, 1 ]", "memberof": "Phaser.Filters.Quantize", "longname": "Phaser.Filters.Quantize#gamma", "scope": "instance", "kind": "member", "___id": "T000002R006903", "___s": true }, { "comment": "/**\r\n * Offset to apply to the channels during quantization.\r\n * This mainly exists to slide the hue angle for HSVA quantization.\r\n *\r\n * @name Phaser.Filters.Quantize#offset\r\n * @type {number[]}\r\n * @since 4.0.0\r\n * @default [ 0, 0, 0, 0 ]\r\n */", "meta": { "filename": "Quantize.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Offset to apply to the channels during quantization.\rThis mainly exists to slide the hue angle for HSVA quantization.", "name": "offset", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "defaultvalue": "[ 0, 0, 0, 0 ]", "memberof": "Phaser.Filters.Quantize", "longname": "Phaser.Filters.Quantize#offset", "scope": "instance", "kind": "member", "___id": "T000002R006909", "___s": true }, { "comment": "/**\r\n * The color space to use. 0 is RGBA, 1 is HSVA.\r\n * Use HSVA to control many hues with fewer levels\r\n * of lightness/saturation.\r\n *\r\n * When the mode changes to HSVA, `steps`, `gamma`, and `offset`\r\n * now apply to the hue, saturation, value, and alpha channels.\r\n * They are otherwise unchanged.\r\n *\r\n * @name Phaser.Filters.Quantize#mode\r\n * @type {number}\r\n * @since 4.0.0\r\n * @default 0\r\n */", "meta": { "filename": "Quantize.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The color space to use. 0 is RGBA, 1 is HSVA.\rUse HSVA to control many hues with fewer levels\rof lightness/saturation.\r\rWhen the mode changes to HSVA, `steps`, `gamma`, and `offset`\rnow apply to the hue, saturation, value, and alpha channels.\rThey are otherwise unchanged.", "name": "mode", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "defaultvalue": "0", "memberof": "Phaser.Filters.Quantize", "longname": "Phaser.Filters.Quantize#mode", "scope": "instance", "kind": "member", "___id": "T000002R006915", "___s": true }, { "comment": "/**\r\n * Whether to apply dither to the quantization,\r\n * creating a smoother output with the reduced colors.\r\n *\r\n * @name Phaser.Filters.Quantize#dither\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default false\r\n */", "meta": { "filename": "Quantize.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Whether to apply dither to the quantization,\rcreating a smoother output with the reduced colors.", "name": "dither", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "false", "memberof": "Phaser.Filters.Quantize", "longname": "Phaser.Filters.Quantize#dither", "scope": "instance", "kind": "member", "___id": "T000002R006917", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Sampler Filter Controller.\r\n *\r\n * This controller reads pixel data from the camera's rendered output and passes\r\n * it to a user-defined callback. Unlike other filter controllers, the Sampler\r\n * does not alter the rendered image in any way — it is purely a data extraction\r\n * tool. It can sample a single point, a rectangular region, or the entire\r\n * camera view, and is useful for techniques such as color picking, pixel-perfect\r\n * hit detection, or runtime visual analysis.\r\n *\r\n * This operation is expensive, so use sparingly.\r\n *\r\n * A Sampler is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n *\r\n * camera.filters.internal.addSampler(callback, region);\r\n * camera.filters.external.addSampler(callback, region);\r\n * ```\r\n *\r\n * @class Sampler\r\n * @memberof Phaser.Filters\r\n * @extends Phaser.Filters.Controller\r\n * @constructor\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that owns this filter.\r\n * @param {Phaser.Types.Renderer.Snapshot.SnapshotCallback} callback - The callback to call with the results of the sampler.\r\n * @param {null|Phaser.Types.Math.Vector2Like|Phaser.Geom.Rectangle} [region=null] - The region to sample. If `null`, the entire camera view is sampled. If a `Phaser.Types.Math.Vector2Like`, a point is sampled. If a `Phaser.Geom.Rectangle`, the region is sampled.\r\n */", "meta": { "filename": "Sampler.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Sampler Filter Controller.\r\rThis controller reads pixel data from the camera's rendered output and passes\rit to a user-defined callback. Unlike other filter controllers, the Sampler\rdoes not alter the rendered image in any way — it is purely a data extraction\rtool. It can sample a single point, a rectangular region, or the entire\rcamera view, and is useful for techniques such as color picking, pixel-perfect\rhit detection, or runtime visual analysis.\r\rThis operation is expensive, so use sparingly.\r\rA Sampler is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\r\rcamera.filters.internal.addSampler(callback, region);\rcamera.filters.external.addSampler(callback, region);\r```", "kind": "class", "name": "Sampler", "memberof": "Phaser.Filters", "augments": [ "Phaser.Filters.Controller" ], "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "Phaser.Types.Renderer.Snapshot.SnapshotCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.Snapshot.SnapshotCallback" } }, "description": "The callback to call with the results of the sampler.", "name": "callback" }, { "type": { "names": [ "null", "Phaser.Types.Math.Vector2Like", "Phaser.Geom.Rectangle" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NullLiteral" }, { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" }, { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } ] } }, "optional": true, "defaultvalue": null, "description": "The region to sample. If `null`, the entire camera view is sampled. If a `Phaser.Types.Math.Vector2Like`, a point is sampled. If a `Phaser.Geom.Rectangle`, the region is sampled.", "name": "region" } ], "scope": "static", "longname": "Phaser.Filters.Sampler", "___id": "T000002R006922", "___s": true }, { "comment": "/**\r\n * The callback to invoke once the pixel data has been read from the\r\n * sampled region. It receives the snapshot result, which may be an\r\n * `HTMLImageElement` (for region snapshots) or a `Phaser.Display.Color`\r\n * (for point snapshots), depending on the `region` type.\r\n *\r\n * @name Phaser.Filters.Sampler#callback\r\n * @type {Phaser.Types.Renderer.Snapshot.SnapshotCallback}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Sampler.js", "lineno": 52, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The callback to invoke once the pixel data has been read from the\rsampled region. It receives the snapshot result, which may be an\r`HTMLImageElement` (for region snapshots) or a `Phaser.Display.Color`\r(for point snapshots), depending on the `region` type.", "name": "callback", "type": { "names": [ "Phaser.Types.Renderer.Snapshot.SnapshotCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.Snapshot.SnapshotCallback" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Sampler", "longname": "Phaser.Filters.Sampler#callback", "scope": "instance", "kind": "member", "___id": "T000002R006928", "___s": true }, { "comment": "/**\r\n * The region to sample. If `null`, the entire camera view is sampled.\r\n * If a `Phaser.Types.Math.Vector2Like`, a point is sampled.\r\n * If a `Phaser.Geom.Rectangle`, the region is sampled.\r\n *\r\n * @name Phaser.Filters.Sampler#region\r\n * @type {null|Phaser.Types.Math.Vector2Like|Phaser.Geom.Rectangle}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Sampler.js", "lineno": 64, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The region to sample. If `null`, the entire camera view is sampled.\rIf a `Phaser.Types.Math.Vector2Like`, a point is sampled.\rIf a `Phaser.Geom.Rectangle`, the region is sampled.", "name": "region", "type": { "names": [ "null", "Phaser.Types.Math.Vector2Like", "Phaser.Geom.Rectangle" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NullLiteral" }, { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" }, { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } ] } }, "since": "4.0.0", "memberof": "Phaser.Filters.Sampler", "longname": "Phaser.Filters.Sampler#region", "scope": "instance", "kind": "member", "___id": "T000002R006930", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Shadow Filter.\r\n *\r\n * This filter controller manages the shadow effect for a Camera.\r\n *\r\n * The shadow effect is a visual technique used to create the illusion of depth and realism by adding darker,\r\n * offset silhouettes or shapes beneath game objects, characters, or environments. These simulated shadows\r\n * help to enhance the visual appeal and immersion, making the 2D game world appear more dynamic and three-dimensional.\r\n *\r\n * This effect samples across an area. To avoid missing data at the edges,\r\n * use `controller.setPaddingOverride(null)` to automatically pad game objects,\r\n * or `camera.getPaddingWrapper(x)` to enlarge a camera.\r\n *\r\n * A Shadow effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n *\r\n * camera.filters.internal.addShadow();\r\n * camera.filters.external.addShadow();\r\n * ```\r\n *\r\n * @class Shadow\r\n * @extends Phaser.Filters.Controller\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that owns this filter.\r\n * @param {number} [x=0] - The horizontal offset of the shadow effect.\r\n * @param {number} [y=0] - The vertical offset of the shadow effect.\r\n * @param {number} [decay=0.1] - The amount of decay for the shadow effect.\r\n * @param {number} [power=1] - The power of the shadow effect.\r\n * @param {number} [color=0x000000] - The color of the shadow, as a hex value.\r\n * @param {number} [samples=6] - The number of samples that the shadow effect will run for.\r\n * @param {number} [intensity=1] - The intensity of the shadow effect.\r\n */", "meta": { "filename": "Shadow.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Shadow Filter.\r\rThis filter controller manages the shadow effect for a Camera.\r\rThe shadow effect is a visual technique used to create the illusion of depth and realism by adding darker,\roffset silhouettes or shapes beneath game objects, characters, or environments. These simulated shadows\rhelp to enhance the visual appeal and immersion, making the 2D game world appear more dynamic and three-dimensional.\r\rThis effect samples across an area. To avoid missing data at the edges,\ruse `controller.setPaddingOverride(null)` to automatically pad game objects,\ror `camera.getPaddingWrapper(x)` to enlarge a camera.\r\rA Shadow effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\r\rcamera.filters.internal.addShadow();\rcamera.filters.external.addShadow();\r```", "kind": "class", "name": "Shadow", "augments": [ "Phaser.Filters.Controller" ], "memberof": "Phaser.Filters", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal offset of the shadow effect.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical offset of the shadow effect.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "The amount of decay for the shadow effect.", "name": "decay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The power of the shadow effect.", "name": "power" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x000000", "description": "The color of the shadow, as a hex value.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 6, "description": "The number of samples that the shadow effect will run for.", "name": "samples" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The intensity of the shadow effect.", "name": "intensity" } ], "scope": "static", "longname": "Phaser.Filters.Shadow", "___id": "T000002R006935", "___s": true }, { "comment": "/**\r\n * The horizontal offset of the shadow effect.\r\n *\r\n * @name Phaser.Filters.Shadow#x\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The horizontal offset of the shadow effect.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Shadow", "longname": "Phaser.Filters.Shadow#x", "scope": "instance", "kind": "member", "___id": "T000002R006945", "___s": true }, { "comment": "/**\r\n * The vertical offset of the shadow effect.\r\n *\r\n * @name Phaser.Filters.Shadow#y\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The vertical offset of the shadow effect.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Shadow", "longname": "Phaser.Filters.Shadow#y", "scope": "instance", "kind": "member", "___id": "T000002R006947", "___s": true }, { "comment": "/**\r\n * Controls how quickly the shadow fades over distance. Lower values produce longer,\r\n * more gradual shadows; higher values produce shorter, more concentrated shadows.\r\n *\r\n * @name Phaser.Filters.Shadow#decay\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Controls how quickly the shadow fades over distance. Lower values produce longer,\rmore gradual shadows; higher values produce shorter, more concentrated shadows.", "name": "decay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Shadow", "longname": "Phaser.Filters.Shadow#decay", "scope": "instance", "kind": "member", "___id": "T000002R006949", "___s": true }, { "comment": "/**\r\n * An exponent applied to the shadow falloff curve. Higher values create sharper\r\n * shadow edges; lower values create softer, more diffuse shadows.\r\n *\r\n * @name Phaser.Filters.Shadow#power\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "An exponent applied to the shadow falloff curve. Higher values create sharper\rshadow edges; lower values create softer, more diffuse shadows.", "name": "power", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Shadow", "longname": "Phaser.Filters.Shadow#power", "scope": "instance", "kind": "member", "___id": "T000002R006951", "___s": true }, { "comment": "/**\r\n * The internal WebGL color array used by the shader. Stores the shadow color\r\n * as normalized RGBA float values in the range 0 to 1. This array is updated\r\n * automatically when the `color` property is set.\r\n *\r\n * @name Phaser.Filters.Shadow#glcolor\r\n * @type {number[]}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The internal WebGL color array used by the shader. Stores the shadow color\ras normalized RGBA float values in the range 0 to 1. This array is updated\rautomatically when the `color` property is set.", "name": "glcolor", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.0.0", "memberof": "Phaser.Filters.Shadow", "longname": "Phaser.Filters.Shadow#glcolor", "scope": "instance", "kind": "member", "___id": "T000002R006953", "___s": true }, { "comment": "/**\r\n * The number of samples that the shadow effect will run for.\r\n *\r\n * This should be an integer with a minimum value of 1 and a maximum of 12.\r\n *\r\n * @name Phaser.Filters.Shadow#samples\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 111, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The number of samples that the shadow effect will run for.\r\rThis should be an integer with a minimum value of 1 and a maximum of 12.", "name": "samples", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Shadow", "longname": "Phaser.Filters.Shadow#samples", "scope": "instance", "kind": "member", "___id": "T000002R006955", "___s": true }, { "comment": "/**\r\n * A multiplier for the overall shadow visibility. Higher values produce darker,\r\n * more prominent shadows.\r\n *\r\n * @name Phaser.Filters.Shadow#intensity\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "A multiplier for the overall shadow visibility. Higher values produce darker,\rmore prominent shadows.", "name": "intensity", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Shadow", "longname": "Phaser.Filters.Shadow#intensity", "scope": "instance", "kind": "member", "___id": "T000002R006957", "___s": true }, { "comment": "/**\r\n * The color of the shadow, expressed as a hex RGB value (e.g. `0xff0000` for red,\r\n * `0x000000` for black). Setting this property updates the internal `glcolor` array\r\n * used by the WebGL shader.\r\n *\r\n * @name Phaser.Filters.Shadow#color\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shadow.js", "lineno": 138, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The color of the shadow, expressed as a hex RGB value (e.g. `0xff0000` for red,\r`0x000000` for black). Setting this property updates the internal `glcolor` array\rused by the WebGL shader.", "name": "color", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Shadow", "longname": "Phaser.Filters.Shadow#color", "scope": "instance", "kind": "member", "___id": "T000002R006960", "___s": true }, { "comment": "/**\r\n * Returns the amount of extra padding, in pixels, that this filter requires when rendering.\r\n * The padding accounts for the shadow effect extending beyond the original bounds\r\n * of the filtered Game Object.\r\n *\r\n * @method Phaser.Filters.Shadow#getPadding\r\n * @since 4.0.0\r\n *\r\n * @return {Phaser.Geom.Rectangle} The padding Rectangle.\r\n */", "meta": { "filename": "Shadow.js", "lineno": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Returns the amount of extra padding, in pixels, that this filter requires when rendering.\rThe padding accounts for the shadow effect extending beyond the original bounds\rof the filtered Game Object.", "kind": "function", "name": "getPadding", "since": "4.0.0", "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The padding Rectangle." } ], "memberof": "Phaser.Filters.Shadow", "longname": "Phaser.Filters.Shadow#getPadding", "scope": "instance", "overrides": "Phaser.Filters.Controller#getPadding", "___id": "T000002R006969", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Threshold Filter Controller.\r\n *\r\n * This controller manages a threshold filter.\r\n * Input values are compared to a threshold value or range.\r\n * Values below the threshold are set to 0, and values above the threshold are set to 1.\r\n * Values within the range are linearly interpolated between 0 and 1.\r\n *\r\n * This is useful for creating effects such as sharp edges from gradients,\r\n * or for creating binary effects.\r\n *\r\n * The threshold is stored as a range, with two edges.\r\n * Each edge has a value for each channel, between 0 and 1.\r\n * If the two edges are the same, the threshold has no interpolation,\r\n * and will output either 0 or 1.\r\n * Each channel can also be inverted.\r\n *\r\n * A Threshold effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n *\r\n * camera.filters.internal.addThreshold();\r\n * camera.filters.external.addThreshold();\r\n * ```\r\n *\r\n * @class Threshold\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @extends Phaser.Filters.Controller\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that owns this filter.\r\n * @param {number|number[]} [edge1=0.5] - The first edge of the threshold. This may be an array of the RGBA channels, or a single number to apply to all 4 channels.\r\n * @param {number|number[]} [edge2=0.5] - The second edge of the threshold. This may be an array of the RGBA channels, or a single number to apply to all 4 channels.\r\n * @param {boolean|boolean[]} [invert=false] - Whether each channel is inverted. This may be an array of the RGBA channels, or a single boolean to apply to all 4 channels.\r\n */", "meta": { "filename": "Threshold.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Threshold Filter Controller.\r\rThis controller manages a threshold filter.\rInput values are compared to a threshold value or range.\rValues below the threshold are set to 0, and values above the threshold are set to 1.\rValues within the range are linearly interpolated between 0 and 1.\r\rThis is useful for creating effects such as sharp edges from gradients,\ror for creating binary effects.\r\rThe threshold is stored as a range, with two edges.\rEach edge has a value for each channel, between 0 and 1.\rIf the two edges are the same, the threshold has no interpolation,\rand will output either 0 or 1.\rEach channel can also be inverted.\r\rA Threshold effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\r\rcamera.filters.internal.addThreshold();\rcamera.filters.external.addThreshold();\r```", "kind": "class", "name": "Threshold", "memberof": "Phaser.Filters", "since": "4.0.0", "augments": [ "Phaser.Filters.Controller" ], "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "defaultvalue": 0.5, "description": "The first edge of the threshold. This may be an array of the RGBA channels, or a single number to apply to all 4 channels.", "name": "edge1" }, { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "defaultvalue": 0.5, "description": "The second edge of the threshold. This may be an array of the RGBA channels, or a single number to apply to all 4 channels.", "name": "edge2" }, { "type": { "names": [ "boolean", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "boolean", "type": "NameExpression" } ] } ] } }, "optional": true, "defaultvalue": false, "description": "Whether each channel is inverted. This may be an array of the RGBA channels, or a single boolean to apply to all 4 channels.", "name": "invert" } ], "scope": "static", "longname": "Phaser.Filters.Threshold", "___id": "T000002R006979", "___s": true }, { "comment": "/**\r\n * The first edge of the threshold.\r\n * This contains the lowest value for each channel.\r\n *\r\n * @name Phaser.Filters.Threshold#edge1\r\n * @type {number[]}\r\n * @default [ 0.5, 0.5, 0.5, 0.5 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Threshold.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The first edge of the threshold.\rThis contains the lowest value for each channel.", "name": "edge1", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 0.5, 0.5, 0.5, 0.5 ]", "since": "4.0.0", "memberof": "Phaser.Filters.Threshold", "longname": "Phaser.Filters.Threshold#edge1", "scope": "instance", "kind": "member", "___id": "T000002R006983", "___s": true }, { "comment": "/**\r\n * The second edge of the threshold.\r\n * This contains the highest value for each channel.\r\n * If it is the same as the first edge, the threshold is a single value.\r\n *\r\n * @name Phaser.Filters.Threshold#edge2\r\n * @type {number[]}\r\n * @default [ 0.5, 0.5, 0.5, 0.5 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Threshold.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The second edge of the threshold.\rThis contains the highest value for each channel.\rIf it is the same as the first edge, the threshold is a single value.", "name": "edge2", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 0.5, 0.5, 0.5, 0.5 ]", "since": "4.0.0", "memberof": "Phaser.Filters.Threshold", "longname": "Phaser.Filters.Threshold#edge2", "scope": "instance", "kind": "member", "___id": "T000002R006985", "___s": true }, { "comment": "/**\r\n * Whether each channel is inverted. When a channel is inverted, its\r\n * output is flipped so that values that would normally output 0 instead\r\n * output 1, and vice versa. This applies per-channel to the RGBA\r\n * components of the threshold result.\r\n *\r\n * @name Phaser.Filters.Threshold#invert\r\n * @type {boolean[]}\r\n * @default [ false, false, false, false ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Threshold.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Whether each channel is inverted. When a channel is inverted, its\routput is flipped so that values that would normally output 0 instead\routput 1, and vice versa. This applies per-channel to the RGBA\rcomponents of the threshold result.", "name": "invert", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "boolean", "type": "NameExpression" } ] } }, "defaultvalue": "[ false, false, false, false ]", "since": "4.0.0", "memberof": "Phaser.Filters.Threshold", "longname": "Phaser.Filters.Threshold#invert", "scope": "instance", "kind": "member", "___id": "T000002R006987", "___s": true }, { "comment": "/**\r\n * Set the edges of the threshold.\r\n * If the second edge is not provided, it will be set to the first edge.\r\n *\r\n * This ensures that the first edge is not greater than the second edge.\r\n * It may swap channels between edges to ensure this.\r\n *\r\n * @method Phaser.Filters.Threshold#setEdge\r\n * @since 4.0.0\r\n * @param {number|number[]} [edge1=0.5] - The first edge of the threshold. This may be an array of the RGBA channels, or a single number to apply to all 4 channels.\r\n * @param {number|number[]} [edge2=0.5] - The second edge of the threshold. This may be an array of the RGBA channels, or a single number to apply to all 4 channels.\r\n * @return {Phaser.Filters.Threshold} This Threshold instance.\r\n */", "meta": { "filename": "Threshold.js", "lineno": 94, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Set the edges of the threshold.\rIf the second edge is not provided, it will be set to the first edge.\r\rThis ensures that the first edge is not greater than the second edge.\rIt may swap channels between edges to ensure this.", "kind": "function", "name": "setEdge", "since": "4.0.0", "params": [ { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "defaultvalue": 0.5, "description": "The first edge of the threshold. This may be an array of the RGBA channels, or a single number to apply to all 4 channels.", "name": "edge1" }, { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "defaultvalue": 0.5, "description": "The second edge of the threshold. This may be an array of the RGBA channels, or a single number to apply to all 4 channels.", "name": "edge2" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Threshold" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Threshold" } }, "description": "This Threshold instance." } ], "memberof": "Phaser.Filters.Threshold", "longname": "Phaser.Filters.Threshold#setEdge", "scope": "instance", "___id": "T000002R006989", "___s": true }, { "comment": "/**\r\n * Sets the invert state for each channel of the threshold filter.\r\n * When a channel is inverted, its output is flipped: pixels that would\r\n * output 0 instead output 1, and vice versa. This can be used to create\r\n * negative or reversed threshold effects per channel.\r\n * If `invert` is not provided, all channels default to `false`.\r\n *\r\n * @method Phaser.Filters.Threshold#setInvert\r\n * @since 4.0.0\r\n * @param {boolean|boolean[]} [invert=false] - Whether each channel is inverted. This may be an array of the RGBA channels, or a single boolean to apply to all 4 channels.\r\n * @return {Phaser.Filters.Threshold} This Threshold instance.\r\n */", "meta": { "filename": "Threshold.js", "lineno": 150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets the invert state for each channel of the threshold filter.\rWhen a channel is inverted, its output is flipped: pixels that would\routput 0 instead output 1, and vice versa. This can be used to create\rnegative or reversed threshold effects per channel.\rIf `invert` is not provided, all channels default to `false`.", "kind": "function", "name": "setInvert", "since": "4.0.0", "params": [ { "type": { "names": [ "boolean", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "boolean", "type": "NameExpression" } ] } ] } }, "optional": true, "defaultvalue": false, "description": "Whether each channel is inverted. This may be an array of the RGBA channels, or a single boolean to apply to all 4 channels.", "name": "invert" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Threshold" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Threshold" } }, "description": "This Threshold instance." } ], "memberof": "Phaser.Filters.Threshold", "longname": "Phaser.Filters.Threshold#setInvert", "scope": "instance", "___id": "T000002R007007", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Filters.BlockyConfig\r\n * @since 4.0.0\r\n *\r\n * @property {number | Phaser.Types.Math.Vector2Like} [size] - The size of the blocks. If a number, it sets both x and y to the same value. If a Vector2Like, it sets x and y to the respective values.\r\n * @property {number | Phaser.Types.Math.Vector2Like} [offset] - The offset of the blocks. If a number, it sets both x and y to the same value. If a Vector2Like, it sets x and y to the respective values.\r\n */", "meta": { "filename": "BlockyConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters\\typedefs", "code": {} }, "kind": "typedef", "name": "BlockyConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "number", "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } ] } }, "optional": true, "description": "The size of the blocks. If a number, it sets both x and y to the same value. If a Vector2Like, it sets x and y to the respective values.", "name": "size" }, { "type": { "names": [ "number", "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } ] } }, "optional": true, "description": "The offset of the blocks. If a number, it sets both x and y to the same value. If a Vector2Like, it sets x and y to the respective values.", "name": "offset" } ], "memberof": "Phaser.Types.Filters", "longname": "Phaser.Types.Filters.BlockyConfig", "scope": "static", "___id": "T000002R007016", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Filters.GradientMapConfig\r\n * @since 4.0.0\r\n *\r\n * @property {Phaser.Display.ColorRamp | Phaser.Types.Display.ColorBandConfig | Phaser.Display.ColorBand | Array} [ramp] - The color ramp to use.\r\n * @property {boolean} [dither=false] - Whether to dither the gradient output.\r\n * @property {number[]} [color=[0, 0, 0, 0]] - Value to add to each channel.\r\n * @property {number[]} [colorFactor=[0.3, 0.6, 0.1, 0]] - Factor to apply to each channel. Try to keep them summing to 1.\r\n * @property {boolean} [unpremultiply=true] - Whether to unpremultiply color data before processing it.\r\n * @property {number} [alpha=1] - How much of the effect to blend over the original.\r\n */", "meta": { "filename": "GradientMapConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters\\typedefs", "code": {} }, "kind": "typedef", "name": "GradientMapConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "Phaser.Display.ColorRamp", "Phaser.Types.Display.ColorBandConfig", "Phaser.Display.ColorBand", "Array.<(Phaser.Types.Display.ColorBandConfig|Phaser.Display.ColorBand)>" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Display.ColorRamp" }, { "type": "NameExpression", "name": "Phaser.Types.Display.ColorBandConfig" }, { "type": "NameExpression", "name": "Phaser.Display.ColorBand" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Display.ColorBandConfig" }, { "type": "NameExpression", "name": "Phaser.Display.ColorBand" } ] } ] } ] } }, "optional": true, "description": "The color ramp to use.", "name": "ramp" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to dither the gradient output.", "name": "dither" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[0, 0, 0, 0]", "description": "Value to add to each channel.", "name": "color" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[0.3, 0.6, 0.1, 0]", "description": "Factor to apply to each channel. Try to keep them summing to 1.", "name": "colorFactor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether to unpremultiply color data before processing it.", "name": "unpremultiply" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How much of the effect to blend over the original.", "name": "alpha" } ], "memberof": "Phaser.Types.Filters", "longname": "Phaser.Types.Filters.GradientMapConfig", "scope": "static", "___id": "T000002R007017", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Filters.ImageLightConfig\r\n * @since 4.0.0\r\n *\r\n * @property {string|Phaser.Textures.Texture} [normalMap='__NORMAL'] - The texture to use for the ImageLight effect normal map. This should match the object being filtered. The default is flat lighting.\r\n * @property {string|Phaser.Textures.Texture} [environmentMap='__WHITE'] - The texture to use for the ImageLight effect environment map.\r\n * @property {Phaser.Math.Matrix4} [modelMatrix] - The initial model matrix. If not provided, a default matrix will be created.\r\n * @property {number} [modelRotation=0] - The initial rotation of the model in radians.\r\n * @property {Phaser.GameObjects.GameObject | Phaser.Types.Filters.ImageLightSourceCallback | null} [modelRotationSource=null] - The source of the model rotation. If a function, it will be called to get the rotation. If a GameObject, it will be used to get the rotation from the GameObject's world transform. If null, the model rotation will be taken from the modelRotation property.\r\n * @property {number} [bulge=0] - The amount of bulge to apply to the ImageLight effect. This distorts the surface slightly, preventing flat areas in the normal map from reflecting a single flat color. A value of 0.1 is often plenty.\r\n * @property {number[]} [colorFactor=[1, 1, 1]] - The color factor to apply to the ImageLight effect. This multiplies the intensity of the light in each color channel. Use values above 1 to substitute for high dynamic range lighting.\r\n */", "meta": { "filename": "ImageLightConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters\\typedefs", "code": {} }, "kind": "typedef", "name": "ImageLightConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "defaultvalue": "'__NORMAL'", "description": "The texture to use for the ImageLight effect normal map. This should match the object being filtered. The default is flat lighting.", "name": "normalMap" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "defaultvalue": "'__WHITE'", "description": "The texture to use for the ImageLight effect environment map.", "name": "environmentMap" }, { "type": { "names": [ "Phaser.Math.Matrix4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Matrix4" } }, "optional": true, "description": "The initial model matrix. If not provided, a default matrix will be created.", "name": "modelMatrix" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The initial rotation of the model in radians.", "name": "modelRotation" }, { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Types.Filters.ImageLightSourceCallback", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Types.Filters.ImageLightSourceCallback" }, { "type": "NullLiteral" } ] } }, "optional": true, "defaultvalue": null, "description": "The source of the model rotation. If a function, it will be called to get the rotation. If a GameObject, it will be used to get the rotation from the GameObject's world transform. If null, the model rotation will be taken from the modelRotation property.", "name": "modelRotationSource" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount of bulge to apply to the ImageLight effect. This distorts the surface slightly, preventing flat areas in the normal map from reflecting a single flat color. A value of 0.1 is often plenty.", "name": "bulge" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[1, 1, 1]", "description": "The color factor to apply to the ImageLight effect. This multiplies the intensity of the light in each color channel. Use values above 1 to substitute for high dynamic range lighting.", "name": "colorFactor" } ], "memberof": "Phaser.Types.Filters", "longname": "Phaser.Types.Filters.ImageLightConfig", "scope": "static", "___id": "T000002R007018", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Filters.ImageLightSourceCallback\r\n * @since 4.0.0\r\n *\r\n * @return {number} The rotation to use for the ImageLight effect in radians.\r\n */", "meta": { "filename": "ImageLightSourceCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters\\typedefs", "code": {} }, "kind": "typedef", "name": "ImageLightSourceCallback", "type": { "names": [ "function" ] }, "since": "4.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rotation to use for the ImageLight effect in radians." } ], "memberof": "Phaser.Types.Filters", "longname": "Phaser.Types.Filters.ImageLightSourceCallback", "scope": "static", "___id": "T000002R007019", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Filters\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters\\typedefs", "code": {} }, "kind": "namespace", "name": "Filters", "memberof": "Phaser.Types", "longname": "Phaser.Types.Filters", "scope": "static", "___id": "T000002R007020", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Filters.KeyConfig\r\n * @since 4.0.0\r\n *\r\n * @property {number | string | number[] | Phaser.Display.Color} [color=[1, 1, 1]] - The color to use for the key. It can be a hexcode number or string, an array of 3 numbers between 0 and 1, or a Color object.\r\n * @property {number} [alpha=1] - The amount of alpha to remove. This should be a value between 0 and 1, but you can go outside that range for different effects.\r\n * @property {boolean} [isolate=false] - Whether to keep the region matching the key color. If true, the region matching the key color will be kept, and the rest will be removed. If false, the region matching the key color will be removed, and the rest will be kept.\r\n * @property {number} [threshold=0.0625] - The threshold for the key color. A pixel is considered to be the key color if the difference between the pixel and the key color is less than the threshold. This should be a value between 0 and 1. The default threshold is 1 / 16, which is a good starting point for most images.\r\n * @property {number} [feather=0] - The feathering amount for the key color. Pixels outside the threshold, but still within the feather, will be a partial match. This should be a value between 0 and 1.\r\n */", "meta": { "filename": "KeyConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters\\typedefs", "code": {} }, "kind": "typedef", "name": "KeyConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "[1, 1, 1]", "description": "The color to use for the key. It can be a hexcode number or string, an array of 3 numbers between 0 and 1, or a Color object.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount of alpha to remove. This should be a value between 0 and 1, but you can go outside that range for different effects.", "name": "alpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to keep the region matching the key color. If true, the region matching the key color will be kept, and the rest will be removed. If false, the region matching the key color will be removed, and the rest will be kept.", "name": "isolate" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.0625, "description": "The threshold for the key color. A pixel is considered to be the key color if the difference between the pixel and the key color is less than the threshold. This should be a value between 0 and 1. The default threshold is 1 / 16, which is a good starting point for most images.", "name": "threshold" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The feathering amount for the key color. Pixels outside the threshold, but still within the feather, will be a partial match. This should be a value between 0 and 1.", "name": "feather" } ], "memberof": "Phaser.Types.Filters", "longname": "Phaser.Types.Filters.KeyConfig", "scope": "static", "___id": "T000002R007021", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Filters.NormalToolsConfig\r\n * @since 4.0.0\r\n *\r\n * @property {number} [rotation=0] - 2D rotation of the normal map in radians. For more advanced controls, manipulate the filter's `viewMatrix` to control 3D rotation.\r\n * @property {Phaser.GameObjects.GameObject | Phaser.Types.Filters.NormalToolsSourceCallback | null} [rotationSource=null] - The source of the rotation. If a function, it will be called to get the rotation. If a GameObject, it will be used to get the rotation from the GameObject's world transform. If null, the rotation will not be updated by the filter.]\r\n * @property {number} [facingPower=1] - Manipulate the tendency for normals to face the camera. Higher values bend normals toward the camera; lower values bend them away. This can be useful for suggesting depth in a 2D scene.\r\n * @property {boolean} [outputRatio=false] - If true, the output will be a grayscale texture, with the white area being the areas where the normals are facing the camera, fading to black when they're orthogonal. This can be useful as a base for other effects.\r\n * @property {Phaser.Math.Vector3} [ratioVector=[0, 0, 1]] - The vector to use for the ratio output. This is the direction in which the ratio will be calculated. The default is the camera's forward direction. Manipulate this to highlight parts of the map which are facing in a specific direction. This is only used if outputRatio is true.\r\n * @property {number} [ratioRadius=1] - How much of a hemisphere to consider for the ratio output. At 1, the ratio will be calculated for the entire hemisphere. At 0, the ratio will be calculated for a single point. This uses the same algorithm as `PanoramaBlur.radius`. This is only used if outputRatio is true.\r\n */", "meta": { "filename": "NormalToolsConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters\\typedefs", "code": {} }, "kind": "typedef", "name": "NormalToolsConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "2D rotation of the normal map in radians. For more advanced controls, manipulate the filter's `viewMatrix` to control 3D rotation.", "name": "rotation" }, { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.Types.Filters.NormalToolsSourceCallback", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.Types.Filters.NormalToolsSourceCallback" }, { "type": "NullLiteral" } ] } }, "optional": true, "defaultvalue": null, "description": "The source of the rotation. If a function, it will be called to get the rotation. If a GameObject, it will be used to get the rotation from the GameObject's world transform. If null, the rotation will not be updated by the filter.]", "name": "rotationSource" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Manipulate the tendency for normals to face the camera. Higher values bend normals toward the camera; lower values bend them away. This can be useful for suggesting depth in a 2D scene.", "name": "facingPower" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If true, the output will be a grayscale texture, with the white area being the areas where the normals are facing the camera, fading to black when they're orthogonal. This can be useful as a base for other effects.", "name": "outputRatio" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "optional": true, "defaultvalue": "[0, 0, 1]", "description": "The vector to use for the ratio output. This is the direction in which the ratio will be calculated. The default is the camera's forward direction. Manipulate this to highlight parts of the map which are facing in a specific direction. This is only used if outputRatio is true.", "name": "ratioVector" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How much of a hemisphere to consider for the ratio output. At 1, the ratio will be calculated for the entire hemisphere. At 0, the ratio will be calculated for a single point. This uses the same algorithm as `PanoramaBlur.radius`. This is only used if outputRatio is true.", "name": "ratioRadius" } ], "memberof": "Phaser.Types.Filters", "longname": "Phaser.Types.Filters.NormalToolsConfig", "scope": "static", "___id": "T000002R007022", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Filters.NormalToolsSourceCallback\r\n * @since 4.0.0\r\n *\r\n * @return {number} The source of the rotation, in radians.\r\n */", "meta": { "filename": "NormalToolsSourceCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters\\typedefs", "code": {} }, "kind": "typedef", "name": "NormalToolsSourceCallback", "type": { "names": [ "function" ] }, "since": "4.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The source of the rotation, in radians." } ], "memberof": "Phaser.Types.Filters", "longname": "Phaser.Types.Filters.NormalToolsSourceCallback", "scope": "static", "___id": "T000002R007023", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Filters.PanoramaBlurConfig\r\n * @since 4.0.0\r\n *\r\n * @property {number} [radius=1] - The radius of the blur effect. 1 samples an entire hemisphere; 0 samples a single point.\r\n * @property {number} [samplesX=32] - The number of samples to take along the X axis. More samples produces a more accurate blur, but at the cost of performance. The X axis in a panorama is usually wider than the Y axis.\r\n * @property {number} [samplesY=16] - The number of samples to take along the Y axis. More samples produces a more accurate blur, but at the cost of performance.\r\n * @property {number} [power=1] - An exponent applied to samples. Power above 1 increases darkness, allowing brighter colors to dominate. Power below 1 increases brightness, reducing the influence of brighter colors. To simulate an HDR environment with bright sunlight that cannot be represented in sRGB color, use low power.\r\n */", "meta": { "filename": "PanoramaBlurConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters\\typedefs", "code": {} }, "kind": "typedef", "name": "PanoramaBlurConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The radius of the blur effect. 1 samples an entire hemisphere; 0 samples a single point.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The number of samples to take along the X axis. More samples produces a more accurate blur, but at the cost of performance. The X axis in a panorama is usually wider than the Y axis.", "name": "samplesX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 16, "description": "The number of samples to take along the Y axis. More samples produces a more accurate blur, but at the cost of performance.", "name": "samplesY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "An exponent applied to samples. Power above 1 increases darkness, allowing brighter colors to dominate. Power below 1 increases brightness, reducing the influence of brighter colors. To simulate an HDR environment with bright sunlight that cannot be represented in sRGB color, use low power.", "name": "power" } ], "memberof": "Phaser.Types.Filters", "longname": "Phaser.Types.Filters.PanoramaBlurConfig", "scope": "static", "___id": "T000002R007024", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Filters.QuantizeConfig\r\n * @since 4.0.0\r\n *\r\n * @property {number[]} [steps=[ 8, 8, 8, 8 ]] - Number of steps to use per channel.\r\n * @property {number[]} [gamma=[ 1, 1, 1, 1 ]] - Gamma power to apply per channel.\r\n * @property {number[]} [offset=[ 0, 0, 0, 0 ]] - Offset to apply per channel.\r\n * @property {boolean} [dither=false] - Whether to dither the quantization.\r\n * @property {number} [mode=0] - Color space mode. 0 is RGBA. 1 is HSVA. Use HSVA for better treatment of hues.\r\n */", "meta": { "filename": "QuantizeConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters\\typedefs", "code": {} }, "kind": "typedef", "name": "QuantizeConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 8, 8, 8, 8 ]", "description": "Number of steps to use per channel.", "name": "steps" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 1, 1, 1, 1 ]", "description": "Gamma power to apply per channel.", "name": "gamma" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 0, 0, 0, 0 ]", "description": "Offset to apply per channel.", "name": "offset" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to dither the quantization.", "name": "dither" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Color space mode. 0 is RGBA. 1 is HSVA. Use HSVA for better treatment of hues.", "name": "mode" } ], "memberof": "Phaser.Types.Filters", "longname": "Phaser.Types.Filters.QuantizeConfig", "scope": "static", "___id": "T000002R007025", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Vignette Filter Controller.\r\n *\r\n * This controller manages the vignette effect for a Camera.\r\n *\r\n * The vignette effect is a visual technique where the edges of the screen,\r\n * or a Game Object, gradually darken or blur,\r\n * creating a frame-like appearance. This effect is used to draw the player's\r\n * focus towards the central action or subject, enhance immersion,\r\n * and provide a cinematic or artistic quality to the game's visuals.\r\n *\r\n * This filter supports colored borders, and a limited set of blend modes,\r\n * to increase its stylistic power.\r\n *\r\n * A Vignette effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n *\r\n * camera.filters.internal.addVignette();\r\n * camera.filters.external.addVignette();\r\n * ```\r\n *\r\n * @class Vignette\r\n * @extends Phaser.Filters.Controller\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that owns this filter.\r\n * @param {number} [x=0.5] - The horizontal offset of the vignette effect. This value is normalized to the range 0 to 1.\r\n * @param {number} [y=0.5] - The vertical offset of the vignette effect. This value is normalized to the range 0 to 1.\r\n * @param {number} [radius=0.5] - The radius of the vignette effect. This value is normalized to the range 0 to 1.\r\n * @param {number} [strength=0.5] - The strength of the vignette effect.\r\n * @param {number | string | Phaser.Types.Display.InputColorObject | Phaser.Display.Color} [color=0x000000] - The color of the vignette effect, as a hex code or Color object.\r\n * @param {number} [blendMode=Phaser.BlendModes.NORMAL] - The blend mode to use with the vignette. Only NORMAL, ADD, MULTIPLY, and SCREEN are supported.\r\n */", "meta": { "filename": "Vignette.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Vignette Filter Controller.\r\rThis controller manages the vignette effect for a Camera.\r\rThe vignette effect is a visual technique where the edges of the screen,\ror a Game Object, gradually darken or blur,\rcreating a frame-like appearance. This effect is used to draw the player's\rfocus towards the central action or subject, enhance immersion,\rand provide a cinematic or artistic quality to the game's visuals.\r\rThis filter supports colored borders, and a limited set of blend modes,\rto increase its stylistic power.\r\rA Vignette effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\r\rcamera.filters.internal.addVignette();\rcamera.filters.external.addVignette();\r```", "kind": "class", "name": "Vignette", "augments": [ "Phaser.Filters.Controller" ], "memberof": "Phaser.Filters", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The horizontal offset of the vignette effect. This value is normalized to the range 0 to 1.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The vertical offset of the vignette effect. This value is normalized to the range 0 to 1.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The radius of the vignette effect. This value is normalized to the range 0 to 1.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The strength of the vignette effect.", "name": "strength" }, { "type": { "names": [ "number", "string", "Phaser.Types.Display.InputColorObject", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Display.InputColorObject" }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color of the vignette effect, as a hex code or Color object.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "Phaser.BlendModes.NORMAL", "description": "The blend mode to use with the vignette. Only NORMAL, ADD, MULTIPLY, and SCREEN are supported.", "name": "blendMode" } ], "scope": "static", "longname": "Phaser.Filters.Vignette", "___id": "T000002R007029", "___s": true }, { "comment": "/**\r\n * The horizontal offset of the vignette effect. This value is normalized to the range 0 to 1.\r\n *\r\n * @name Phaser.Filters.Vignette#x\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Vignette.js", "lineno": 64, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The horizontal offset of the vignette effect. This value is normalized to the range 0 to 1.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Vignette", "longname": "Phaser.Filters.Vignette#x", "scope": "instance", "kind": "member", "___id": "T000002R007039", "___s": true }, { "comment": "/**\r\n * The vertical offset of the vignette effect. This value is normalized to the range 0 to 1.\r\n *\r\n * @name Phaser.Filters.Vignette#y\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Vignette.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The vertical offset of the vignette effect. This value is normalized to the range 0 to 1.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Vignette", "longname": "Phaser.Filters.Vignette#y", "scope": "instance", "kind": "member", "___id": "T000002R007041", "___s": true }, { "comment": "/**\r\n * The radius of the vignette effect. This value is normalized to the range 0 to 1.\r\n *\r\n * @name Phaser.Filters.Vignette#radius\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Vignette.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The radius of the vignette effect. This value is normalized to the range 0 to 1.", "name": "radius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Vignette", "longname": "Phaser.Filters.Vignette#radius", "scope": "instance", "kind": "member", "___id": "T000002R007043", "___s": true }, { "comment": "/**\r\n * The strength of the vignette effect. Higher values produce a more\r\n * intense, opaque vignette overlay at the edges, while lower values\r\n * produce a subtler, more transparent effect.\r\n *\r\n * @name Phaser.Filters.Vignette#strength\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Vignette.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The strength of the vignette effect. Higher values produce a more\rintense, opaque vignette overlay at the edges, while lower values\rproduce a subtler, more transparent effect.", "name": "strength", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Vignette", "longname": "Phaser.Filters.Vignette#strength", "scope": "instance", "kind": "member", "___id": "T000002R007045", "___s": true }, { "comment": "/**\r\n * The color of the vignette effect.\r\n *\r\n * @name Phaser.Filters.Vignette#color\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Vignette.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The color of the vignette effect.", "name": "color", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Vignette", "longname": "Phaser.Filters.Vignette#color", "scope": "instance", "kind": "member", "___id": "T000002R007047", "___s": true }, { "comment": "/**\r\n * The blend mode used to combine the vignette color with the input.\r\n * Note that only NORMAL, ADD, MULTIPLY and SCREEN are supported.\r\n *\r\n * @name Phaser.Filters.Vignette#blendMode\r\n * @type {Phaser.BlendModes}\r\n * @since 4.0.0\r\n * @default Phaser.BlendModes.NORMAL\r\n */", "meta": { "filename": "Vignette.js", "lineno": 111, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The blend mode used to combine the vignette color with the input.\rNote that only NORMAL, ADD, MULTIPLY and SCREEN are supported.", "name": "blendMode", "type": { "names": [ "Phaser.BlendModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.BlendModes" } }, "since": "4.0.0", "defaultvalue": "Phaser.BlendModes.NORMAL", "memberof": "Phaser.Filters.Vignette", "longname": "Phaser.Filters.Vignette#blendMode", "scope": "instance", "kind": "member", "___id": "T000002R007049", "___s": true }, { "comment": "/**\r\n * Sets the color of the vignette overlay.\r\n *\r\n * @method Phaser.Filters.Vignette#setColor\r\n * @since 4.0.0\r\n * @param {number | string | Phaser.Types.Display.InputColorObject | Phaser.Display.Color} color - The color to set. Note that a Color object will be copied, not attached.\r\n * @return {this} This filter instance.\r\n */", "meta": { "filename": "Vignette.js", "lineno": 125, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets the color of the vignette overlay.", "kind": "function", "name": "setColor", "since": "4.0.0", "params": [ { "type": { "names": [ "number", "string", "Phaser.Types.Display.InputColorObject", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Display.InputColorObject" }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "description": "The color to set. Note that a Color object will be copied, not attached.", "name": "color" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This filter instance." } ], "memberof": "Phaser.Filters.Vignette", "longname": "Phaser.Filters.Vignette#setColor", "scope": "instance", "___id": "T000002R007051", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Wipe Filter Controller.\r\n *\r\n * This controller manages the wipe effect for a Camera.\r\n *\r\n * The wipe or reveal effect is a visual technique that gradually uncovers or conceals elements\r\n * in the game, such as images, text, or scene transitions. This effect is often used to create\r\n * a sense of progression, reveal hidden content, or provide a smooth and visually appealing transition\r\n * between game states.\r\n *\r\n * You can set both the direction and the axis of the wipe effect. The following combinations are possible:\r\n *\r\n * * left to right: direction 0, axis 0\r\n * * right to left: direction 1, axis 0\r\n * * top to bottom: direction 1, axis 1\r\n * * bottom to top: direction 0, axis 1\r\n *\r\n * It is up to you to set the `progress` value yourself, e.g. via a Tween, in order to transition the effect.\r\n *\r\n * A Wipe effect is added to a Camera via the FilterList component:\r\n *\r\n * ```js\r\n * const camera = this.cameras.main;\r\n * camera.filters.internal.addWipe();\r\n * camera.filters.external.addWipe();\r\n * ```\r\n *\r\n * @class Wipe\r\n * @extends Phaser.Filters.Controller\r\n * @memberof Phaser.Filters\r\n * @constructor\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that owns this filter.\r\n * @param {number} [wipeWidth=0.1] - The width of the wipe effect. This value is normalized in the range 0 to 1.\r\n * @param {number} [direction=0] - The direction of the wipe effect. Either 0 (left to right, or top to bottom) or 1 (right to left, or bottom to top). Set in conjunction with the axis property.\r\n * @param {number} [axis=0] - The axis of the wipe effect. Either 0 (X) or 1 (Y). Set in conjunction with the direction property.\r\n * @param {number} [reveal=0] - Is this a reveal (1) or a wipe (0) effect? Reveal shows the input in wiped areas; wipe shows the input in unwiped areas.\r\n * @param {string | Phaser.Textures.Texture} [wipeTexture='__DEFAULT'] - Texture or texture key to use where the input texture is not shown. The default texture is blank. Use another texture for a wipe transition.\r\n */", "meta": { "filename": "Wipe.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "classdesc": "The Wipe Filter Controller.\r\rThis controller manages the wipe effect for a Camera.\r\rThe wipe or reveal effect is a visual technique that gradually uncovers or conceals elements\rin the game, such as images, text, or scene transitions. This effect is often used to create\ra sense of progression, reveal hidden content, or provide a smooth and visually appealing transition\rbetween game states.\r\rYou can set both the direction and the axis of the wipe effect. The following combinations are possible:\r\r* left to right: direction 0, axis 0\r* right to left: direction 1, axis 0\r* top to bottom: direction 1, axis 1\r* bottom to top: direction 0, axis 1\r\rIt is up to you to set the `progress` value yourself, e.g. via a Tween, in order to transition the effect.\r\rA Wipe effect is added to a Camera via the FilterList component:\r\r```js\rconst camera = this.cameras.main;\rcamera.filters.internal.addWipe();\rcamera.filters.external.addWipe();\r```", "kind": "class", "name": "Wipe", "augments": [ "Phaser.Filters.Controller" ], "memberof": "Phaser.Filters", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera that owns this filter.", "name": "camera" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "The width of the wipe effect. This value is normalized in the range 0 to 1.", "name": "wipeWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The direction of the wipe effect. Either 0 (left to right, or top to bottom) or 1 (right to left, or bottom to top). Set in conjunction with the axis property.", "name": "direction" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The axis of the wipe effect. Either 0 (X) or 1 (Y). Set in conjunction with the direction property.", "name": "axis" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Is this a reveal (1) or a wipe (0) effect? Reveal shows the input in wiped areas; wipe shows the input in unwiped areas.", "name": "reveal" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "defaultvalue": "'__DEFAULT'", "description": "Texture or texture key to use where the input texture is not shown. The default texture is blank. Use another texture for a wipe transition.", "name": "wipeTexture" } ], "scope": "static", "longname": "Phaser.Filters.Wipe", "___id": "T000002R007057", "___s": true }, { "comment": "/**\r\n * The progress of the Wipe effect. This value is normalized to the range 0 to 1.\r\n *\r\n * Adjust this value to make the wipe transition (e.g. via a Tween).\r\n *\r\n * @name Phaser.Filters.Wipe#progress\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Wipe.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The progress of the Wipe effect. This value is normalized to the range 0 to 1.\r\rAdjust this value to make the wipe transition (e.g. via a Tween).", "name": "progress", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#progress", "scope": "instance", "kind": "member", "___id": "T000002R007062", "___s": true }, { "comment": "/**\r\n * The width of the wipe effect. This value is normalized in the range 0 to 1.\r\n *\r\n * @name Phaser.Filters.Wipe#wipeWidth\r\n * @type {number}\r\n * @since 4.0.0\r\n * @default 0.1\r\n */", "meta": { "filename": "Wipe.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The width of the wipe effect. This value is normalized in the range 0 to 1.", "name": "wipeWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "defaultvalue": "0.1", "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#wipeWidth", "scope": "instance", "kind": "member", "___id": "T000002R007064", "___s": true }, { "comment": "/**\r\n * The direction of the wipe effect. Either 0 (left to right, or top to bottom) or 1 (right to left, or bottom to top). Set in conjunction with the axis property.\r\n *\r\n * @name Phaser.Filters.Wipe#direction\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Wipe.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The direction of the wipe effect. Either 0 (left to right, or top to bottom) or 1 (right to left, or bottom to top). Set in conjunction with the axis property.", "name": "direction", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#direction", "scope": "instance", "kind": "member", "___id": "T000002R007066", "___s": true }, { "comment": "/**\r\n * The axis of the wipe effect. Either 0 (X) or 1 (Y). Set in conjunction with the direction property.\r\n *\r\n * @name Phaser.Filters.Wipe#axis\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Wipe.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The axis of the wipe effect. Either 0 (X) or 1 (Y). Set in conjunction with the direction property.", "name": "axis", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#axis", "scope": "instance", "kind": "member", "___id": "T000002R007068", "___s": true }, { "comment": "/**\r\n * Is this a reveal (1) or a wipe (0) effect?\r\n * Reveal shows the input in wiped areas;\r\n * wipe shows the input in unwiped areas.\r\n *\r\n * @name Phaser.Filters.Wipe#reveal\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Wipe.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Is this a reveal (1) or a wipe (0) effect?\rReveal shows the input in wiped areas;\rwipe shows the input in unwiped areas.", "name": "reveal", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#reveal", "scope": "instance", "kind": "member", "___id": "T000002R007070", "___s": true }, { "comment": "/**\r\n * The texture to use where the input is removed.\r\n * The default texture '__DEFAULT' is blank.\r\n * Use another texture for a wipe transition.\r\n *\r\n * @name Phaser.Filters.Wipe#wipeTexture\r\n * @type {Phaser.Textures.Texture}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Wipe.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "The texture to use where the input is removed.\rThe default texture '__DEFAULT' is blank.\rUse another texture for a wipe transition.", "name": "wipeTexture", "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "since": "4.0.0", "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#wipeTexture", "scope": "instance", "kind": "member", "___id": "T000002R007072", "___s": true }, { "comment": "/**\r\n * Set the width of the wipe effect.\r\n *\r\n * @method Phaser.Filters.Wipe#setWipeWidth\r\n * @since 4.0.0\r\n * @param {number} width - The width of the wipe effect. This value is normalized in the range 0 to 1.\r\n * @return {this} - This filter instance.\r\n */", "meta": { "filename": "Wipe.js", "lineno": 127, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Set the width of the wipe effect.", "kind": "function", "name": "setWipeWidth", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the wipe effect. This value is normalized in the range 0 to 1.", "name": "width" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "- This filter instance." } ], "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#setWipeWidth", "scope": "instance", "___id": "T000002R007074", "___s": true }, { "comment": "/**\r\n * Set the wipe effect to run left to right.\r\n *\r\n * @method Phaser.Filters.Wipe#setLeftToRight\r\n * @since 4.0.0\r\n * @return {this} - This filter instance.\r\n */", "meta": { "filename": "Wipe.js", "lineno": 145, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Set the wipe effect to run left to right.", "kind": "function", "name": "setLeftToRight", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "- This filter instance." } ], "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#setLeftToRight", "scope": "instance", "___id": "T000002R007078", "___s": true }, { "comment": "/**\r\n * Set the wipe effect to run right to left.\r\n *\r\n * @method Phaser.Filters.Wipe#setRightToLeft\r\n * @since 4.0.0\r\n * @return {this} - This filter instance.\r\n */", "meta": { "filename": "Wipe.js", "lineno": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Set the wipe effect to run right to left.", "kind": "function", "name": "setRightToLeft", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "- This filter instance." } ], "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#setRightToLeft", "scope": "instance", "___id": "T000002R007082", "___s": true }, { "comment": "/**\r\n * Set the wipe effect to run top to bottom.\r\n *\r\n * @method Phaser.Filters.Wipe#setTopToBottom\r\n * @since 4.0.0\r\n * @return {this} - This filter instance.\r\n */", "meta": { "filename": "Wipe.js", "lineno": 173, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Set the wipe effect to run top to bottom.", "kind": "function", "name": "setTopToBottom", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "- This filter instance." } ], "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#setTopToBottom", "scope": "instance", "___id": "T000002R007086", "___s": true }, { "comment": "/**\r\n * Set the wipe effect to run bottom to top.\r\n *\r\n * @method Phaser.Filters.Wipe#setBottomToTop\r\n * @since 4.0.0\r\n * @return {this} - This filter instance.\r\n */", "meta": { "filename": "Wipe.js", "lineno": 187, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Set the wipe effect to run bottom to top.", "kind": "function", "name": "setBottomToTop", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "- This filter instance." } ], "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#setBottomToTop", "scope": "instance", "___id": "T000002R007090", "___s": true }, { "comment": "/**\r\n * Configures this filter to run as a wipe effect, where the input is removed\r\n * as the transition progresses. Also resets `progress` to 0.\r\n * Use `setRevealEffect` for the opposite behavior.\r\n *\r\n * @method Phaser.Filters.Wipe#setWipeEffect\r\n * @since 4.0.0\r\n * @return {this} - This filter instance.\r\n */", "meta": { "filename": "Wipe.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Configures this filter to run as a wipe effect, where the input is removed\ras the transition progresses. Also resets `progress` to 0.\rUse `setRevealEffect` for the opposite behavior.", "kind": "function", "name": "setWipeEffect", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "- This filter instance." } ], "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#setWipeEffect", "scope": "instance", "___id": "T000002R007094", "___s": true }, { "comment": "/**\r\n * Configures this filter to run as a reveal effect, where the input is gradually\r\n * uncovered as the transition progresses. Also resets the texture to the default\r\n * blank texture and resets `progress` to 0.\r\n * Use `setWipeEffect` for the opposite behavior.\r\n *\r\n * @method Phaser.Filters.Wipe#setRevealEffect\r\n * @since 4.0.0\r\n * @return {this} - This filter instance.\r\n */", "meta": { "filename": "Wipe.js", "lineno": 217, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Configures this filter to run as a reveal effect, where the input is gradually\runcovered as the transition progresses. Also resets the texture to the default\rblank texture and resets `progress` to 0.\rUse `setWipeEffect` for the opposite behavior.", "kind": "function", "name": "setRevealEffect", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "- This filter instance." } ], "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#setRevealEffect", "scope": "instance", "___id": "T000002R007098", "___s": true }, { "comment": "/**\r\n * Set the texture to use where the input is removed.\r\n * The default texture is blank, so the input is just hidden.\r\n *\r\n * @method Phaser.Filters.Wipe#setTexture\r\n * @since 4.0.0\r\n * @param {string | Phaser.Textures.Texture} [texture='__DEFAULT'] - Texture or texture key to use for regions where the input is removed.\r\n * @return {this} - This filter instance.\r\n */", "meta": { "filename": "Wipe.js", "lineno": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Set the texture to use where the input is removed.\rThe default texture is blank, so the input is just hidden.", "kind": "function", "name": "setTexture", "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "defaultvalue": "'__DEFAULT'", "description": "Texture or texture key to use for regions where the input is removed.", "name": "texture" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "- This filter instance." } ], "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#setTexture", "scope": "instance", "___id": "T000002R007102", "___s": true }, { "comment": "/**\r\n * Sets the progress of the wipe effect, controlling how far along the transition\r\n * has advanced. A value of 0 means the transition has not started, and 1 means it\r\n * is complete. You would typically drive this via a Tween rather than setting it directly.\r\n *\r\n * @method Phaser.Filters.Wipe#setProgress\r\n * @since 4.0.0\r\n * @param {number} value - Progress, normalized to the range 0-1.\r\n * @return {this} - This filter instance.\r\n */", "meta": { "filename": "Wipe.js", "lineno": 262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\filters", "code": {} }, "description": "Sets the progress of the wipe effect, controlling how far along the transition\rhas advanced. A value of 0 means the transition has not started, and 1 means it\ris complete. You would typically drive this via a Tween rather than setting it directly.", "kind": "function", "name": "setProgress", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Progress, normalized to the range 0-1.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "- This filter instance." } ], "memberof": "Phaser.Filters.Wipe", "longname": "Phaser.Filters.Wipe#setProgress", "scope": "instance", "___id": "T000002R007107", "___s": true }, { "comment": "/**\r\n * A RetroFont character set containing the full printable ASCII range (space through tilde),\r\n * including both uppercase and lowercase letters, digits, and symbols.\r\n *\r\n * Text Set 1 = !\\\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\\\]^_`abcdefghijklmnopqrstuvwxyz{|}~\r\n *\r\n * @name Phaser.GameObjects.RetroFont.TEXT_SET1\r\n * @type {string}\r\n * @since 3.6.0\r\n */", "meta": { "filename": "const.js", "lineno": 9, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "A RetroFont character set containing the full printable ASCII range (space through tilde),\rincluding both uppercase and lowercase letters, digits, and symbols.\r\rText Set 1 = !\\\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\\\]^_`abcdefghijklmnopqrstuvwxyz{|}~", "name": "TEXT_SET1", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.6.0", "memberof": "Phaser.GameObjects.RetroFont", "longname": "Phaser.GameObjects.RetroFont.TEXT_SET1", "scope": "static", "kind": "member", "___id": "T000002R007148", "___s": true }, { "comment": "/**\r\n * A RetroFont character set containing printable ASCII characters from space through uppercase Z,\r\n * including digits and common symbols but no lowercase letters.\r\n *\r\n * Text Set 2 = !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ\r\n *\r\n * @name Phaser.GameObjects.RetroFont.TEXT_SET2\r\n * @type {string}\r\n * @since 3.6.0\r\n */", "meta": { "filename": "const.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "A RetroFont character set containing printable ASCII characters from space through uppercase Z,\rincluding digits and common symbols but no lowercase letters.\r\rText Set 2 = !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ", "name": "TEXT_SET2", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.6.0", "memberof": "Phaser.GameObjects.RetroFont", "longname": "Phaser.GameObjects.RetroFont.TEXT_SET2", "scope": "static", "kind": "member", "___id": "T000002R007150", "___s": true }, { "comment": "/**\r\n * A RetroFont character set containing uppercase letters followed by digits, with a trailing space.\r\n *\r\n * Text Set 3 = ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789\r\n *\r\n * @name Phaser.GameObjects.RetroFont.TEXT_SET3\r\n * @type {string}\r\n * @since 3.6.0\r\n */", "meta": { "filename": "const.js", "lineno": 33, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "A RetroFont character set containing uppercase letters followed by digits, with a trailing space.\r\rText Set 3 = ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789", "name": "TEXT_SET3", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.6.0", "memberof": "Phaser.GameObjects.RetroFont", "longname": "Phaser.GameObjects.RetroFont.TEXT_SET3", "scope": "static", "kind": "member", "___id": "T000002R007152", "___s": true }, { "comment": "/**\r\n * A RetroFont character set containing uppercase letters, a space, then digits. The space\r\n * character appears between the alphabet and the digits rather than at the end.\r\n *\r\n * Text Set 4 = ABCDEFGHIJKLMNOPQRSTUVWXYZ 0123456789\r\n *\r\n * @name Phaser.GameObjects.RetroFont.TEXT_SET4\r\n * @type {string}\r\n * @since 3.6.0\r\n */", "meta": { "filename": "const.js", "lineno": 44, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "A RetroFont character set containing uppercase letters, a space, then digits. The space\rcharacter appears between the alphabet and the digits rather than at the end.\r\rText Set 4 = ABCDEFGHIJKLMNOPQRSTUVWXYZ 0123456789", "name": "TEXT_SET4", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.6.0", "memberof": "Phaser.GameObjects.RetroFont", "longname": "Phaser.GameObjects.RetroFont.TEXT_SET4", "scope": "static", "kind": "member", "___id": "T000002R007154", "___s": true }, { "comment": "/**\r\n * A RetroFont character set containing uppercase letters followed by common punctuation\r\n * symbols and digits. Useful for fonts that include sentence punctuation such as periods,\r\n * commas, parentheses, and question marks.\r\n *\r\n * Text Set 5 = ABCDEFGHIJKLMNOPQRSTUVWXYZ.,/() '!?-*:0123456789\r\n *\r\n * @name Phaser.GameObjects.RetroFont.TEXT_SET5\r\n * @type {string}\r\n * @since 3.6.0\r\n */", "meta": { "filename": "const.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "A RetroFont character set containing uppercase letters followed by common punctuation\rsymbols and digits. Useful for fonts that include sentence punctuation such as periods,\rcommas, parentheses, and question marks.\r\rText Set 5 = ABCDEFGHIJKLMNOPQRSTUVWXYZ.,/() '!?-*:0123456789", "name": "TEXT_SET5", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.6.0", "memberof": "Phaser.GameObjects.RetroFont", "longname": "Phaser.GameObjects.RetroFont.TEXT_SET5", "scope": "static", "kind": "member", "___id": "T000002R007156", "___s": true }, { "comment": "/**\r\n * A RetroFont character set containing uppercase letters, digits, and a range of punctuation\r\n * symbols including quotes, parentheses, and a trailing space.\r\n *\r\n * Text Set 6 = ABCDEFGHIJKLMNOPQRSTUVWXYZ!?:;0123456789\"(),-.`\r\n *\r\n * @name Phaser.GameObjects.RetroFont.TEXT_SET6\r\n * @type {string}\r\n * @since 3.6.0\r\n */", "meta": { "filename": "const.js", "lineno": 69, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "A RetroFont character set containing uppercase letters, digits, and a range of punctuation\rsymbols including quotes, parentheses, and a trailing space.\r\rText Set 6 = ABCDEFGHIJKLMNOPQRSTUVWXYZ!?:;0123456789\"(),-.`", "name": "TEXT_SET6", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.6.0", "memberof": "Phaser.GameObjects.RetroFont", "longname": "Phaser.GameObjects.RetroFont.TEXT_SET6", "scope": "static", "kind": "member", "___id": "T000002R007158", "___s": true }, { "comment": "/**\r\n * A RetroFont character set where the characters are arranged in a non-sequential,\r\n * interleaved order. This matches the sprite layout of certain retro font sheets where\r\n * every fifth character continues the sequence (A, G, M, S, Y, then B, H, N, T, Z, etc.).\r\n *\r\n * Text Set 7 = AGMSY+:4BHNTZ!;5CIOU.?06DJPV,(17EKQW\")28FLRX-'39\r\n *\r\n * @name Phaser.GameObjects.RetroFont.TEXT_SET7\r\n * @type {string}\r\n * @since 3.6.0\r\n */", "meta": { "filename": "const.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "A RetroFont character set where the characters are arranged in a non-sequential,\rinterleaved order. This matches the sprite layout of certain retro font sheets where\revery fifth character continues the sequence (A, G, M, S, Y, then B, H, N, T, Z, etc.).\r\rText Set 7 = AGMSY+:4BHNTZ!;5CIOU.?06DJPV,(17EKQW\")28FLRX-'39", "name": "TEXT_SET7", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.6.0", "memberof": "Phaser.GameObjects.RetroFont", "longname": "Phaser.GameObjects.RetroFont.TEXT_SET7", "scope": "static", "kind": "member", "___id": "T000002R007160", "___s": true }, { "comment": "/**\r\n * A RetroFont character set where digits come first, followed by a space, period, and then\r\n * uppercase letters. Use this when the font sprite sheet places numerals before the alphabet.\r\n *\r\n * Text Set 8 = 0123456789 .ABCDEFGHIJKLMNOPQRSTUVWXYZ\r\n *\r\n * @name Phaser.GameObjects.RetroFont.TEXT_SET8\r\n * @type {string}\r\n * @since 3.6.0\r\n */", "meta": { "filename": "const.js", "lineno": 94, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "A RetroFont character set where digits come first, followed by a space, period, and then\ruppercase letters. Use this when the font sprite sheet places numerals before the alphabet.\r\rText Set 8 = 0123456789 .ABCDEFGHIJKLMNOPQRSTUVWXYZ", "name": "TEXT_SET8", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.6.0", "memberof": "Phaser.GameObjects.RetroFont", "longname": "Phaser.GameObjects.RetroFont.TEXT_SET8", "scope": "static", "kind": "member", "___id": "T000002R007162", "___s": true }, { "comment": "/**\r\n * A RetroFont character set containing uppercase letters, parentheses and a hyphen, digits,\r\n * and common sentence punctuation including quotes and an exclamation mark.\r\n *\r\n * Text Set 9 = ABCDEFGHIJKLMNOPQRSTUVWXYZ()-0123456789.:,'\"?!\r\n *\r\n * @name Phaser.GameObjects.RetroFont.TEXT_SET9\r\n * @type {string}\r\n * @since 3.6.0\r\n */", "meta": { "filename": "const.js", "lineno": 106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "A RetroFont character set containing uppercase letters, parentheses and a hyphen, digits,\rand common sentence punctuation including quotes and an exclamation mark.\r\rText Set 9 = ABCDEFGHIJKLMNOPQRSTUVWXYZ()-0123456789.:,'\"?!", "name": "TEXT_SET9", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.6.0", "memberof": "Phaser.GameObjects.RetroFont", "longname": "Phaser.GameObjects.RetroFont.TEXT_SET9", "scope": "static", "kind": "member", "___id": "T000002R007164", "___s": true }, { "comment": "/**\r\n * A RetroFont character set containing only the 26 uppercase letters of the alphabet.\r\n * Use this for font sprite sheets that contain no digits, spaces, or punctuation glyphs.\r\n *\r\n * Text Set 10 = ABCDEFGHIJKLMNOPQRSTUVWXYZ\r\n *\r\n * @name Phaser.GameObjects.RetroFont.TEXT_SET10\r\n * @type {string}\r\n * @since 3.6.0\r\n */", "meta": { "filename": "const.js", "lineno": 118, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "A RetroFont character set containing only the 26 uppercase letters of the alphabet.\rUse this for font sprite sheets that contain no digits, spaces, or punctuation glyphs.\r\rText Set 10 = ABCDEFGHIJKLMNOPQRSTUVWXYZ", "name": "TEXT_SET10", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.6.0", "memberof": "Phaser.GameObjects.RetroFont", "longname": "Phaser.GameObjects.RetroFont.TEXT_SET10", "scope": "static", "kind": "member", "___id": "T000002R007166", "___s": true }, { "comment": "/**\r\n * A RetroFont character set containing uppercase letters, a broad selection of punctuation\r\n * symbols including quotes and arithmetic operators, followed by digits.\r\n *\r\n * Text Set 11 = ABCDEFGHIJKLMNOPQRSTUVWXYZ.,\"-+!?()':;0123456789\r\n *\r\n * @name Phaser.GameObjects.RetroFont.TEXT_SET11\r\n * @since 3.6.0\r\n * @type {string}\r\n */", "meta": { "filename": "const.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "A RetroFont character set containing uppercase letters, a broad selection of punctuation\rsymbols including quotes and arithmetic operators, followed by digits.\r\rText Set 11 = ABCDEFGHIJKLMNOPQRSTUVWXYZ.,\"-+!?()':;0123456789", "name": "TEXT_SET11", "since": "3.6.0", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "memberof": "Phaser.GameObjects.RetroFont", "longname": "Phaser.GameObjects.RetroFont.TEXT_SET11", "scope": "static", "kind": "member", "___id": "T000002R007168", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\r\n *\r\n * During rendering, each letter of the text is rendered to the display, proportionally spaced out and aligned to\r\n * match the font structure.\r\n *\r\n * Dynamic Bitmap Text objects are different from Static Bitmap Text in that they invoke a callback for each\r\n * letter being rendered during the render pass. This callback allows you to manipulate the properties of\r\n * each letter being rendered, such as its position, scale or tint, allowing you to create interesting effects\r\n * like jiggling text, which can't be done with Static text. This means that Dynamic Text takes more processing\r\n * time, so only use them if you require the callback ability they have.\r\n *\r\n * BitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability\r\n * to use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\r\n * processing the font texture in an image editor, applying fills and any other effects required.\r\n *\r\n * To create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\r\n *\r\n * To create a BitmapText data files you need a 3rd party app such as:\r\n *\r\n * BMFont (Windows, free): {@link http://www.angelcode.com/products/bmfont/|http://www.angelcode.com/products/bmfont/}\r\n * Glyph Designer (OS X, commercial): {@link http://www.71squared.com/en/glyphdesigner|http://www.71squared.com/en/glyphdesigner}\r\n * Snow BMF (Web-based, free): {@link https://snowb.org//|https://snowb.org/}\r\n * Littera (Flash-based, free): {@link http://kvazars.com/littera/|http://kvazars.com/littera/}\r\n *\r\n * For most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\r\n * converting 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}\r\n *\r\n * @class DynamicBitmapText\r\n * @extends Phaser.GameObjects.BitmapText\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. It can only belong to one Scene at any given time.\r\n * @param {number} x - The x coordinate of this Game Object in world space.\r\n * @param {number} y - The y coordinate of this Game Object in world space.\r\n * @param {string} font - The key of the font to use from the Bitmap Font cache.\r\n * @param {(string|string[])} [text] - The string, or array of strings, to be set as the content of this Bitmap Text.\r\n * @param {number} [size] - The font size of this Bitmap Text.\r\n * @param {number} [align=0] - The alignment of the text in a multi-line BitmapText object.\r\n */", "meta": { "filename": "DynamicBitmapText.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\dynamic", "code": {} }, "classdesc": "BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\r\rDuring rendering, each letter of the text is rendered to the display, proportionally spaced out and aligned to\rmatch the font structure.\r\rDynamic Bitmap Text objects are different from Static Bitmap Text in that they invoke a callback for each\rletter being rendered during the render pass. This callback allows you to manipulate the properties of\reach letter being rendered, such as its position, scale or tint, allowing you to create interesting effects\rlike jiggling text, which can't be done with Static text. This means that Dynamic Text takes more processing\rtime, so only use them if you require the callback ability they have.\r\rBitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability\rto use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\rprocessing the font texture in an image editor, applying fills and any other effects required.\r\rTo create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\r\rTo create a BitmapText data files you need a 3rd party app such as:\r\rBMFont (Windows, free): {@link http://www.angelcode.com/products/bmfont/|http://www.angelcode.com/products/bmfont/}\rGlyph Designer (OS X, commercial): {@link http://www.71squared.com/en/glyphdesigner|http://www.71squared.com/en/glyphdesigner}\rSnow BMF (Web-based, free): {@link https://snowb.org//|https://snowb.org/}\rLittera (Flash-based, free): {@link http://kvazars.com/littera/|http://kvazars.com/littera/}\r\rFor most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\rconverting 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": "DynamicBitmapText", "augments": [ "Phaser.GameObjects.BitmapText" ], "memberof": "Phaser.GameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of this Game Object in world space.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of this Game Object in world space.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the font to use from the Bitmap Font cache.", "name": "font" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The string, or array of strings, to be set as the content of this Bitmap Text.", "name": "text" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The font size of this Bitmap Text.", "name": "size" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The alignment of the text in a multi-line BitmapText object.", "name": "align" } ], "scope": "static", "longname": "Phaser.GameObjects.DynamicBitmapText", "___id": "T000002R007174", "___s": true }, { "comment": "/**\r\n * The horizontal scroll position of the Bitmap Text.\r\n *\r\n * @name Phaser.GameObjects.DynamicBitmapText#scrollX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DynamicBitmapText.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\dynamic", "code": {} }, "description": "The horizontal scroll position of the Bitmap Text.", "name": "scrollX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "longname": "Phaser.GameObjects.DynamicBitmapText#scrollX", "scope": "instance", "kind": "member", "___id": "T000002R007180", "___s": true }, { "comment": "/**\r\n * The vertical scroll position of the Bitmap Text.\r\n *\r\n * @name Phaser.GameObjects.DynamicBitmapText#scrollY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DynamicBitmapText.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\dynamic", "code": {} }, "description": "The vertical scroll position of the Bitmap Text.", "name": "scrollY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "longname": "Phaser.GameObjects.DynamicBitmapText#scrollY", "scope": "instance", "kind": "member", "___id": "T000002R007182", "___s": true }, { "comment": "/**\r\n * The crop width of the Bitmap Text.\r\n *\r\n * @name Phaser.GameObjects.DynamicBitmapText#cropWidth\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DynamicBitmapText.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\dynamic", "code": {} }, "description": "The crop width of the Bitmap Text.", "name": "cropWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "longname": "Phaser.GameObjects.DynamicBitmapText#cropWidth", "scope": "instance", "kind": "member", "___id": "T000002R007184", "___s": true }, { "comment": "/**\r\n * The crop height of the Bitmap Text.\r\n *\r\n * @name Phaser.GameObjects.DynamicBitmapText#cropHeight\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DynamicBitmapText.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\dynamic", "code": {} }, "description": "The crop height of the Bitmap Text.", "name": "cropHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "longname": "Phaser.GameObjects.DynamicBitmapText#cropHeight", "scope": "instance", "kind": "member", "___id": "T000002R007186", "___s": true }, { "comment": "/**\r\n * A callback that alters how each character of the Bitmap Text is rendered.\r\n *\r\n * @name Phaser.GameObjects.DynamicBitmapText#displayCallback\r\n * @type {Phaser.Types.GameObjects.BitmapText.DisplayCallback}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DynamicBitmapText.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\dynamic", "code": {} }, "description": "A callback that alters how each character of the Bitmap Text is rendered.", "name": "displayCallback", "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.DisplayCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.DisplayCallback" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "longname": "Phaser.GameObjects.DynamicBitmapText#displayCallback", "scope": "instance", "kind": "member", "___id": "T000002R007188", "___s": true }, { "comment": "/**\r\n * The data object that is populated during rendering, then passed to the displayCallback.\r\n * You should modify this object then return it back from the callback. Its updated values\r\n * will be used to render the specific glyph.\r\n *\r\n * Please note that if you need a reference to this object locally in your game code then you\r\n * should shallow copy it, as it's updated and re-used for every glyph in the text.\r\n *\r\n * @name Phaser.GameObjects.DynamicBitmapText#callbackData\r\n * @type {Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "DynamicBitmapText.js", "lineno": 119, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\dynamic", "code": {} }, "description": "The data object that is populated during rendering, then passed to the displayCallback.\rYou should modify this object then return it back from the callback. Its updated values\rwill be used to render the specific glyph.\r\rPlease note that if you need a reference to this object locally in your game code then you\rshould 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.DynamicBitmapText", "longname": "Phaser.GameObjects.DynamicBitmapText#callbackData", "scope": "instance", "kind": "member", "___id": "T000002R007190", "___s": true }, { "comment": "/**\r\n * Set the crop size of this Bitmap Text.\r\n *\r\n * @method Phaser.GameObjects.DynamicBitmapText#setSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width of the crop.\r\n * @param {number} height - The height of the crop.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "DynamicBitmapText.js", "lineno": 150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\dynamic", "code": {} }, "description": "Set the crop size of this Bitmap Text.", "kind": "function", "name": "setSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the crop.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the crop.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "longname": "Phaser.GameObjects.DynamicBitmapText#setSize", "scope": "instance", "___id": "T000002R007206", "___s": true }, { "comment": "/**\r\n * Set a callback that alters how each character of the Bitmap Text is rendered.\r\n *\r\n * The callback receives a {@link Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig} object that contains information about the character that's\r\n * about to be rendered.\r\n *\r\n * It should return an object with `x`, `y`, `scale` and `rotation` properties that will be used instead of the\r\n * usual values when rendering.\r\n *\r\n * @method Phaser.GameObjects.DynamicBitmapText#setDisplayCallback\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.BitmapText.DisplayCallback} callback - The display callback to set.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "DynamicBitmapText.js", "lineno": 169, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\dynamic", "code": {} }, "description": "Set a callback that alters how each character of the Bitmap Text is rendered.\r\rThe callback receives a {@link Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig} object that contains information about the character that's\rabout to be rendered.\r\rIt should return an object with `x`, `y`, `scale` and `rotation` properties that will be used instead of the\rusual values when rendering.", "kind": "function", "name": "setDisplayCallback", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.DisplayCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.DisplayCallback" } }, "description": "The display callback to set.", "name": "callback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "longname": "Phaser.GameObjects.DynamicBitmapText#setDisplayCallback", "scope": "instance", "___id": "T000002R007210", "___s": true }, { "comment": "/**\r\n * Set the horizontal scroll position of this Bitmap Text.\r\n *\r\n * @method Phaser.GameObjects.DynamicBitmapText#setScrollX\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The horizontal scroll position to set.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "DynamicBitmapText.js", "lineno": 192, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\dynamic", "code": {} }, "description": "Set the horizontal scroll position of this Bitmap Text.", "kind": "function", "name": "setScrollX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal scroll position to set.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "longname": "Phaser.GameObjects.DynamicBitmapText#setScrollX", "scope": "instance", "___id": "T000002R007213", "___s": true }, { "comment": "/**\r\n * Set the vertical scroll position of this Bitmap Text.\r\n *\r\n * @method Phaser.GameObjects.DynamicBitmapText#setScrollY\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The vertical scroll position to set.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "DynamicBitmapText.js", "lineno": 209, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\dynamic", "code": {} }, "description": "Set the vertical scroll position of this Bitmap Text.", "kind": "function", "name": "setScrollY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical scroll position to set.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.DynamicBitmapText", "longname": "Phaser.GameObjects.DynamicBitmapText#setScrollY", "scope": "instance", "___id": "T000002R007216", "___s": true }, { "comment": "/**\r\n * Creates a new Dynamic Bitmap Text Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Dynamic Bitmap Text Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#dynamicBitmapText\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.BitmapText.BitmapTextConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.DynamicBitmapText} The Game Object that was created.\r\n */", "meta": { "filename": "DynamicBitmapTextCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\dynamic", "code": {} }, "description": "Creates a new Dynamic Bitmap Text Game Object and returns it.\r\rNote: 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": [ "Phaser.Types.GameObjects.BitmapText.BitmapTextConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.BitmapTextConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.DynamicBitmapText" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#dynamicBitmapText", "scope": "instance", "___id": "T000002R007300", "___s": true }, { "comment": "/**\r\n * Creates a new Dynamic Bitmap Text Game Object and adds it to the Scene.\r\n * \r\n * BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\r\n * \r\n * During rendering, each letter of the text is rendered to the display, proportionally spaced out and aligned to\r\n * match the font structure.\r\n * \r\n * Dynamic Bitmap Text objects are different from Static Bitmap Text in that they invoke a callback for each\r\n * letter being rendered during the render pass. This callback allows you to manipulate the properties of\r\n * each letter being rendered, such as its position, scale or tint, allowing you to create interesting effects\r\n * like jiggling text, which can't be done with Static text. This means that Dynamic Text takes more processing\r\n * time, so only use them if you require the callback ability they have.\r\n *\r\n * BitmapText objects are less flexible than Text objects, in that they have fewer features such as shadows, fills and the ability\r\n * to use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\r\n * processing the font texture in an image editor, applying fills and any other effects required.\r\n *\r\n * To create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\r\n *\r\n * To create a BitmapText data files you need a 3rd party app such as:\r\n *\r\n * BMFont (Windows, free): http://www.angelcode.com/products/bmfont/\r\n * Glyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner\r\n * Littera (Web-based, free): http://kvazars.com/littera/\r\n *\r\n * For most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\r\n * converting a valid XML file through the popular X2JS library. An online tool for conversion can be found here: http://codebeautify.org/xmltojson\r\n *\r\n * Note: This method will only be available if the Dynamic Bitmap Text Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#dynamicBitmapText\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x position of the Game Object.\r\n * @param {number} y - The y position of the Game Object.\r\n * @param {string} font - The key of the font to use from the BitmapFont cache.\r\n * @param {(string|string[])} [text] - The string, or array of strings, to be set as the content of this Bitmap Text.\r\n * @param {number} [size] - The font size to set.\r\n *\r\n * @return {Phaser.GameObjects.DynamicBitmapText} The Game Object that was created.\r\n */", "meta": { "filename": "DynamicBitmapTextFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\dynamic", "code": {} }, "description": "Creates a new Dynamic Bitmap Text Game Object and adds it to the Scene.\r\rBitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\r\rDuring rendering, each letter of the text is rendered to the display, proportionally spaced out and aligned to\rmatch the font structure.\r\rDynamic Bitmap Text objects are different from Static Bitmap Text in that they invoke a callback for each\rletter being rendered during the render pass. This callback allows you to manipulate the properties of\reach letter being rendered, such as its position, scale or tint, allowing you to create interesting effects\rlike jiggling text, which can't be done with Static text. This means that Dynamic Text takes more processing\rtime, so only use them if you require the callback ability they have.\r\rBitmapText objects are less flexible than Text objects, in that they have fewer features such as shadows, fills and the ability\rto use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\rprocessing the font texture in an image editor, applying fills and any other effects required.\r\rTo create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\r\rTo create a BitmapText data files you need a 3rd party app such as:\r\rBMFont (Windows, free): http://www.angelcode.com/products/bmfont/\rGlyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner\rLittera (Web-based, free): http://kvazars.com/littera/\r\rFor most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\rconverting a valid XML file through the popular X2JS library. An online tool for conversion can be found here: http://codebeautify.org/xmltojson\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the Game Object.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the Game Object.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the font to use from the BitmapFont cache.", "name": "font" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The string, or array of strings, to be set as the content of this Bitmap Text.", "name": "text" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The font size to set.", "name": "size" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.DynamicBitmapText" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.DynamicBitmapText" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#dynamicBitmapText", "scope": "instance", "___id": "T000002R007309", "___s": true }, { "comment": "/**\r\n * Parses a Retro Font configuration object and builds a `BitmapFontData` structure that can\r\n * be passed to the BitmapText constructor to render text using a fixed-width retro font.\r\n *\r\n * A retro font is a texture containing a uniform grid of characters, each cell being the same\r\n * width and height. This function reads the configuration, looks up the source texture frame,\r\n * then iterates over every character defined in `config.chars`, calculating its pixel position\r\n * and normalised UV coordinates within the texture. The resulting data object maps each\r\n * character code to its own glyph entry and is suitable for registering in the Bitmap Font cache.\r\n *\r\n * If `config.chars` is an empty string the function returns `undefined` without producing any data.\r\n *\r\n * @function Phaser.GameObjects.RetroFont.Parse\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - A reference to the Phaser Scene.\r\n * @param {Phaser.Types.GameObjects.BitmapText.RetroFontConfig} config - The font configuration object.\r\n *\r\n * @return {Phaser.Types.GameObjects.BitmapText.BitmapFontData} A parsed Bitmap Font data entry containing per-character glyph data and UV coordinates, ready for the Bitmap Font cache.\r\n */", "meta": { "filename": "ParseRetroFont.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "description": "Parses a Retro Font configuration object and builds a `BitmapFontData` structure that can\rbe passed to the BitmapText constructor to render text using a fixed-width retro font.\r\rA retro font is a texture containing a uniform grid of characters, each cell being the same\rwidth and height. This function reads the configuration, looks up the source texture frame,\rthen iterates over every character defined in `config.chars`, calculating its pixel position\rand normalised UV coordinates within the texture. The resulting data object maps each\rcharacter code to its own glyph entry and is suitable for registering in the Bitmap Font cache.\r\rIf `config.chars` is an empty string the function returns `undefined` without producing any data.", "kind": "function", "name": "Parse", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "A reference to the Phaser Scene.", "name": "scene" }, { "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.RetroFontConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.RetroFontConfig" } }, "description": "The font configuration object.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.BitmapFontData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.BitmapFontData" } }, "description": "A parsed Bitmap Font data entry containing per-character glyph data and UV coordinates, ready for the Bitmap Font cache." } ], "memberof": "Phaser.GameObjects.RetroFont", "longname": "Phaser.GameObjects.RetroFont.Parse", "scope": "static", "___id": "T000002R007669", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.GameObjects.RetroFont\r\n * @since 3.6.0\r\n */", "meta": { "filename": "RetroFont.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext", "code": {} }, "kind": "namespace", "name": "RetroFont", "since": "3.6.0", "memberof": "Phaser.GameObjects", "longname": "Phaser.GameObjects.RetroFont", "scope": "static", "___id": "T000002R007792", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\r\n *\r\n * During rendering for each letter of the text is rendered to the display, proportionally spaced out and aligned to\r\n * match the font structure.\r\n *\r\n * BitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability\r\n * to use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\r\n * processing the font texture in an image editor, applying fills and any other effects required.\r\n *\r\n * To create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\r\n *\r\n * To create a BitmapText data files you need a 3rd party app such as:\r\n *\r\n * BMFont (Windows, free): {@link http://www.angelcode.com/products/bmfont/|http://www.angelcode.com/products/bmfont/}\r\n * Glyph Designer (OS X, commercial): {@link http://www.71squared.com/en/glyphdesigner|http://www.71squared.com/en/glyphdesigner}\r\n * Snow BMF (Web-based, free): {@link https://snowb.org//|https://snowb.org/}\r\n * Littera (Flash-based, free): {@link http://kvazars.com/littera/|http://kvazars.com/littera/}\r\n *\r\n * For most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\r\n * converting 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}\r\n *\r\n * @class BitmapText\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.GameObjects.Components.Alpha\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.GetBounds\r\n * @extends Phaser.GameObjects.Components.Lighting\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Texture\r\n * @extends Phaser.GameObjects.Components.Tint\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. It can only belong to one Scene at any given time.\r\n * @param {number} x - The x coordinate of this Game Object in world space.\r\n * @param {number} y - The y coordinate of this Game Object in world space.\r\n * @param {string} font - The key of the font to use from the Bitmap Font cache.\r\n * @param {(string|string[])} [text] - The string, or array of strings, to be set as the content of this Bitmap Text.\r\n * @param {number} [size] - The font size of this Bitmap Text.\r\n * @param {number} [align=0] - The alignment of the text in a multi-line BitmapText object.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "classdesc": "BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\r\rDuring rendering for each letter of the text is rendered to the display, proportionally spaced out and aligned to\rmatch the font structure.\r\rBitmapText objects are less flexible than Text objects, in that they have less features such as shadows, fills and the ability\rto use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\rprocessing the font texture in an image editor, applying fills and any other effects required.\r\rTo create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\r\rTo create a BitmapText data files you need a 3rd party app such as:\r\rBMFont (Windows, free): {@link http://www.angelcode.com/products/bmfont/|http://www.angelcode.com/products/bmfont/}\rGlyph Designer (OS X, commercial): {@link http://www.71squared.com/en/glyphdesigner|http://www.71squared.com/en/glyphdesigner}\rSnow BMF (Web-based, free): {@link https://snowb.org//|https://snowb.org/}\rLittera (Flash-based, free): {@link http://kvazars.com/littera/|http://kvazars.com/littera/}\r\rFor most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\rconverting 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.GetBounds", "Phaser.GameObjects.Components.Lighting", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.RenderNodes", "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of this Game Object in world space.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of this Game Object in world space.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the font to use from the Bitmap Font cache.", "name": "font" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The string, or array of strings, to be set as the content of this Bitmap Text.", "name": "text" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The font size of this Bitmap Text.", "name": "size" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The alignment of the text in a multi-line BitmapText object.", "name": "align" } ], "scope": "static", "longname": "Phaser.GameObjects.BitmapText", "___id": "T000002R007808", "___s": true }, { "comment": "/**\r\n * The key of the Bitmap Font used by this Bitmap Text.\r\n * To change the font after creation please use `setFont`.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#font\r\n * @type {string}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "The key of the Bitmap Font used by this Bitmap Text.\rTo change the font after creation please use `setFont`.", "name": "font", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#font", "scope": "instance", "kind": "member", "___id": "T000002R007815", "___s": true }, { "comment": "/**\r\n * The data of the Bitmap Font used by this Bitmap Text.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#fontData\r\n * @type {Phaser.Types.GameObjects.BitmapText.BitmapFontData}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 118, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "The data of the Bitmap Font used by this Bitmap Text.", "name": "fontData", "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.BitmapFontData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.BitmapFontData" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#fontData", "scope": "instance", "kind": "member", "___id": "T000002R007818", "___s": true }, { "comment": "/**\r\n * The character code used to detect for word wrapping.\r\n * Defaults to 32 (a space character).\r\n *\r\n * @name Phaser.GameObjects.BitmapText#wordWrapCharCode\r\n * @type {number}\r\n * @since 3.21.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 222, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "The character code used to detect for word wrapping.\rDefaults to 32 (a space character).", "name": "wordWrapCharCode", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.21.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#wordWrapCharCode", "scope": "instance", "kind": "member", "___id": "T000002R007836", "___s": true }, { "comment": "/**\r\n * The horizontal offset of the drop shadow.\r\n *\r\n * You can set this directly, or use `Phaser.GameObjects.BitmapText#setDropShadow`.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#dropShadowX\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 242, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "The horizontal offset of the drop shadow.\r\rYou can set this directly, or use `Phaser.GameObjects.BitmapText#setDropShadow`.", "name": "dropShadowX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#dropShadowX", "scope": "instance", "kind": "member", "___id": "T000002R007840", "___s": true }, { "comment": "/**\r\n * The vertical offset of the drop shadow.\r\n *\r\n * You can set this directly, or use `Phaser.GameObjects.BitmapText#setDropShadow`.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#dropShadowY\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 253, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "The vertical offset of the drop shadow.\r\rYou can set this directly, or use `Phaser.GameObjects.BitmapText#setDropShadow`.", "name": "dropShadowY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#dropShadowY", "scope": "instance", "kind": "member", "___id": "T000002R007842", "___s": true }, { "comment": "/**\r\n * The color of the drop shadow.\r\n *\r\n * You can set this directly, or use `Phaser.GameObjects.BitmapText#setDropShadow`.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#dropShadowColor\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 264, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "The color of the drop shadow.\r\rYou can set this directly, or use `Phaser.GameObjects.BitmapText#setDropShadow`.", "name": "dropShadowColor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#dropShadowColor", "scope": "instance", "kind": "member", "___id": "T000002R007844", "___s": true }, { "comment": "/**\r\n * The alpha value of the drop shadow.\r\n *\r\n * You can set this directly, or use `Phaser.GameObjects.BitmapText#setDropShadow`.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#dropShadowAlpha\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 275, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "The alpha value of the drop shadow.\r\rYou can set this directly, or use `Phaser.GameObjects.BitmapText#setDropShadow`.", "name": "dropShadowAlpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#dropShadowAlpha", "scope": "instance", "kind": "member", "___id": "T000002R007846", "___s": true }, { "comment": "/**\r\n * Indicates whether the font texture is from an atlas or not.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#fromAtlas\r\n * @type {boolean}\r\n * @since 3.54.0\r\n * @readonly\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 286, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Indicates whether the font texture is from an atlas or not.", "name": "fromAtlas", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.54.0", "readonly": true, "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#fromAtlas", "scope": "instance", "kind": "member", "___id": "T000002R007848", "___s": true }, { "comment": "/**\r\n * Set the lines of text in this BitmapText to be left-aligned.\r\n * This only has any effect if this BitmapText contains more than one line of text.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#setLeftAlign\r\n * @since 3.11.0\r\n *\r\n * @return {this} This BitmapText Object.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 321, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Set the lines of text in this BitmapText to be left-aligned.\rThis 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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#setLeftAlign", "scope": "instance", "___id": "T000002R007853", "___s": true }, { "comment": "/**\r\n * Set the lines of text in this BitmapText to be center-aligned.\r\n * This only has any effect if this BitmapText contains more than one line of text.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#setCenterAlign\r\n * @since 3.11.0\r\n *\r\n * @return {this} This BitmapText Object.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 339, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Set the lines of text in this BitmapText to be center-aligned.\rThis 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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#setCenterAlign", "scope": "instance", "___id": "T000002R007857", "___s": true }, { "comment": "/**\r\n * Set the lines of text in this BitmapText to be right-aligned.\r\n * This only has any effect if this BitmapText contains more than one line of text.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#setRightAlign\r\n * @since 3.11.0\r\n *\r\n * @return {this} This BitmapText Object.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Set the lines of text in this BitmapText to be right-aligned.\rThis 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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#setRightAlign", "scope": "instance", "___id": "T000002R007861", "___s": true }, { "comment": "/**\r\n * Set the font size of this Bitmap Text.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#setFontSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} size - The font size to set.\r\n *\r\n * @return {this} This BitmapText Object.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 375, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Set the font size of this Bitmap Text.", "kind": "function", "name": "setFontSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The font size to set.", "name": "size" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#setFontSize", "scope": "instance", "___id": "T000002R007865", "___s": true }, { "comment": "/**\r\n * Sets the letter spacing between each character of this Bitmap Text.\r\n * Can be a positive value to increase the space, or negative to reduce it.\r\n * Spacing is applied after the kerning values have been set.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#setLetterSpacing\r\n * @since 3.4.0\r\n *\r\n * @param {number} [spacing=0] - The amount of horizontal space to add between each character.\r\n *\r\n * @return {this} This BitmapText Object.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 394, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Sets the letter spacing between each character of this Bitmap Text.\rCan be a positive value to increase the space, or negative to reduce it.\rSpacing is applied after the kerning values have been set.", "kind": "function", "name": "setLetterSpacing", "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount of horizontal space to add between each character.", "name": "spacing" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#setLetterSpacing", "scope": "instance", "___id": "T000002R007869", "___s": true }, { "comment": "/**\r\n * Sets the line spacing value. This value is added to the font height to\r\n * calculate the overall line height.\r\n *\r\n * Spacing can be a negative or positive number.\r\n *\r\n * Only has an effect if this BitmapText object contains multiple lines of text.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#setLineSpacing\r\n * @since 3.60.0\r\n *\r\n * @param {number} [spacing=0] - The amount of space to add between each line in multi-line text.\r\n *\r\n * @return {this} This BitmapText Object.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 417, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Sets the line spacing value. This value is added to the font height to\rcalculate the overall line height.\r\rSpacing can be a negative or positive number.\r\rOnly has an effect if this BitmapText object contains multiple lines of text.", "kind": "function", "name": "setLineSpacing", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amount of space to add between each line in multi-line text.", "name": "spacing" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#setLineSpacing", "scope": "instance", "___id": "T000002R007874", "___s": true }, { "comment": "/**\r\n * Set the textual content of this BitmapText.\r\n *\r\n * An array of strings will be converted into multi-line text. Use the align methods to change multi-line alignment.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#setText\r\n * @since 3.0.0\r\n *\r\n * @param {(string|string[])} value - The string, or array of strings, to be set as the content of this BitmapText.\r\n *\r\n * @return {this} This BitmapText Object.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 441, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Set the textual content of this BitmapText.\r\rAn 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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "description": "The string, or array of strings, to be set as the content of this BitmapText.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#setText", "scope": "instance", "___id": "T000002R007878", "___s": true }, { "comment": "/**\r\n * Sets a drop shadow effect on this Bitmap Text.\r\n *\r\n * This is a WebGL only feature and only works with Static Bitmap Text, not Dynamic.\r\n *\r\n * You can set the vertical and horizontal offset of the shadow, as well as the color and alpha.\r\n *\r\n * Once a shadow has been enabled you can modify the `dropShadowX` and `dropShadowY` properties of this\r\n * Bitmap Text directly to adjust the position of the shadow in real-time.\r\n *\r\n * If you wish to clear the shadow, call this method with no parameters specified.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#setDropShadow\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {number} [x=0] - The horizontal offset of the drop shadow.\r\n * @param {number} [y=0] - The vertical offset of the drop shadow.\r\n * @param {number} [color=0x000000] - The color of the drop shadow, given as a hex value, i.e. `0x000000` for black.\r\n * @param {number} [alpha=0.5] - The alpha of the drop shadow, given as a float between 0 and 1. This is combined with the Bitmap Text alpha as well.\r\n *\r\n * @return {this} This BitmapText Object.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 477, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Sets a drop shadow effect on this Bitmap Text.\r\rThis is a WebGL only feature and only works with Static Bitmap Text, not Dynamic.\r\rYou can set the vertical and horizontal offset of the shadow, as well as the color and alpha.\r\rOnce a shadow has been enabled you can modify the `dropShadowX` and `dropShadowY` properties of this\rBitmap Text directly to adjust the position of the shadow in real-time.\r\rIf you wish to clear the shadow, call this method with no parameters specified.", "kind": "function", "name": "setDropShadow", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal offset of the drop shadow.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical offset of the drop shadow.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x000000", "description": "The color of the drop shadow, given as a hex value, i.e. `0x000000` for black.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The alpha of the drop shadow, given as a float between 0 and 1. This is combined with the Bitmap Text alpha as well.", "name": "alpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#setDropShadow", "scope": "instance", "___id": "T000002R007884", "___s": true }, { "comment": "/**\r\n * Sets a tint on a range of characters in this Bitmap Text, starting from the `start` parameter index\r\n * and running for `length` quantity of characters.\r\n *\r\n * The `start` parameter can be negative. In this case, it starts at the end of the text and counts\r\n * backwards `start` places.\r\n *\r\n * You can also pass in -1 as the `length` and it will tint all characters from `start`\r\n * up until the end of the string.\r\n\r\n * Remember that spaces and punctuation count as characters.\r\n *\r\n * This is a WebGL only feature and only works with Static Bitmap Text, not Dynamic.\r\n *\r\n * The tint applies a color to the pixel color values\r\n * from the Bitmap Text texture in one of several modes:\r\n *\r\n * - Phaser.TintModes.MULTIPLY (default)\r\n * - Phaser.TintModes.FILL\r\n * - Phaser.TintModes.ADD\r\n * - Phaser.TintModes.SCREEN\r\n * - Phaser.TintModes.OVERLAY\r\n * - Phaser.TintModes.HARD_LIGHT\r\n *\r\n * You can provide either one color value,\r\n * in which case the whole character will be tinted in that color. Or you can provide a color\r\n * per corner. The colors are blended together across the extent of the character range.\r\n *\r\n * To modify the tint color once set, call this method again with new color values.\r\n *\r\n * Using `setWordTint` can override tints set by this function, and vice versa.\r\n *\r\n * To remove a tint call this method with just the `start`, and optionally, the `length` parameters defined.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#setCharacterTint\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {number} [start=0] - The starting character to begin the tint at. If negative, it counts back from the end of the text.\r\n * @param {number} [length=1] - The number of characters to tint. Remember that spaces count as a character too. Pass -1 to tint all characters from `start` onwards.\r\n * @param {number} [tintMode=Phaser.TintModes.MULTIPLY] - The tint mode to use.\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the character. If no other values are given this value is applied evenly, tinting the whole character.\r\n * @param {number} [topRight] - The tint being applied to the top-right of the character.\r\n * @param {number} [bottomLeft] - The tint being applied to the bottom-left of the character.\r\n * @param {number} [bottomRight] - The tint being applied to the bottom-right of the character.\r\n *\r\n * @return {this} This BitmapText Object.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Sets a tint on a range of characters in this Bitmap Text, starting from the `start` parameter index\rand running for `length` quantity of characters.\r\rThe `start` parameter can be negative. In this case, it starts at the end of the text and counts\rbackwards `start` places.\r\rYou can also pass in -1 as the `length` and it will tint all characters from `start`\rup until the end of the string.\rRemember that spaces and punctuation count as characters.\r\rThis is a WebGL only feature and only works with Static Bitmap Text, not Dynamic.\r\rThe tint applies a color to the pixel color values\rfrom the Bitmap Text texture in one of several modes:\r\r- Phaser.TintModes.MULTIPLY (default)\r- Phaser.TintModes.FILL\r- Phaser.TintModes.ADD\r- Phaser.TintModes.SCREEN\r- Phaser.TintModes.OVERLAY\r- Phaser.TintModes.HARD_LIGHT\r\rYou can provide either one color value,\rin which case the whole character will be tinted in that color. Or you can provide a color\rper corner. The colors are blended together across the extent of the character range.\r\rTo modify the tint color once set, call this method again with new color values.\r\rUsing `setWordTint` can override tints set by this function, and vice versa.\r\rTo remove a tint call this method with just the `start`, and optionally, the `length` parameters defined.", "kind": "function", "name": "setCharacterTint", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The starting character to begin the tint at. If negative, it counts back from the end of the text.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The number of characters to tint. Remember that spaces count as a character too. Pass -1 to tint all characters from `start` onwards.", "name": "length" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "Phaser.TintModes.MULTIPLY", "description": "The tint mode to use.", "name": "tintMode" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The tint being applied to the top-left of the character. If no other values are given this value is applied evenly, tinting the whole character.", "name": "topLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint being applied to the top-right of the character.", "name": "topRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint being applied to the bottom-left of the character.", "name": "bottomLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint being applied to the bottom-right of the character.", "name": "bottomRight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#setCharacterTint", "scope": "instance", "___id": "T000002R007894", "___s": true }, { "comment": "/**\r\n * Sets a tint on a matching word within this Bitmap Text.\r\n *\r\n * The `word` parameter can be either a string or a number.\r\n *\r\n * If a string, it will run a string comparison against the text contents, and if matching,\r\n * it will tint the whole word.\r\n *\r\n * If a number, it will tint that word, based on its index within the words array.\r\n *\r\n * The `count` parameter controls how many words are replaced. Pass in -1 to replace them all.\r\n *\r\n * This parameter is ignored if you pass a number as the `word` to be searched for.\r\n *\r\n * This is a WebGL only feature and only works with Static Bitmap Text, not Dynamic.\r\n *\r\n * The tint applies a color to the pixel color values\r\n * from the Bitmap Text texture in one of several modes:\r\n *\r\n * - Phaser.TintModes.MULTIPLY (default)\r\n * - Phaser.TintModes.FILL\r\n * - Phaser.TintModes.ADD\r\n * - Phaser.TintModes.SCREEN\r\n * - Phaser.TintModes.OVERLAY\r\n * - Phaser.TintModes.HARD_LIGHT\r\n *\r\n * You can provide either one color value,\r\n * in which case the whole character will be tinted in that color. Or you can provide a color\r\n * per corner. The colors are blended together across the extent of the character range.\r\n *\r\n * To modify the tint color once set, call this method again with new color values.\r\n *\r\n * Using `setCharacterTint` can override tints set by this function, and vice versa.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#setWordTint\r\n * @webglOnly\r\n * @since 3.50.0\r\n *\r\n * @param {(string|number)} word - The word to search for. Either a string, or an index of the word in the words array.\r\n * @param {number} [count=1] - The number of matching words to tint. Pass -1 to tint all matching words.\r\n * @param {number} [tintMode=Phaser.TintModes.MULTIPLY] - The tint mode to use.\r\n * @param {number} [topLeft=0xffffff] - The tint being applied to the top-left of the word. If no other values are given this value is applied evenly, tinting the whole word.\r\n * @param {number} [topRight] - The tint being applied to the top-right of the word.\r\n * @param {number} [bottomLeft] - The tint being applied to the bottom-left of the word.\r\n * @param {number} [bottomRight] - The tint being applied to the bottom-right of the word.\r\n *\r\n * @return {this} This BitmapText Object.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 631, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Sets a tint on a matching word within this Bitmap Text.\r\rThe `word` parameter can be either a string or a number.\r\rIf a string, it will run a string comparison against the text contents, and if matching,\rit will tint the whole word.\r\rIf a number, it will tint that word, based on its index within the words array.\r\rThe `count` parameter controls how many words are replaced. Pass in -1 to replace them all.\r\rThis parameter is ignored if you pass a number as the `word` to be searched for.\r\rThis is a WebGL only feature and only works with Static Bitmap Text, not Dynamic.\r\rThe tint applies a color to the pixel color values\rfrom the Bitmap Text texture in one of several modes:\r\r- Phaser.TintModes.MULTIPLY (default)\r- Phaser.TintModes.FILL\r- Phaser.TintModes.ADD\r- Phaser.TintModes.SCREEN\r- Phaser.TintModes.OVERLAY\r- Phaser.TintModes.HARD_LIGHT\r\rYou can provide either one color value,\rin which case the whole character will be tinted in that color. Or you can provide a color\rper corner. The colors are blended together across the extent of the character range.\r\rTo modify the tint color once set, call this method again with new color values.\r\rUsing `setCharacterTint` can override tints set by this function, and vice versa.", "kind": "function", "name": "setWordTint", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.50.0", "params": [ { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The word to search for. Either a string, or an index of the word in the words array.", "name": "word" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The number of matching words to tint. Pass -1 to tint all matching words.", "name": "count" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "Phaser.TintModes.MULTIPLY", "description": "The tint mode to use.", "name": "tintMode" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The tint being applied to the top-left of the word. If no other values are given this value is applied evenly, tinting the whole word.", "name": "topLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint being applied to the top-right of the word.", "name": "topRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint being applied to the bottom-left of the word.", "name": "bottomLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint being applied to the bottom-right of the word.", "name": "bottomRight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#setWordTint", "scope": "instance", "___id": "T000002R007924", "___s": true }, { "comment": "/**\r\n * Calculate the bounds of this Bitmap Text.\r\n *\r\n * An object is returned that contains the position, width and height of the Bitmap Text in local and global\r\n * contexts.\r\n *\r\n * Local size is based on just the font size and a [0, 0] position.\r\n *\r\n * Global size takes into account the Game Object's scale, world position and display origin.\r\n *\r\n * Also in the object is data regarding the length of each line, should this be a multi-line BitmapText.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#getTextBounds\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [round=false] - Whether to round the results up to the nearest integer.\r\n *\r\n * @return {Phaser.Types.GameObjects.BitmapText.BitmapTextSize} An object that describes the size of this Bitmap Text.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 711, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Calculate the bounds of this Bitmap Text.\r\rAn object is returned that contains the position, width and height of the Bitmap Text in local and global\rcontexts.\r\rLocal size is based on just the font size and a [0, 0] position.\r\rGlobal size takes into account the Game Object's scale, world position and display origin.\r\rAlso 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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to round the results up to the nearest integer.", "name": "round" } ], "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.BitmapTextSize" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R007933", "___s": true }, { "comment": "/**\r\n * Gets the character located at the given x/y coordinate within this Bitmap Text.\r\n *\r\n * The coordinates you pass in are translated into the local space of the\r\n * Bitmap Text, however, it is up to you to first translate the input coordinates to world space.\r\n *\r\n * If you wish to use this in combination with an input event, be sure\r\n * to pass in `Pointer.worldX` and `worldY` so they are in world space.\r\n *\r\n * In some cases, based on kerning, characters can overlap. When this happens,\r\n * the first character in the word is returned.\r\n *\r\n * Note that this does not work for DynamicBitmapText if you have changed the\r\n * character positions during render. It will only scan characters in their un-translated state.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#getCharacterAt\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The x position to check.\r\n * @param {number} y - The y position to check.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera which is being tested against. If not given will use the Scene default camera.\r\n *\r\n * @return {Phaser.Types.GameObjects.BitmapText.BitmapTextCharacter} The character object at the given position, or `null`.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 748, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Gets the character located at the given x/y coordinate within this Bitmap Text.\r\rThe coordinates you pass in are translated into the local space of the\rBitmap Text, however, it is up to you to first translate the input coordinates to world space.\r\rIf you wish to use this in combination with an input event, be sure\rto pass in `Pointer.worldX` and `worldY` so they are in world space.\r\rIn some cases, based on kerning, characters can overlap. When this happens,\rthe first character in the word is returned.\r\rNote that this does not work for DynamicBitmapText if you have changed the\rcharacter positions during render. It will only scan characters in their un-translated state.", "kind": "function", "name": "getCharacterAt", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position to check.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position to check.", "name": "y" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera which is being tested against. If not given will use the Scene default camera.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.BitmapTextCharacter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.BitmapTextCharacter" } }, "description": "The character object at the given position, or `null`." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#getCharacterAt", "scope": "instance", "___id": "T000002R007937", "___s": true }, { "comment": "/**\r\n * Updates the Display Origin cached values internally stored on this Game Object.\r\n * You don't usually call this directly, but it is exposed for edge-cases where you may.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#updateDisplayOrigin\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 797, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Updates the Display Origin cached values internally stored on this Game Object.\rYou 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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#updateDisplayOrigin", "scope": "instance", "overrides": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "___id": "T000002R007945", "___s": true }, { "comment": "/**\r\n * Changes the font this BitmapText is using to render.\r\n *\r\n * The new texture is loaded and applied to the BitmapText. The existing text, size and alignment are preserved,\r\n * unless overridden via the arguments.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#setFont\r\n * @since 3.11.0\r\n *\r\n * @param {string} font - The key of the font to use from the Bitmap Font cache.\r\n * @param {number} [size] - The font size of this Bitmap Text. If not specified the current size will be used.\r\n * @param {number} [align=0] - The alignment of the text in a multi-line BitmapText object. If not specified the current alignment will be used.\r\n *\r\n * @return {this} This BitmapText Object.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 815, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Changes the font this BitmapText is using to render.\r\rThe new texture is loaded and applied to the BitmapText. The existing text, size and alignment are preserved,\runless overridden via the arguments.", "kind": "function", "name": "setFont", "since": "3.11.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the font to use from the Bitmap Font cache.", "name": "font" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The font size of this Bitmap Text. If not specified the current size will be used.", "name": "size" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#setFont", "scope": "instance", "___id": "T000002R007948", "___s": true }, { "comment": "/**\r\n * Sets the maximum display width of this BitmapText in pixels.\r\n *\r\n * If `BitmapText.text` is longer than `maxWidth` then the lines will be automatically wrapped\r\n * based on the previous whitespace character found in the line.\r\n *\r\n * If no whitespace was found then no wrapping will take place and consequently the `maxWidth` value will not be honored.\r\n *\r\n * Disable maxWidth by setting the value to 0.\r\n *\r\n * You can set the whitespace character to be searched for by setting the `wordWrapCharCode` parameter or property.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#setMaxWidth\r\n * @since 3.21.0\r\n *\r\n * @param {number} value - The maximum display width of this BitmapText in pixels. Set to zero to disable.\r\n * @param {number} [wordWrapCharCode] - The character code to check for when word wrapping. Defaults to 32 (the space character).\r\n *\r\n * @return {this} This BitmapText Object.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 853, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Sets the maximum display width of this BitmapText in pixels.\r\rIf `BitmapText.text` is longer than `maxWidth` then the lines will be automatically wrapped\rbased on the previous whitespace character found in the line.\r\rIf no whitespace was found then no wrapping will take place and consequently the `maxWidth` value will not be honored.\r\rDisable maxWidth by setting the value to 0.\r\rYou 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum display width of this BitmapText in pixels. Set to zero to disable.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The character code to check for when word wrapping. Defaults to 32 (the space character).", "name": "wordWrapCharCode" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This BitmapText Object." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#setMaxWidth", "scope": "instance", "___id": "T000002R007958", "___s": true }, { "comment": "/**\r\n * Sets the display size of this BitmapText Game Object.\r\n *\r\n * Calling this will adjust the scale.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#setDisplaySize\r\n * @since 3.61.0\r\n *\r\n * @param {number} width - The width of this BitmapText Game Object.\r\n * @param {number} height - The height of this BitmapText Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 887, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Sets the display size of this BitmapText Game Object.\r\rCalling this will adjust the scale.", "kind": "function", "name": "setDisplaySize", "since": "3.61.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this BitmapText Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this BitmapText Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#setDisplaySize", "scope": "instance", "___id": "T000002R007963", "___s": true }, { "comment": "/**\r\n * Controls the alignment of each line of text in this BitmapText object.\r\n *\r\n * Only has any effect when this BitmapText contains multiple lines of text, split with carriage-returns.\r\n * Has no effect with single-lines of text.\r\n *\r\n * See the methods `setLeftAlign`, `setCenterAlign` and `setRightAlign`.\r\n *\r\n * 0 = Left aligned (default)\r\n * 1 = Middle aligned\r\n * 2 = Right aligned\r\n *\r\n * The alignment position is based on the longest line of text.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#align\r\n * @type {number}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 915, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Controls the alignment of each line of text in this BitmapText object.\r\rOnly has any effect when this BitmapText contains multiple lines of text, split with carriage-returns.\rHas no effect with single-lines of text.\r\rSee the methods `setLeftAlign`, `setCenterAlign` and `setRightAlign`.\r\r0 = Left aligned (default)\r1 = Middle aligned\r2 = Right aligned\r\rThe alignment position is based on the longest line of text.", "name": "align", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#align", "scope": "instance", "kind": "member", "___id": "T000002R007967", "___s": true }, { "comment": "/**\r\n * The text that this Bitmap Text object displays.\r\n *\r\n * You can also use the method `setText` if you want a chainable way to change the text content.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#text\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 948, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "The text that this Bitmap Text object displays.\r\rYou can also use the method `setText` if you want a chainable way to change the text content.", "name": "text", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#text", "scope": "instance", "kind": "member", "___id": "T000002R007973", "___s": true }, { "comment": "/**\r\n * The font size of this Bitmap Text.\r\n *\r\n * You can also use the method `setFontSize` if you want a chainable way to change the font size.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#fontSize\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 971, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "The font size of this Bitmap Text.\r\rYou can also use the method `setFontSize` if you want a chainable way to change the font size.", "name": "fontSize", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#fontSize", "scope": "instance", "kind": "member", "___id": "T000002R007977", "___s": true }, { "comment": "/**\r\n * Adds / Removes spacing between characters.\r\n *\r\n * Can be a negative or positive number.\r\n *\r\n * You can also use the method `setLetterSpacing` if you want a chainable way to change the letter spacing.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#letterSpacing\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 995, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Adds / Removes spacing between characters.\r\rCan be a negative or positive number.\r\rYou can also use the method `setLetterSpacing` if you want a chainable way to change the letter spacing.", "name": "letterSpacing", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#letterSpacing", "scope": "instance", "kind": "member", "___id": "T000002R007983", "___s": true }, { "comment": "/**\r\n * Adds / Removes spacing between lines.\r\n *\r\n * Can be a negative or positive number.\r\n *\r\n * You can also use the method `setLineSpacing` if you want a chainable way to change the line spacing.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#lineSpacing\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 1021, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Adds / Removes spacing between lines.\r\rCan be a negative or positive number.\r\rYou can also use the method `setLineSpacing` if you want a chainable way to change the line spacing.", "name": "lineSpacing", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#lineSpacing", "scope": "instance", "kind": "member", "___id": "T000002R007989", "___s": true }, { "comment": "/**\r\n * The maximum display width of this BitmapText in pixels.\r\n *\r\n * If BitmapText.text is longer than maxWidth then the lines will be automatically wrapped\r\n * based on the last whitespace character found in the line.\r\n *\r\n * If no whitespace was found then no wrapping will take place and consequently the maxWidth value will not be honored.\r\n *\r\n * Disable maxWidth by setting the value to 0.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#maxWidth\r\n * @type {number}\r\n * @since 3.21.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 1047, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "The maximum display width of this BitmapText in pixels.\r\rIf BitmapText.text is longer than maxWidth then the lines will be automatically wrapped\rbased on the last whitespace character found in the line.\r\rIf no whitespace was found then no wrapping will take place and consequently the maxWidth value will not be honored.\r\rDisable maxWidth by setting the value to 0.", "name": "maxWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.21.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#maxWidth", "scope": "instance", "kind": "member", "___id": "T000002R007995", "___s": true }, { "comment": "/**\r\n * The width of this Bitmap Text.\r\n *\r\n * This property is read-only.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#width\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 1076, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "The width of this Bitmap Text.\r\rThis property is read-only.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#width", "scope": "instance", "kind": "member", "___id": "T000002R008001", "___s": true }, { "comment": "/**\r\n * The height of this Bitmap Text.\r\n *\r\n * This property is read-only.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#height\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 1097, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "The height of this Bitmap Text.\r\rThis property is read-only.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#height", "scope": "instance", "kind": "member", "___id": "T000002R008004", "___s": true }, { "comment": "/**\r\n * The displayed width of this Bitmap Text.\r\n *\r\n * This value takes into account the scale factor.\r\n *\r\n * This property is read-only.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#displayWidth\r\n * @type {number}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 1118, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "The displayed width of this Bitmap Text.\r\rThis value takes into account the scale factor.\r\rThis property is read-only.", "name": "displayWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#displayWidth", "scope": "instance", "kind": "member", "___id": "T000002R008007", "___s": true }, { "comment": "/**\r\n * The displayed height of this Bitmap Text.\r\n *\r\n * This value takes into account the scale factor.\r\n *\r\n * This property is read-only.\r\n *\r\n * @name Phaser.GameObjects.BitmapText#displayHeight\r\n * @type {number}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 1150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "The displayed height of this Bitmap Text.\r\rThis value takes into account the scale factor.\r\rThis property is read-only.", "name": "displayHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#displayHeight", "scope": "instance", "kind": "member", "___id": "T000002R008012", "___s": true }, { "comment": "/**\r\n * Build a JSON representation of this Bitmap Text.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.GameObjects.BitmapText.JSONBitmapText} A JSON representation of this Bitmap Text.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 1182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R008017", "___s": true }, { "comment": "/**\r\n * Internal destroy handler, called as part of the destroy process.\r\n *\r\n * @method Phaser.GameObjects.BitmapText#preDestroy\r\n * @protected\r\n * @since 3.50.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 1210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Internal destroy handler, called as part of the destroy process.", "kind": "function", "name": "preDestroy", "access": "protected", "since": "3.50.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText#preDestroy", "scope": "instance", "___id": "T000002R008028", "___s": true }, { "comment": "/**\r\n * Left align the text characters in a multi-line BitmapText object.\r\n *\r\n * @name Phaser.GameObjects.BitmapText.ALIGN_LEFT\r\n * @type {number}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 1226, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Left align the text characters in a multi-line BitmapText object.", "name": "ALIGN_LEFT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText.ALIGN_LEFT", "scope": "static", "kind": "member", "___id": "T000002R008033", "___s": true }, { "comment": "/**\r\n * Center align the text characters in a multi-line BitmapText object.\r\n *\r\n * @name Phaser.GameObjects.BitmapText.ALIGN_CENTER\r\n * @type {number}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 1235, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Center align the text characters in a multi-line BitmapText object.", "name": "ALIGN_CENTER", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText.ALIGN_CENTER", "scope": "static", "kind": "member", "___id": "T000002R008035", "___s": true }, { "comment": "/**\r\n * Right align the text characters in a multi-line BitmapText object.\r\n *\r\n * @name Phaser.GameObjects.BitmapText.ALIGN_RIGHT\r\n * @type {number}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 1244, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Right align the text characters in a multi-line BitmapText object.", "name": "ALIGN_RIGHT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText.ALIGN_RIGHT", "scope": "static", "kind": "member", "___id": "T000002R008037", "___s": true }, { "comment": "/**\r\n * Parse an XML Bitmap Font from an Atlas.\r\n *\r\n * Adds the parsed Bitmap Font data to the cache with the `fontName` key.\r\n *\r\n * @method Phaser.GameObjects.BitmapText.ParseFromAtlas\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to parse the Bitmap Font for.\r\n * @param {string} fontName - The key of the font to add to the Bitmap Font cache.\r\n * @param {string} textureKey - The key of the BitmapFont's texture.\r\n * @param {string} frameKey - The key of the BitmapFont texture's frame.\r\n * @param {string} xmlKey - The key of the XML data of the font to parse.\r\n * @param {number} [xSpacing] - The x-axis spacing to add between each letter.\r\n * @param {number} [ySpacing] - The y-axis spacing to add to the line height.\r\n *\r\n * @return {boolean} Whether the parsing was successful or not.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 1253, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Parse an XML Bitmap Font from an Atlas.\r\rAdds 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to parse the Bitmap Font for.", "name": "scene" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the font to add to the Bitmap Font cache.", "name": "fontName" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the BitmapFont's texture.", "name": "textureKey" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the BitmapFont texture's frame.", "name": "frameKey" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the XML data of the font to parse.", "name": "xmlKey" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x-axis spacing to add between each letter.", "name": "xSpacing" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y-axis spacing to add to the line height.", "name": "ySpacing" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the parsing was successful or not." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText.ParseFromAtlas", "scope": "static", "___id": "T000002R008039", "___s": true }, { "comment": "/**\r\n * Parse an XML font to Bitmap Font data for the Bitmap Font cache.\r\n *\r\n * @method Phaser.GameObjects.BitmapText.ParseXMLBitmapFont\r\n * @since 3.17.0\r\n *\r\n * @param {XMLDocument} xml - The XML Document to parse the font from.\r\n * @param {Phaser.Textures.Frame} frame - The texture frame to take into account when creating the uv data.\r\n * @param {number} [xSpacing=0] - The x-axis spacing to add between each letter.\r\n * @param {number} [ySpacing=0] - The y-axis spacing to add to the line height.\r\n *\r\n * @return {Phaser.Types.GameObjects.BitmapText.BitmapFontData} The parsed Bitmap Font data.\r\n */", "meta": { "filename": "BitmapText.js", "lineno": 1273, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "XMLDocument" } }, "description": "The XML Document to parse the font from.", "name": "xml" }, { "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "The texture frame to take into account when creating the uv data.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x-axis spacing to add between each letter.", "name": "xSpacing" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y-axis spacing to add to the line height.", "name": "ySpacing" } ], "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.BitmapFontData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.BitmapFontData" } }, "description": "The parsed Bitmap Font data." } ], "memberof": "Phaser.GameObjects.BitmapText", "longname": "Phaser.GameObjects.BitmapText.ParseXMLBitmapFont", "scope": "static", "___id": "T000002R008041", "___s": true }, { "comment": "/**\r\n * Creates a new Bitmap Text Game Object and returns it.\r\n *\r\n * BitmapText objects work by taking a pre-rendered font texture and then stamping out each character\r\n * of the text from that texture. This makes rendering very fast compared to using a Canvas-based font,\r\n * but it means the font must be created in advance and stored as a texture atlas. Use this method via\r\n * `scene.make.bitmapText()` when you need high-performance static text rendering in your game.\r\n *\r\n * Note: This method will only be available if the Bitmap Text Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#bitmapText\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.BitmapText.BitmapTextConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n * \r\n * @return {Phaser.GameObjects.BitmapText} The Game Object that was created.\r\n */", "meta": { "filename": "BitmapTextCreator.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Creates a new Bitmap Text Game Object and returns it.\r\rBitmapText objects work by taking a pre-rendered font texture and then stamping out each character\rof the text from that texture. This makes rendering very fast compared to using a Canvas-based font,\rbut it means the font must be created in advance and stored as a texture atlas. Use this method via\r`scene.make.bitmapText()` when you need high-performance static text rendering in your game.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.BitmapTextConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.BitmapText" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#bitmapText", "scope": "instance", "___id": "T000002R008111", "___s": true }, { "comment": "/**\r\n * Creates a new Bitmap Text Game Object and adds it to the Scene.\r\n * \r\n * BitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\r\n * \r\n * During rendering, each letter of the text is rendered to the display, proportionally spaced out and aligned to\r\n * match the font structure.\r\n * \r\n * BitmapText objects are less flexible than Text objects, in that they have fewer features such as shadows, fills and the ability\r\n * to use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\r\n * processing the font texture in an image editor, applying fills and any other effects required.\r\n *\r\n * To create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\r\n *\r\n * To create BitmapText data files you need a 3rd party app such as:\r\n *\r\n * BMFont (Windows, free): http://www.angelcode.com/products/bmfont/\r\n * Glyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner\r\n * Littera (Web-based, free): http://kvazars.com/littera/\r\n *\r\n * For most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\r\n * converting a valid XML file through the popular X2JS library. An online tool for conversion can be found here: http://codebeautify.org/xmltojson\r\n *\r\n * Note: This method will only be available if the Bitmap Text Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#bitmapText\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x position of the Game Object.\r\n * @param {number} y - The y position of the Game Object.\r\n * @param {string} font - The key of the font to use from the BitmapFont cache.\r\n * @param {(string|string[])} [text] - The string, or array of strings, to be set as the content of this Bitmap Text.\r\n * @param {number} [size] - The font size to set.\r\n * @param {number} [align=0] - The alignment of the text in a multi-line BitmapText object.\r\n *\r\n * @return {Phaser.GameObjects.BitmapText} The Game Object that was created.\r\n */", "meta": { "filename": "BitmapTextFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\static", "code": {} }, "description": "Creates a new Bitmap Text Game Object and adds it to the Scene.\r\rBitmapText objects work by taking a texture file and an XML or JSON file that describes the font structure.\r\rDuring rendering, each letter of the text is rendered to the display, proportionally spaced out and aligned to\rmatch the font structure.\r\rBitmapText objects are less flexible than Text objects, in that they have fewer features such as shadows, fills and the ability\rto use Web Fonts, however you trade this flexibility for rendering speed. You can also create visually compelling BitmapTexts by\rprocessing the font texture in an image editor, applying fills and any other effects required.\r\rTo create multi-line text insert \\r, \\n or \\r\\n escape codes into the text string.\r\rTo create BitmapText data files you need a 3rd party app such as:\r\rBMFont (Windows, free): http://www.angelcode.com/products/bmfont/\rGlyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner\rLittera (Web-based, free): http://kvazars.com/littera/\r\rFor most use cases it is recommended to use XML. If you wish to use JSON, the formatting should be equal to the result of\rconverting a valid XML file through the popular X2JS library. An online tool for conversion can be found here: http://codebeautify.org/xmltojson\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the Game Object.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the Game Object.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the font to use from the BitmapFont cache.", "name": "font" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The string, or array of strings, to be set as the content of this Bitmap Text.", "name": "text" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The font size to set.", "name": "size" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The alignment of the text in a multi-line BitmapText object.", "name": "align" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.BitmapText" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.BitmapText" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#bitmapText", "scope": "instance", "___id": "T000002R008121", "___s": true }, { "comment": "/**\n * The font data for an individual character of a Bitmap Font.\n *\n * Describes the character's position, size, offset and kerning.\n *\n * As of version 3.50 it also includes the WebGL texture uv data.\n *\n * @typedef {object} Phaser.Types.GameObjects.BitmapText.BitmapFontCharacterData\n * @since 3.0.0\n *\n * @property {number} x - The x position of the character.\n * @property {number} y - The y position of the character.\n * @property {number} width - The width of the character.\n * @property {number} height - The height of the character.\n * @property {number} centerX - The center x position of the character.\n * @property {number} centerY - The center y position of the character.\n * @property {number} xOffset - The x offset of the character.\n * @property {number} yOffset - The y offset of the character.\n * @property {number} u0 - WebGL texture u0.\n * @property {number} v0 - WebGL texture v0.\n * @property {number} u1 - WebGL texture u1.\n * @property {number} v1 - WebGL texture v1.\n * @property {object} data - Extra data for the character.\n * @property {Object.} kerning - Kerning values, keyed by character code.\n */", "meta": { "filename": "BitmapFontCharacterData.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "description": "The font data for an individual character of a Bitmap Font.\n\nDescribes the character's position, size, offset and kerning.\n\nAs of version 3.50 it also includes the WebGL texture uv data.", "kind": "typedef", "name": "BitmapFontCharacterData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the character.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the character.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the character.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the character.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The center x position of the character.", "name": "centerX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The center y position of the character.", "name": "centerY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x offset of the character.", "name": "xOffset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y offset of the character.", "name": "yOffset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "WebGL texture u0.", "name": "u0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "WebGL texture v0.", "name": "v0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "WebGL texture u1.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "WebGL texture v1.", "name": "v1" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "Extra data for the character.", "name": "data" }, { "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "number" } ] } }, "description": "Kerning values, keyed by character code.", "name": "kerning" } ], "memberof": "Phaser.Types.GameObjects.BitmapText", "longname": "Phaser.Types.GameObjects.BitmapText.BitmapFontCharacterData", "scope": "static", "___id": "T000002R008187", "___s": true }, { "comment": "/**\r\n * Bitmap Font data that can be used by a BitmapText Game Object.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.BitmapText.BitmapFontData\r\n * @since 3.0.0\r\n *\r\n * @property {string} font - The name of the font.\r\n * @property {number} size - The size of the font.\r\n * @property {number} lineHeight - The line height of the font.\r\n * @property {boolean} retroFont - Whether this font is a retro font (monospace).\r\n * @property {Object.} chars - The character data of the font, keyed by character code. Each character datum includes a position, size, offset and more.\r\n */", "meta": { "filename": "BitmapFontData.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "description": "Bitmap Font data that can be used by a BitmapText Game Object.", "kind": "typedef", "name": "BitmapFontData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the font.", "name": "font" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The size of the font.", "name": "size" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line height of the font.", "name": "lineHeight" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether this font is a retro font (monospace).", "name": "retroFont" }, { "type": { "names": [ "Object." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Object" }, "applications": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.BitmapFontCharacterData" } ] } }, "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", "___id": "T000002R008188", "___s": true }, { "comment": "/**\r\n * A single entry from the `BitmapTextSize` characters array.\r\n *\r\n * The position and dimensions take the font size into account,\r\n * but are not translated into the local space of the Game Object itself.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.BitmapText.BitmapTextCharacter\r\n * @since 3.50.0\r\n *\r\n * @property {number} i - The index of this character within the BitmapText wrapped text string.\r\n * @property {number} idx - The index of this character within the BitmapText text string.\r\n * @property {string} char - The character.\r\n * @property {number} code - The character code of the character.\r\n * @property {number} x - The x position of the character in the BitmapText.\r\n * @property {number} y - The y position of the character in the BitmapText.\r\n * @property {number} w - The width of the character.\r\n * @property {number} h - The height of the character.\r\n * @property {number} t - The top of the line this character is on.\r\n * @property {number} r - The right-most point of this character, including xAdvance.\r\n * @property {number} b - The bottom of the line this character is on.\r\n * @property {number} line - The line number the character appears on.\r\n * @property {Phaser.Types.GameObjects.BitmapText.BitmapFontCharacterData} glyph - Reference to the glyph object this character is using.\r\n */", "meta": { "filename": "BitmapTextCharacter.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "description": "A single entry from the `BitmapTextSize` characters array.\r\rThe position and dimensions take the font size into account,\rbut are not translated into the local space of the Game Object itself.", "kind": "typedef", "name": "BitmapTextCharacter", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of this character within the BitmapText wrapped text string.", "name": "i" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of this character within the BitmapText text string.", "name": "idx" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The character.", "name": "char" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The character code of the character.", "name": "code" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the character in the BitmapText.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the character in the BitmapText.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the character.", "name": "w" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the character.", "name": "h" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top of the line this character is on.", "name": "t" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The right-most point of this character, including xAdvance.", "name": "r" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom of the line this character is on.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line number the character appears on.", "name": "line" }, { "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.BitmapFontCharacterData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.BitmapFontCharacterData" } }, "description": "Reference to the glyph object this character is using.", "name": "glyph" } ], "memberof": "Phaser.Types.GameObjects.BitmapText", "longname": "Phaser.Types.GameObjects.BitmapText.BitmapTextCharacter", "scope": "static", "___id": "T000002R008189", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.BitmapText.BitmapTextConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 3.0.0\r\n *\r\n * @property {string} [font=''] - The key of the font to use from the BitmapFont cache.\r\n * @property {string} [text=''] - The string, or array of strings, to be set as the content of this Bitmap Text.\r\n * @property {(number|false)} [size=false] - The font size to set.\r\n */", "meta": { "filename": "BitmapTextConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "kind": "typedef", "name": "BitmapTextConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "''", "description": "The key of the font to use from the BitmapFont cache.", "name": "font" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "false", "reservedWord": true } ] } }, "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", "___id": "T000002R008190", "___s": true }, { "comment": "/**\r\n * Details about the line data in the `BitmapTextSize` object.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.BitmapText.BitmapTextLines\r\n * @since 3.50.0\r\n *\r\n * @property {number} shortest - The width of the shortest line of text.\r\n * @property {number} longest - The width of the longest line of text.\r\n * @property {number} height - The height of a line of text.\r\n * @property {number[]} lengths - An array where each entry contains the length of that line of text.\r\n */", "meta": { "filename": "BitmapTextLines.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "description": "Details about the line data in the `BitmapTextSize` object.", "kind": "typedef", "name": "BitmapTextLines", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the shortest line of text.", "name": "shortest" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the longest line of text.", "name": "longest" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of a line of text.", "name": "height" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array where each entry contains the length of that line of text.", "name": "lengths" } ], "memberof": "Phaser.Types.GameObjects.BitmapText", "longname": "Phaser.Types.GameObjects.BitmapText.BitmapTextLines", "scope": "static", "___id": "T000002R008191", "___s": true }, { "comment": "/**\n * @typedef {object} Phaser.Types.GameObjects.BitmapText.BitmapTextSize\n * @since 3.0.0\n *\n * @property {Phaser.Types.GameObjects.BitmapText.GlobalBitmapTextSize} global - The position and size of the BitmapText, taking into account the position and scale of the Game Object.\n * @property {Phaser.Types.GameObjects.BitmapText.LocalBitmapTextSize} local - The position and size of the BitmapText, taking just the font size into account.\n * @property {Phaser.Types.GameObjects.BitmapText.BitmapTextLines} lines - Data about the lines of text within the BitmapText.\n * @property {Phaser.Types.GameObjects.BitmapText.BitmapTextCharacter[]} characters - An array containing per-character data. Only populated if `includeChars` is `true` in the `getTextBounds` call.\n * @property {Phaser.Types.GameObjects.BitmapText.BitmapTextWord[]} words - An array containing the word data from the BitmapText.\n * @property {number} scale - The scale of the BitmapText font being rendered vs. font size in the text data.\n * @property {number} scaleX - The scale X value of the BitmapText.\n * @property {number} scaleY - The scale Y value of the BitmapText.\n * @property {string} wrappedText - The wrapped text, if wrapping enabled and required.\n */", "meta": { "filename": "BitmapTextSize.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "kind": "typedef", "name": "BitmapTextSize", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.GlobalBitmapTextSize" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.LocalBitmapTextSize" } }, "description": "The position and size of the BitmapText, taking just the font size into account.", "name": "local" }, { "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.BitmapTextLines" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.BitmapTextLines" } }, "description": "Data about the lines of text within the BitmapText.", "name": "lines" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.GameObjects.BitmapText.BitmapTextCharacter", "type": "NameExpression" } ] } }, "description": "An array containing per-character data. Only populated if `includeChars` is `true` in the `getTextBounds` call.", "name": "characters" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.GameObjects.BitmapText.BitmapTextWord", "type": "NameExpression" } ] } }, "description": "An array containing the word data from the BitmapText.", "name": "words" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The scale of the BitmapText font being rendered vs. font size in the text data.", "name": "scale" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The scale X value of the BitmapText.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The scale Y value of the BitmapText.", "name": "scaleY" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The wrapped text, if wrapping enabled and required.", "name": "wrappedText" } ], "memberof": "Phaser.Types.GameObjects.BitmapText", "longname": "Phaser.Types.GameObjects.BitmapText.BitmapTextSize", "scope": "static", "___id": "T000002R008192", "___s": true }, { "comment": "/**\r\n * Details about a single world entry in the `BitmapTextSize` object words array.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.BitmapText.BitmapTextWord\r\n * @since 3.50.0\r\n *\r\n * @property {number} x - The x position of the word in the BitmapText.\r\n * @property {number} y - The y position of the word in the BitmapText.\r\n * @property {number} w - The width of the word.\r\n * @property {number} h - The height of the word.\r\n * @property {number} i - The index of the first character of this word within the entire string. Note: this index factors in spaces, quotes, carriage-returns, etc.\r\n * @property {string} word - The word.\r\n */", "meta": { "filename": "BitmapTextWord.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "description": "Details about a single world entry in the `BitmapTextSize` object words array.", "kind": "typedef", "name": "BitmapTextWord", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the word in the BitmapText.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the word in the BitmapText.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the word.", "name": "w" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the word.", "name": "h" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the first character of this word within the entire string. Note: this index factors in spaces, quotes, carriage-returns, etc.", "name": "i" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The word.", "name": "word" } ], "memberof": "Phaser.Types.GameObjects.BitmapText", "longname": "Phaser.Types.GameObjects.BitmapText.BitmapTextWord", "scope": "static", "___id": "T000002R008193", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.GameObjects.DynamicBitmapText} parent - The Dynamic Bitmap Text object that owns this character being rendered.\r\n * @property {Phaser.Types.GameObjects.BitmapText.TintConfig} tint - The tint of the character being rendered. Always zero in Canvas.\r\n * @property {Phaser.TintModes} tintMode - The tint mode of the character being rendered.\r\n * @property {number} index - The index of the character being rendered.\r\n * @property {number} charCode - The character code of the character being rendered.\r\n * @property {number} x - The x position of the character being rendered.\r\n * @property {number} y - The y position of the character being rendered.\r\n * @property {number} scale - The scale of the character being rendered.\r\n * @property {number} rotation - The rotation of the character being rendered.\r\n * @property {any} data - Custom data stored with the character being rendered.\r\n */", "meta": { "filename": "DisplayCallbackConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "kind": "typedef", "name": "DisplayCallbackConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.GameObjects.DynamicBitmapText" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.DynamicBitmapText" } }, "description": "The Dynamic Bitmap Text object that owns this character being rendered.", "name": "parent" }, { "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.TintConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.BitmapText.TintConfig" } }, "description": "The tint of the character being rendered. Always zero in Canvas.", "name": "tint" }, { "type": { "names": [ "Phaser.TintModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.TintModes" } }, "description": "The tint mode of the character being rendered.", "name": "tintMode" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the character being rendered.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The character code of the character being rendered.", "name": "charCode" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the character being rendered.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the character being rendered.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The scale of the character being rendered.", "name": "scale" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rotation of the character being rendered.", "name": "rotation" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R008194", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.GameObjects.BitmapText.DisplayCallback\r\n *\r\n * @param {Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig} display - Settings of the character that is about to be rendered.\r\n *\r\n * @return {Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig} Altered position, scale and rotation values for the character that is about to be rendered.\r\n */", "meta": { "filename": "DisplayCallbackConfig.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "kind": "typedef", "name": "DisplayCallback", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R008195", "___s": true }, { "comment": "/**\r\n * The position and size of the Bitmap Text in global space, taking into account the Game Object's scale and world position.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.BitmapText.GlobalBitmapTextSize\r\n * @since 3.0.0\r\n *\r\n * @property {number} x - The x position of the BitmapText, taking into account the x position and scale of the Game Object.\r\n * @property {number} y - The y position of the BitmapText, taking into account the y position and scale of the Game Object.\r\n * @property {number} width - The width of the BitmapText, taking into account the x scale of the Game Object.\r\n * @property {number} height - The height of the BitmapText, taking into account the y scale of the Game Object.\r\n */", "meta": { "filename": "GlobalBitmapTextSize.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the BitmapText, taking into account the x scale of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R008196", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.BitmapText\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "kind": "namespace", "name": "BitmapText", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.BitmapText", "scope": "static", "___id": "T000002R008197", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.BitmapText.JSONBitmapText\r\n * @extends {Phaser.Types.GameObjects.JSONGameObject}\r\n * @since 3.0.0\r\n *\r\n * @property {string} font - The name of the font.\r\n * @property {string} text - The text that this Bitmap Text displays.\r\n * @property {number} fontSize - The size of the font.\r\n * @property {number} letterSpacing - Adds / Removes spacing between characters.\r\n * @property {number} lineSpacing - Adds / Removes spacing between lines in multi-line text.\r\n * @property {number} align - The alignment of the text in a multi-line BitmapText object.\r\n */", "meta": { "filename": "JSONBitmapText.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "kind": "typedef", "name": "JSONBitmapText", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.JSONGameObject" ], "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the font.", "name": "font" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The text that this Bitmap Text displays.", "name": "text" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The size of the font.", "name": "fontSize" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Adds / Removes spacing between characters.", "name": "letterSpacing" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Adds / Removes spacing between lines in multi-line text.", "name": "lineSpacing" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R008198", "___s": true }, { "comment": "/**\r\n * The position and size of the Bitmap Text in local space, taking just the font size into account.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.BitmapText.LocalBitmapTextSize\r\n * @since 3.0.0\r\n *\r\n * @property {number} x - The x position of the BitmapText.\r\n * @property {number} y - The y position of the BitmapText.\r\n * @property {number} width - The width of the BitmapText.\r\n * @property {number} height - The height of the BitmapText.\r\n */", "meta": { "filename": "LocalBitmapTextSize.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the BitmapText.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the BitmapText.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the BitmapText.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the BitmapText.", "name": "height" } ], "memberof": "Phaser.Types.GameObjects.BitmapText", "longname": "Phaser.Types.GameObjects.BitmapText.LocalBitmapTextSize", "scope": "static", "___id": "T000002R008199", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.BitmapText.RetroFontConfig\r\n * @since 3.6.0\r\n * \r\n * @property {string} image - The key of the image containing the font.\r\n * @property {number} offset.x - If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.\r\n * @property {number} offset.y - If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.\r\n * @property {number} width - The width of each character in the font set.\r\n * @property {number} height - The height of each character in the font set.\r\n * @property {string} chars - The characters used in the font set, in display order. You can use the TEXT_SET consts for common font set arrangements.\r\n * @property {number} charsPerRow - The number of characters per row in the font set. If not given charsPerRow will be the image width / characterWidth.\r\n * @property {number} spacing.x - If the characters in the font set have horizontal spacing between them set the required amount here.\r\n * @property {number} spacing.y - If the characters in the font set have vertical spacing between them set the required amount here.\r\n * @property {number} lineSpacing - The amount of vertical space to add to the line height of the font.\r\n*/", "meta": { "filename": "RetroFontConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "kind": "typedef", "name": "RetroFontConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.6.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the image containing the font.", "name": "image" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of each character in the font set.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of each character in the font set.", "name": "height" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R008200", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.BitmapText.TintConfig\r\n * @since 3.0.0\r\n * \r\n * @property {number} topLeft - The top left tint value. Always zero in canvas.\r\n * @property {number} topRight - The top right tint value. Always zero in canvas.\r\n * @property {number} bottomLeft - The bottom left tint value. Always zero in canvas.\r\n * @property {number} bottomRight - The bottom right tint value. Always zero in canvas.\r\n */", "meta": { "filename": "TintConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\bitmaptext\\typedefs", "code": {} }, "kind": "typedef", "name": "TintConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top left tint value. Always zero in canvas.", "name": "topLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top right tint value. Always zero in canvas.", "name": "topRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom left tint value. Always zero in canvas.", "name": "bottomLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R008201", "___s": true }, { "comment": "/**\r\n * @callback CreateCallback\r\n *\r\n * @param {Phaser.GameObjects.Bob} bob - The Bob that was created by the Blitter.\r\n * @param {number} index - The position of the Bob within the Blitter display list.\r\n */", "meta": { "filename": "Blitter.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "kind": "typedef", "name": "CreateCallback", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "Phaser.GameObjects.Bob" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Bob" } }, "description": "The Bob that was created by the Blitter.", "name": "bob" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The position of the Bob within the Blitter display list.", "name": "index" } ], "longname": "CreateCallback", "scope": "global", "___id": "T000002R008210", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Blitter Game Object.\r\n *\r\n * The Blitter Game Object is a special kind of container that creates, updates and manages Bob objects.\r\n * Bobs are designed for rendering speed rather than flexibility. They consist of a texture, or frame from a texture,\r\n * a position and an alpha value. You cannot scale or rotate them. They use a batched drawing method for speed\r\n * during rendering.\r\n *\r\n * A Blitter Game Object has one texture bound to it. Bobs created by the Blitter can use any Frame from this\r\n * Texture to render with, but they cannot use any other Texture. It is this single texture-bind that allows\r\n * them their speed.\r\n *\r\n * If you have a need to blast a large volume of frames around the screen then Blitter objects are well worth\r\n * investigating. They are especially useful for using as a base for your own special effects systems.\r\n *\r\n * @class Blitter\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.GameObjects.Components.Alpha\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Lighting\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Size\r\n * @extends Phaser.GameObjects.Components.Texture\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. It can only belong to one Scene at any given time.\r\n * @param {number} [x=0] - The x coordinate of this Game Object in world space.\r\n * @param {number} [y=0] - The y coordinate of this Game Object in world space.\r\n * @param {string} [texture='__DEFAULT'] - The key of the texture this Game Object will use for rendering. The Texture must already exist in the Texture Manager.\r\n * @param {(string|number)} [frame=0] - 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.\r\n */", "meta": { "filename": "Blitter.js", "lineno": 23, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "classdesc": "A Blitter Game Object.\r\rThe Blitter Game Object is a special kind of container that creates, updates and manages Bob objects.\rBobs are designed for rendering speed rather than flexibility. They consist of a texture, or frame from a texture,\ra position and an alpha value. You cannot scale or rotate them. They use a batched drawing method for speed\rduring rendering.\r\rA Blitter Game Object has one texture bound to it. Bobs created by the Blitter can use any Frame from this\rTexture to render with, but they cannot use any other Texture. It is this single texture-bind that allows\rthem their speed.\r\rIf you have a need to blast a large volume of frames around the screen then Blitter objects are well worth\rinvestigating. 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.Lighting", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.RenderNodes", "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of this Game Object in world space.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of this Game Object in world space.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "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", "___id": "T000002R008211", "___s": true }, { "comment": "/**\r\n * The children of this Blitter.\r\n * This List contains all of the Bob objects created by the Blitter.\r\n *\r\n * @name Phaser.GameObjects.Blitter#children\r\n * @type {Phaser.Structs.List.}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Blitter.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "The children of this Blitter.\rThis List contains all of the Bob objects created by the Blitter.", "name": "children", "type": { "names": [ "Phaser.Structs.List." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.List" }, "applications": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Bob" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "longname": "Phaser.GameObjects.Blitter#children", "scope": "instance", "kind": "member", "___id": "T000002R008216", "___s": true }, { "comment": "/**\r\n * Is the Blitter considered dirty?\r\n * A 'dirty' Blitter has had its child count changed since the last frame.\r\n *\r\n * @name Phaser.GameObjects.Blitter#dirty\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Blitter.js", "lineno": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Is the Blitter considered dirty?\rA 'dirty' Blitter has had its child count changed since the last frame.", "name": "dirty", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Blitter", "longname": "Phaser.GameObjects.Blitter#dirty", "scope": "instance", "kind": "member", "___id": "T000002R008220", "___s": true }, { "comment": "/**\r\n * Creates a new Bob in this Blitter.\r\n *\r\n * The Bob is created at the given coordinates, relative to the Blitter and uses the given frame.\r\n * A Bob can use any frame belonging to the texture bound to the Blitter.\r\n *\r\n * @method Phaser.GameObjects.Blitter#create\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x position of the Bob. Bob coordinate are relative to the position of the Blitter object.\r\n * @param {number} y - The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - The Frame the Bob will use. It _must_ be part of the Texture the parent Blitter object is using.\r\n * @param {boolean} [visible=true] - Should the created Bob render or not?\r\n * @param {number} [index] - The position in the Blitter's Display List to add the new Bob at. Defaults to the top of the list.\r\n *\r\n * @return {Phaser.GameObjects.Bob} The newly created Bob object.\r\n */", "meta": { "filename": "Blitter.js", "lineno": 142, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Creates a new Bob in this Blitter.\r\rThe Bob is created at the given coordinates, relative to the Blitter and uses the given frame.\rA 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the Bob. Bob coordinate are relative to the position of the Blitter object.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.", "name": "y" }, { "type": { "names": [ "string", "number", "Phaser.Textures.Frame" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the created Bob render or not?", "name": "visible" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The position in the Blitter's Display List to add the new Bob at. Defaults to the top of the list.", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Bob" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Bob" } }, "description": "The newly created Bob object." } ], "memberof": "Phaser.GameObjects.Blitter", "longname": "Phaser.GameObjects.Blitter#create", "scope": "instance", "___id": "T000002R008225", "___s": true }, { "comment": "/**\r\n * Creates multiple Bob objects within this Blitter and then passes each of them to the specified callback.\r\n *\r\n * @method Phaser.GameObjects.Blitter#createFromCallback\r\n * @since 3.0.0\r\n *\r\n * @param {CreateCallback} callback - The callback to invoke after creating a bob. It will be sent two arguments: The Bob and the index of the Bob.\r\n * @param {number} quantity - The quantity of Bob objects to create.\r\n * @param {(string|number|Phaser.Textures.Frame|string[]|number[]|Phaser.Textures.Frame[])} [frame] - The Frame the Bobs will use. It must be part of the Blitter Texture.\r\n * @param {boolean} [visible=true] - Should the created Bob render or not?\r\n *\r\n * @return {Phaser.GameObjects.Bob[]} An array of Bob objects that were created.\r\n */", "meta": { "filename": "Blitter.js", "lineno": 182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The quantity of Bob objects to create.", "name": "quantity" }, { "type": { "names": [ "string", "number", "Phaser.Textures.Frame", "Array.", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Textures.Frame" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Textures.Frame", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The Frame the Bobs will use. It must be part of the Blitter Texture.", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the created Bob render or not?", "name": "visible" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Bob", "type": "NameExpression" } ] } }, "description": "An array of Bob objects that were created." } ], "memberof": "Phaser.GameObjects.Blitter", "longname": "Phaser.GameObjects.Blitter#createFromCallback", "scope": "instance", "___id": "T000002R008233", "___s": true }, { "comment": "/**\r\n * Creates multiple Bobs in one call.\r\n *\r\n * The amount created is controlled by a combination of the `quantity` argument and the number of frames provided.\r\n *\r\n * If the quantity is set to 10 and you provide 2 frames, then 20 Bobs will be created. 10 with the first\r\n * frame and 10 with the second.\r\n *\r\n * @method Phaser.GameObjects.Blitter#createMultiple\r\n * @since 3.0.0\r\n *\r\n * @param {number} quantity - The quantity of Bob objects to create.\r\n * @param {(string|number|Phaser.Textures.Frame|string[]|number[]|Phaser.Textures.Frame[])} [frame] - The Frame the Bobs will use. It must be part of the Blitter Texture.\r\n * @param {boolean} [visible=true] - Should the created Bob render or not?\r\n *\r\n * @return {Phaser.GameObjects.Bob[]} An array of Bob objects that were created.\r\n */", "meta": { "filename": "Blitter.js", "lineno": 209, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Creates multiple Bobs in one call.\r\rThe amount created is controlled by a combination of the `quantity` argument and the number of frames provided.\r\rIf the quantity is set to 10 and you provide 2 frames, then 20 Bobs will be created. 10 with the first\rframe and 10 with the second.", "kind": "function", "name": "createMultiple", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The quantity of Bob objects to create.", "name": "quantity" }, { "type": { "names": [ "string", "number", "Phaser.Textures.Frame", "Array.", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Textures.Frame" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Textures.Frame", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The Frame the Bobs will use. It must be part of the Blitter Texture.", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the created Bob render or not?", "name": "visible" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Bob", "type": "NameExpression" } ] } }, "description": "An array of Bob objects that were created." } ], "memberof": "Phaser.GameObjects.Blitter", "longname": "Phaser.GameObjects.Blitter#createMultiple", "scope": "instance", "___id": "T000002R008238", "___s": true }, { "comment": "/**\r\n * Checks if the given child can render or not, by checking its `visible` and `alpha` values.\r\n *\r\n * @method Phaser.GameObjects.Blitter#childCanRender\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Bob} child - The Bob to check for rendering.\r\n *\r\n * @return {boolean} Returns `true` if the given child can render, otherwise `false`.\r\n */", "meta": { "filename": "Blitter.js", "lineno": 250, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Bob" } }, "description": "The Bob to check for rendering.", "name": "child" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if the given child can render, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Blitter", "longname": "Phaser.GameObjects.Blitter#childCanRender", "scope": "instance", "___id": "T000002R008246", "___s": true }, { "comment": "/**\r\n * Returns an array of Bobs to be rendered.\r\n * If the Blitter is dirty then a new list is generated and stored in `renderList`.\r\n *\r\n * @method Phaser.GameObjects.Blitter#getRenderList\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.GameObjects.Bob[]} An array of Bob objects that will be rendered this frame.\r\n */", "meta": { "filename": "Blitter.js", "lineno": 265, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Returns an array of Bobs to be rendered.\rIf 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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Bob", "type": "NameExpression" } ] } }, "description": "An array of Bob objects that will be rendered this frame." } ], "memberof": "Phaser.GameObjects.Blitter", "longname": "Phaser.GameObjects.Blitter#getRenderList", "scope": "instance", "___id": "T000002R008248", "___s": true }, { "comment": "/**\r\n * Removes all Bobs from the children List and marks the Blitter as dirty.\r\n *\r\n * @method Phaser.GameObjects.Blitter#clear\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [destroyBobs=false] - Should the Bobs be destroyed as well? If `false` they will just be removed from the Blitter.\r\n */", "meta": { "filename": "Blitter.js", "lineno": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Removes all Bobs from the children List and marks the Blitter as dirty.", "kind": "function", "name": "clear", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the Bobs be destroyed as well? If `false` they will just be removed from the Blitter.", "name": "destroyBobs" } ], "memberof": "Phaser.GameObjects.Blitter", "longname": "Phaser.GameObjects.Blitter#clear", "scope": "instance", "___id": "T000002R008252", "___s": true }, { "comment": "/**\r\n * Internal destroy handler, called as part of the destroy process.\r\n *\r\n * @method Phaser.GameObjects.Blitter#preDestroy\r\n * @protected\r\n * @since 3.9.0\r\n */", "meta": { "filename": "Blitter.js", "lineno": 313, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Internal destroy handler, called as part of the destroy process.", "kind": "function", "name": "preDestroy", "access": "protected", "since": "3.9.0", "memberof": "Phaser.GameObjects.Blitter", "longname": "Phaser.GameObjects.Blitter#preDestroy", "scope": "instance", "___id": "T000002R008257", "___s": true }, { "comment": "/**\r\n * Creates a new Blitter Game Object and returns it.\r\n *\r\n * A Blitter is a highly efficient Game Object for rendering large numbers of Bob objects, all of which\r\n * share the same texture. Unlike using individual Game Objects, a Blitter batches all of its Bobs into\r\n * a single draw call, making it ideal for particle-like effects, crowds, bullet pools, or any scenario\r\n * where you need many instances of the same image rendered with minimal overhead.\r\n *\r\n * Note: This method will only be available if the Blitter Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#blitter\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Sprite.SpriteConfig} config - The configuration object this Game Object will use to create itself. The `key` property identifies the texture to use, and the optional `frame` property identifies a specific frame within that texture.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Blitter} The Game Object that was created.\r\n */", "meta": { "filename": "BlitterCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Creates a new Blitter Game Object and returns it.\r\rA Blitter is a highly efficient Game Object for rendering large numbers of Bob objects, all of which\rshare the same texture. Unlike using individual Game Objects, a Blitter batches all of its Bobs into\ra single draw call, making it ideal for particle-like effects, crowds, bullet pools, or any scenario\rwhere you need many instances of the same image rendered with minimal overhead.\r\rNote: 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": [ "Phaser.Types.GameObjects.Sprite.SpriteConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Sprite.SpriteConfig" } }, "description": "The configuration object this Game Object will use to create itself. The `key` property identifies the texture to use, and the optional `frame` property identifies a specific frame within that texture.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Blitter" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#blitter", "scope": "instance", "___id": "T000002R008293", "___s": true }, { "comment": "/**\r\n * Creates a new Blitter Game Object and adds it to the Scene.\r\n *\r\n * A Blitter is a special, highly optimized Game Object designed for rendering large numbers of\r\n * identical or similar images with minimal overhead. Rather than creating individual Game Objects\r\n * for each image, a Blitter manages a collection of lightweight `Bob` objects, all sharing the\r\n * same texture. This makes it ideal for particle-like effects, crowds, bullet patterns, or any\r\n * scenario where you need to display many copies of the same sprite at high performance.\r\n *\r\n * Note: This method will only be available if the Blitter Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#blitter\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x position of the Game Object.\r\n * @param {number} y - The y position of the Game Object.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - The default Frame children of the Blitter will use.\r\n *\r\n * @return {Phaser.GameObjects.Blitter} The Game Object that was created.\r\n */", "meta": { "filename": "BlitterFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Creates a new Blitter Game Object and adds it to the Scene.\r\rA Blitter is a special, highly optimized Game Object designed for rendering large numbers of\ridentical or similar images with minimal overhead. Rather than creating individual Game Objects\rfor each image, a Blitter manages a collection of lightweight `Bob` objects, all sharing the\rsame texture. This makes it ideal for particle-like effects, crowds, bullet patterns, or any\rscenario where you need to display many copies of the same sprite at high performance.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the Game Object.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the Game Object.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The default Frame children of the Blitter will use.", "name": "frame" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Blitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Blitter" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#blitter", "scope": "instance", "___id": "T000002R008301", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Bob Game Object.\r\n *\r\n * A Bob belongs to a Blitter Game Object. The Blitter is responsible for managing and rendering this object.\r\n *\r\n * A Bob has a position, alpha value and a frame from a texture that it uses to render with. You can also toggle\r\n * the flipped and visible state of the Bob. The Frame the Bob uses to render can be changed dynamically, but it\r\n * must be a Frame within the Texture used by the parent Blitter.\r\n *\r\n * Bob positions are relative to the Blitter parent. So if you move the Blitter parent, all Bob children will\r\n * have their positions impacted by this change as well.\r\n *\r\n * You can manipulate Bob objects directly from your game code, but the creation and destruction of them should be\r\n * handled via the Blitter parent.\r\n *\r\n * @class Bob\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Blitter} blitter - The parent Blitter object is responsible for updating this Bob.\r\n * @param {number} x - The horizontal position of this Game Object in the world, relative to the parent Blitter position.\r\n * @param {number} y - The vertical position of this Game Object in the world, relative to the parent Blitter position.\r\n * @param {(string|number)} frame - The Frame this Bob will render with, as defined in the Texture the parent Blitter is using.\r\n * @param {boolean} visible - Should the Bob render visible or not to start with?\r\n */", "meta": { "filename": "Bob.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "classdesc": "A Bob Game Object.\r\rA Bob belongs to a Blitter Game Object. The Blitter is responsible for managing and rendering this object.\r\rA Bob has a position, alpha value and a frame from a texture that it uses to render with. You can also toggle\rthe flipped and visible state of the Bob. The Frame the Bob uses to render can be changed dynamically, but it\rmust be a Frame within the Texture used by the parent Blitter.\r\rBob positions are relative to the Blitter parent. So if you move the Blitter parent, all Bob children will\rhave their positions impacted by this change as well.\r\rYou can manipulate Bob objects directly from your game code, but the creation and destruction of them should be\rhandled via the Blitter parent.", "kind": "class", "name": "Bob", "memberof": "Phaser.GameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Blitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Blitter" } }, "description": "The parent Blitter object is responsible for updating this Bob.", "name": "blitter" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world, relative to the parent Blitter position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world, relative to the parent Blitter position.", "name": "y" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The Frame this Bob will render with, as defined in the Texture the parent Blitter is using.", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Should the Bob render visible or not to start with?", "name": "visible" } ], "scope": "static", "longname": "Phaser.GameObjects.Bob", "___id": "T000002R008349", "___s": true }, { "comment": "/**\r\n * The Blitter object that this Bob belongs to.\r\n *\r\n * @name Phaser.GameObjects.Bob#parent\r\n * @type {Phaser.GameObjects.Blitter}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Bob.js", "lineno": 43, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "The Blitter object that this Bob belongs to.", "name": "parent", "type": { "names": [ "Phaser.GameObjects.Blitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Blitter" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#parent", "scope": "instance", "kind": "member", "___id": "T000002R008352", "___s": true }, { "comment": "/**\r\n * The x position of this Bob, relative to the x position of the Blitter.\r\n *\r\n * @name Phaser.GameObjects.Bob#x\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Bob.js", "lineno": 52, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "The x position of this Bob, relative to the x position of the Blitter.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#x", "scope": "instance", "kind": "member", "___id": "T000002R008354", "___s": true }, { "comment": "/**\r\n * The y position of this Bob, relative to the y position of the Blitter.\r\n *\r\n * @name Phaser.GameObjects.Bob#y\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Bob.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "The y position of this Bob, relative to the y position of the Blitter.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#y", "scope": "instance", "kind": "member", "___id": "T000002R008356", "___s": true }, { "comment": "/**\r\n * The frame that the Bob uses to render with.\r\n * To change the frame use the `Bob.setFrame` method.\r\n *\r\n * @name Phaser.GameObjects.Bob#frame\r\n * @type {Phaser.Textures.Frame}\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Bob.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "The frame that the Bob uses to render with.\rTo change the frame use the `Bob.setFrame` method.", "name": "frame", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "access": "protected", "since": "3.0.0", "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#frame", "scope": "instance", "kind": "member", "___id": "T000002R008358", "___s": true }, { "comment": "/**\r\n * A blank object which can be used to store data related to this Bob in.\r\n *\r\n * @name Phaser.GameObjects.Bob#data\r\n * @type {object}\r\n * @default {}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Bob.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "A blank object which can be used to store data related to this Bob in.", "name": "data", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "defaultvalue": "{}", "since": "3.0.0", "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#data", "scope": "instance", "kind": "member", "___id": "T000002R008360", "___s": true }, { "comment": "/**\r\n * The tint value of this Bob.\r\n *\r\n * @name Phaser.GameObjects.Bob#tint\r\n * @type {number}\r\n * @default 0xffffff\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Bob.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "The tint value of this Bob.", "name": "tint", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.20.0", "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#tint", "scope": "instance", "kind": "member", "___id": "T000002R008362", "___s": true }, { "comment": "/**\r\n * The horizontally flipped state of the Bob.\r\n * A Bob that is flipped horizontally will render inversed on the horizontal axis.\r\n * Flipping always takes place from the middle of the texture.\r\n *\r\n * @name Phaser.GameObjects.Bob#flipX\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Bob.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "The horizontally flipped state of the Bob.\rA Bob that is flipped horizontally will render inversed on the horizontal axis.\rFlipping always takes place from the middle of the texture.", "name": "flipX", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#flipX", "scope": "instance", "kind": "member", "___id": "T000002R008368", "___s": true }, { "comment": "/**\r\n * The vertically flipped state of the Bob.\r\n * A Bob that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\r\n * Flipping always takes place from the middle of the texture.\r\n *\r\n * @name Phaser.GameObjects.Bob#flipY\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Bob.js", "lineno": 133, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "The vertically flipped state of the Bob.\rA Bob that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\rFlipping always takes place from the middle of the texture.", "name": "flipY", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#flipY", "scope": "instance", "kind": "member", "___id": "T000002R008370", "___s": true }, { "comment": "/**\r\n * Changes the Texture Frame being used by this Bob.\r\n * The frame must be part of the Texture the parent Blitter is using.\r\n * If no value is given it will use the default frame of the Blitter parent.\r\n *\r\n * @method Phaser.GameObjects.Bob#setFrame\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - The frame to be used during rendering.\r\n *\r\n * @return {this} This Bob Game Object.\r\n */", "meta": { "filename": "Bob.js", "lineno": 156, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Changes the Texture Frame being used by this Bob.\rThe frame must be part of the Texture the parent Blitter is using.\rIf 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", "number", "Phaser.Textures.Frame" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Textures.Frame" } ] } }, "optional": true, "description": "The frame to be used during rendering.", "name": "frame" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Bob Game Object." } ], "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#setFrame", "scope": "instance", "___id": "T000002R008374", "___s": true }, { "comment": "/**\r\n * Resets the horizontal and vertical flipped state of this Bob back to their default un-flipped state.\r\n *\r\n * @method Phaser.GameObjects.Bob#resetFlip\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Bob Game Object.\r\n */", "meta": { "filename": "Bob.js", "lineno": 186, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Bob Game Object." } ], "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#resetFlip", "scope": "instance", "___id": "T000002R008379", "___s": true }, { "comment": "/**\r\n * Resets this Bob.\r\n *\r\n * Changes the position to the values given, and optionally changes the frame.\r\n *\r\n * Also resets the flipX and flipY values, sets alpha back to 1 and visible to true.\r\n *\r\n * @method Phaser.GameObjects.Bob#reset\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x position of the Bob. Bob coordinates are relative to the position of the Blitter object.\r\n * @param {number} y - The y position of the Bob. Bob coordinates are relative to the position of the Blitter object.\r\n * @param {(string|number|Phaser.Textures.Frame)} [frame] - The Frame the Bob will use. It _must_ be part of the Texture the parent Blitter object is using.\r\n *\r\n * @return {this} This Bob Game Object.\r\n */", "meta": { "filename": "Bob.js", "lineno": 202, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Resets this Bob.\r\rChanges the position to the values given, and optionally changes the frame.\r\rAlso 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the Bob. Bob coordinates are relative to the position of the Blitter object.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the Bob. Bob coordinates are relative to the position of the Blitter object.", "name": "y" }, { "type": { "names": [ "string", "number", "Phaser.Textures.Frame" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Bob Game Object." } ], "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#reset", "scope": "instance", "___id": "T000002R008383", "___s": true }, { "comment": "/**\r\n * Changes the position of this Bob to the values given.\r\n *\r\n * @method Phaser.GameObjects.Bob#setPosition\r\n * @since 3.20.0\r\n *\r\n * @param {number} x - The x position of the Bob. Bob coordinates are relative to the position of the Blitter object.\r\n * @param {number} y - The y position of the Bob. Bob coordinates are relative to the position of the Blitter object.\r\n *\r\n * @return {this} This Bob Game Object.\r\n */", "meta": { "filename": "Bob.js", "lineno": 239, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Changes the position of this Bob to the values given.", "kind": "function", "name": "setPosition", "since": "3.20.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the Bob. Bob coordinates are relative to the position of the Blitter object.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the Bob. Bob coordinates are relative to the position of the Blitter object.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Bob Game Object." } ], "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#setPosition", "scope": "instance", "___id": "T000002R008392", "___s": true }, { "comment": "/**\r\n * Sets the horizontal flipped state of this Bob.\r\n *\r\n * @method Phaser.GameObjects.Bob#setFlipX\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - The flipped state. `false` for no flip, or `true` to be flipped.\r\n *\r\n * @return {this} This Bob Game Object.\r\n */", "meta": { "filename": "Bob.js", "lineno": 258, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Sets the horizontal flipped state of this Bob.", "kind": "function", "name": "setFlipX", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Bob Game Object." } ], "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#setFlipX", "scope": "instance", "___id": "T000002R008396", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Bob.\r\n *\r\n * @method Phaser.GameObjects.Bob#setFlipY\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - The flipped state. `false` for no flip, or `true` to be flipped.\r\n *\r\n * @return {this} This Bob Game Object.\r\n */", "meta": { "filename": "Bob.js", "lineno": 275, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Sets the vertical flipped state of this Bob.", "kind": "function", "name": "setFlipY", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Bob Game Object." } ], "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#setFlipY", "scope": "instance", "___id": "T000002R008399", "___s": true }, { "comment": "/**\r\n * Sets the horizontal and vertical flipped state of this Bob.\r\n *\r\n * @method Phaser.GameObjects.Bob#setFlip\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} x - The horizontal flipped state. `false` for no flip, or `true` to be flipped.\r\n * @param {boolean} y - The vertical flipped state. `false` for no flip, or `true` to be flipped.\r\n *\r\n * @return {this} This Bob Game Object.\r\n */", "meta": { "filename": "Bob.js", "lineno": 292, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Sets the horizontal and vertical flipped state of this Bob.", "kind": "function", "name": "setFlip", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "x" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The vertical flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Bob Game Object." } ], "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#setFlip", "scope": "instance", "___id": "T000002R008402", "___s": true }, { "comment": "/**\r\n * Sets the visibility of this Bob.\r\n *\r\n * An invisible Bob will skip rendering.\r\n *\r\n * @method Phaser.GameObjects.Bob#setVisible\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - The visible state of the Game Object.\r\n *\r\n * @return {this} This Bob Game Object.\r\n */", "meta": { "filename": "Bob.js", "lineno": 311, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Sets the visibility of this Bob.\r\rAn invisible Bob will skip rendering.", "kind": "function", "name": "setVisible", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Bob Game Object." } ], "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#setVisible", "scope": "instance", "___id": "T000002R008406", "___s": true }, { "comment": "/**\r\n * Set the Alpha level of this Bob. The alpha controls the opacity of the Game Object as it renders.\r\n * Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\r\n *\r\n * A Bob with alpha 0 will skip rendering.\r\n *\r\n * @method Phaser.GameObjects.Bob#setAlpha\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The alpha value used for this Bob. Between 0 and 1.\r\n *\r\n * @return {this} This Bob Game Object.\r\n */", "meta": { "filename": "Bob.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Set the Alpha level of this Bob. The alpha controls the opacity of the Game Object as it renders.\rAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\r\rA Bob with alpha 0 will skip rendering.", "kind": "function", "name": "setAlpha", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha value used for this Bob. Between 0 and 1.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Bob Game Object." } ], "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#setAlpha", "scope": "instance", "___id": "T000002R008409", "___s": true }, { "comment": "/**\r\n * Sets the tint color applied to this Bob when it is rendered. The tint is a hex color value\r\n * that is multiplied with the Bob's texture, allowing you to colorize it without needing a\r\n * separate texture. A value of `0xffffff` (white) applies no tint. A value of `0xff0000` will\r\n * tint the Bob red.\r\n *\r\n * @method Phaser.GameObjects.Bob#setTint\r\n * @since 3.20.0\r\n *\r\n * @param {number} value - The tint value used for this Bob. Between 0 and 0xffffff.\r\n *\r\n * @return {this} This Bob Game Object.\r\n */", "meta": { "filename": "Bob.js", "lineno": 350, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Sets the tint color applied to this Bob when it is rendered. The tint is a hex color value\rthat is multiplied with the Bob's texture, allowing you to colorize it without needing a\rseparate texture. A value of `0xffffff` (white) applies no tint. A value of `0xff0000` will\rtint the Bob red.", "kind": "function", "name": "setTint", "since": "3.20.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The tint value used for this Bob. Between 0 and 0xffffff.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Bob Game Object." } ], "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#setTint", "scope": "instance", "___id": "T000002R008412", "___s": true }, { "comment": "/**\r\n * Destroys this Bob instance.\r\n * Removes itself from the Blitter and clears the parent, frame and data properties.\r\n *\r\n * @method Phaser.GameObjects.Bob#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Bob.js", "lineno": 370, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "Destroys this Bob instance.\rRemoves 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", "___id": "T000002R008415", "___s": true }, { "comment": "/**\r\n * The visible state of the Bob.\r\n *\r\n * An invisible Bob will skip rendering.\r\n *\r\n * @name Phaser.GameObjects.Bob#visible\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Bob.js", "lineno": 388, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "The visible state of the Bob.\r\rAn invisible Bob will skip rendering.", "name": "visible", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#visible", "scope": "instance", "kind": "member", "___id": "T000002R008421", "___s": true }, { "comment": "/**\r\n * The alpha value of the Bob, between 0 and 1.\r\n *\r\n * A Bob with alpha 0 will skip rendering.\r\n *\r\n * @name Phaser.GameObjects.Bob#alpha\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Bob.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\blitter", "code": {} }, "description": "The alpha value of the Bob, between 0 and 1.\r\rA Bob with alpha 0 will skip rendering.", "name": "alpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Bob", "longname": "Phaser.GameObjects.Bob#alpha", "scope": "instance", "kind": "member", "___id": "T000002R008427", "___s": true }, { "comment": "/**\r\n * Builds a Game Object using the provided configuration object, applying properties such as\r\n * position, depth, flip, scale, scroll factor, rotation, alpha, origin, blend mode, and\r\n * visibility. If the config's `add` property is `true` (the default), the Game Object is\r\n * added to the Scene's Display List. If the Game Object has a `preUpdate` method it is also\r\n * added to the Scene's Update List. This function is used internally by Game Object factories\r\n * and creators, and is not typically called directly.\r\n *\r\n * @function Phaser.GameObjects.BuildGameObject\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - A reference to the Scene.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The initial GameObject.\r\n * @param {Phaser.Types.GameObjects.GameObjectConfig} config - The config to build the GameObject with.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The built Game Object.\r\n */", "meta": { "filename": "BuildGameObject.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Builds a Game Object using the provided configuration object, applying properties such as\rposition, depth, flip, scale, scroll factor, rotation, alpha, origin, blend mode, and\rvisibility. If the config's `add` property is `true` (the default), the Game Object is\radded to the Scene's Display List. If the Game Object has a `preUpdate` method it is also\radded to the Scene's Update List. This function is used internally by Game Object factories\rand creators, and is not typically called directly.", "kind": "function", "name": "BuildGameObject", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "A reference to the Scene.", "name": "scene" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The initial GameObject.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.GameObjectConfig" } }, "description": "The config to build the GameObject with.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The built Game Object." } ], "memberof": "Phaser.GameObjects", "longname": "Phaser.GameObjects.BuildGameObject", "scope": "static", "___id": "T000002R008436", "___s": true }, { "comment": "/**\r\n * Reads the `anims` property from a Game Object configuration object and uses it to\r\n * configure the animation state of the given Sprite. If the `anims` property is absent,\r\n * the Sprite is returned unchanged.\r\n *\r\n * The `anims` value may be either a string or an object. If it is a string, it is treated\r\n * as an animation key and the animation is played immediately. If it is an object, the\r\n * animation key and playback options (such as `delay`, `repeat`, `yoyo`, and `startFrame`)\r\n * are read from it. Depending on the `play` and `delayedPlay` properties, the animation\r\n * will be played immediately, played after a delay, or simply loaded ready to play later.\r\n *\r\n * @function Phaser.GameObjects.BuildGameObjectAnimation\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Sprite} sprite - The Sprite whose animation state will be configured.\r\n * @param {object} config - The Game Object configuration object. The `anims` property of this object is used to configure the animation.\r\n *\r\n * @return {Phaser.GameObjects.Sprite} The updated Sprite.\r\n */", "meta": { "filename": "BuildGameObjectAnimation.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Reads the `anims` property from a Game Object configuration object and uses it to\rconfigure the animation state of the given Sprite. If the `anims` property is absent,\rthe Sprite is returned unchanged.\r\rThe `anims` value may be either a string or an object. If it is a string, it is treated\ras an animation key and the animation is played immediately. If it is an object, the\ranimation key and playback options (such as `delay`, `repeat`, `yoyo`, and `startFrame`)\rare read from it. Depending on the `play` and `delayedPlay` properties, the animation\rwill be played immediately, played after a delay, or simply loaded ready to play later.", "kind": "function", "name": "BuildGameObjectAnimation", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "The Sprite whose animation state will be configured.", "name": "sprite" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The Game Object configuration object. The `anims` property of this object is used to configure the animation.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "The updated Sprite." } ], "memberof": "Phaser.GameObjects", "longname": "Phaser.GameObjects.BuildGameObjectAnimation", "scope": "static", "___id": "T000002R008461", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A CaptureFrame is a special type of GameObject that allows you to\r\n * capture the current state of the render.\r\n * For example, if you place a CaptureFrame between two other objects,\r\n * it will capture the first object to a texture, but not the second.\r\n * This is useful for full-scene post-processing prior to render completion,\r\n * such as a layer of water.\r\n *\r\n * This is a WebGL only feature and is not available in Canvas mode.\r\n *\r\n * You must activate the `forceComposite` property of the Camera,\r\n * or otherwise use this object within a framebuffer, to use this feature.\r\n * Examples of framebuffer situations include Filters, DynamicTexture,\r\n * and a camera with alpha between 0 and 1.\r\n *\r\n * This object does not render anything. It simply captures a texture\r\n * from the current framebuffer at the moment it 'renders'.\r\n * If you add filters to this object, it will capture the clear, temporary\r\n * framebuffer used for the filter, not the main framebuffer.\r\n * If you add filters to a Container that contains this object,\r\n * it will capture only objects within that Container.\r\n * If you set `visible` to `false`, it will just stop capturing.\r\n *\r\n * @example\r\n * // Within a Scene's `create` method:\r\n *\r\n * // This image will be captured:\r\n * var image1 = this.add.image(0, 0, 'image1');\r\n *\r\n * // Enable framebuffer usage:\r\n * this.cameras.main.setForceComposite(true);\r\n *\r\n * // Set up a CaptureFrame:\r\n * var captureFrame = this.add.captureFrame('myCaptureFrame');\r\n *\r\n * // This image will not be captured, and can display the captured image:\r\n * var image2 = this.add.image(0, 0, 'myCaptureFrame');\r\n * // Add filters to image2 to distort the captured image.\r\n *\r\n * @class CaptureFrame\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 4.0.0\r\n * @webglOnly\r\n *\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this CaptureFrame belongs.\r\n * @param {string} key - The key of the texture to create from this CaptureFrame.\r\n */", "meta": { "filename": "CaptureFrame.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\captureframe", "code": {} }, "classdesc": "A CaptureFrame is a special type of GameObject that allows you to\rcapture the current state of the render.\rFor example, if you place a CaptureFrame between two other objects,\rit will capture the first object to a texture, but not the second.\rThis is useful for full-scene post-processing prior to render completion,\rsuch as a layer of water.\r\rThis is a WebGL only feature and is not available in Canvas mode.\r\rYou must activate the `forceComposite` property of the Camera,\ror otherwise use this object within a framebuffer, to use this feature.\rExamples of framebuffer situations include Filters, DynamicTexture,\rand a camera with alpha between 0 and 1.\r\rThis object does not render anything. It simply captures a texture\rfrom the current framebuffer at the moment it 'renders'.\rIf you add filters to this object, it will capture the clear, temporary\rframebuffer used for the filter, not the main framebuffer.\rIf you add filters to a Container that contains this object,\rit will capture only objects within that Container.\rIf you set `visible` to `false`, it will just stop capturing.", "examples": [ "// Within a Scene's `create` method:\r\r// This image will be captured:\rvar image1 = this.add.image(0, 0, 'image1');\r\r// Enable framebuffer usage:\rthis.cameras.main.setForceComposite(true);\r\r// Set up a CaptureFrame:\rvar captureFrame = this.add.captureFrame('myCaptureFrame');\r\r// This image will not be captured, and can display the captured image:\rvar image2 = this.add.image(0, 0, 'myCaptureFrame');\r// Add filters to image2 to distort the captured image." ], "kind": "class", "name": "CaptureFrame", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.RenderNodes", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.GameObjects", "since": "4.0.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this CaptureFrame belongs.", "name": "scene" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture to create from this CaptureFrame.", "name": "key" } ], "scope": "static", "longname": "Phaser.GameObjects.CaptureFrame", "___id": "T000002R008487", "___s": true }, { "comment": "/**\r\n * The drawing context of this CaptureFrame.\r\n * This contains the WebGL framebuffer and texture data.\r\n *\r\n * @name Phaser.GameObjects.CaptureFrame#drawingContext\r\n * @type {Phaser.Renderer.WebGL.DrawingContext}\r\n * @webglOnly\r\n * @since 4.0.0\r\n */", "meta": { "filename": "CaptureFrame.js", "lineno": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\captureframe", "code": {} }, "description": "The drawing context of this CaptureFrame.\rThis contains the WebGL framebuffer and texture data.", "name": "drawingContext", "type": { "names": [ "Phaser.Renderer.WebGL.DrawingContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.DrawingContext" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "memberof": "Phaser.GameObjects.CaptureFrame", "longname": "Phaser.GameObjects.CaptureFrame#drawingContext", "scope": "instance", "kind": "member", "___id": "T000002R008493", "___s": true }, { "comment": "/**\r\n * A texture containing the captured frame.\r\n * This is updated when the GameObject renders.\r\n *\r\n * @name Phaser.GameObjects.CaptureFrame#captureTexture\r\n * @type {Phaser.Textures.Texture}\r\n * @webglOnly\r\n * @since 4.0.0\r\n */", "meta": { "filename": "CaptureFrame.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\captureframe", "code": {} }, "description": "A texture containing the captured frame.\rThis is updated when the GameObject renders.", "name": "captureTexture", "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "memberof": "Phaser.GameObjects.CaptureFrame", "longname": "Phaser.GameObjects.CaptureFrame#captureTexture", "scope": "instance", "kind": "member", "___id": "T000002R008497", "___s": true }, { "comment": "/**\r\n * Set the alpha value of this CaptureFrame.\r\n * This has no effect and is only present for compatibility with other Game Objects.\r\n *\r\n * @method Phaser.GameObjects.CaptureFrame#setAlpha\r\n * @since 4.0.0\r\n * @webglOnly\r\n * @param {number} alpha - The alpha value (not used).\r\n * @return {this} This Game Object instance, for method chaining.\r\n */", "meta": { "filename": "CaptureFrame.js", "lineno": 131, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\captureframe", "code": {} }, "description": "Set the alpha value of this CaptureFrame.\rThis has no effect and is only present for compatibility with other Game Objects.", "kind": "function", "name": "setAlpha", "since": "4.0.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha value (not used).", "name": "alpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance, for method chaining." } ], "memberof": "Phaser.GameObjects.CaptureFrame", "longname": "Phaser.GameObjects.CaptureFrame#setAlpha", "scope": "instance", "___id": "T000002R008502", "___s": true }, { "comment": "/**\r\n * Set the scroll factor of this CaptureFrame.\r\n * This has no effect and is only present for compatibility with other Game Objects.\r\n *\r\n * @method Phaser.GameObjects.CaptureFrame#setScrollFactor\r\n * @since 4.0.0\r\n * @webglOnly\r\n * @param {number} x - The horizontal scroll factor (not used).\r\n * @param {number} y - The vertical scroll factor (not used).\r\n * @return {this} This Game Object instance, for method chaining.\r\n */", "meta": { "filename": "CaptureFrame.js", "lineno": 146, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\captureframe", "code": {} }, "description": "Set the scroll factor of this CaptureFrame.\rThis has no effect and is only present for compatibility with other Game Objects.", "kind": "function", "name": "setScrollFactor", "since": "4.0.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal scroll factor (not used).", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical scroll factor (not used).", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance, for method chaining." } ], "memberof": "Phaser.GameObjects.CaptureFrame", "longname": "Phaser.GameObjects.CaptureFrame#setScrollFactor", "scope": "instance", "___id": "T000002R008504", "___s": true }, { "comment": "/**\r\n * Creates a new CaptureFrame Game Object and returns it.\r\n *\r\n * A CaptureFrame is a special Game Object that captures the current state of the WebGL framebuffer\r\n * at the point it is rendered in the display list. Objects rendered before it are captured to a\r\n * named texture; objects rendered after it are not. This is useful for full-scene post-processing\r\n * effects such as a layer of water or a distortion overlay. The captured texture can then be\r\n * referenced by key and used on other Game Objects or filters.\r\n *\r\n * This is a WebGL-only feature and has no effect in Canvas mode. The Camera must have\r\n * `forceComposite` enabled, or the CaptureFrame must be used within a framebuffer context\r\n * (such as a Filter, DynamicTexture, or a Camera with alpha between 0 and 1).\r\n *\r\n * Note: This method will only be available if the CaptureFrame Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#captureFrame\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.GameObjectConfig} config - The configuration object this Game Object will use to create itself. CaptureFrame only uses the `key`, `visible`, `depth`, and `add` properties.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.CaptureFrame} The Game Object that was created.\r\n */", "meta": { "filename": "CaptureFrameCreator.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\captureframe", "code": {} }, "description": "Creates a new CaptureFrame Game Object and returns it.\r\rA CaptureFrame is a special Game Object that captures the current state of the WebGL framebuffer\rat the point it is rendered in the display list. Objects rendered before it are captured to a\rnamed texture; objects rendered after it are not. This is useful for full-scene post-processing\reffects such as a layer of water or a distortion overlay. The captured texture can then be\rreferenced by key and used on other Game Objects or filters.\r\rThis is a WebGL-only feature and has no effect in Canvas mode. The Camera must have\r`forceComposite` enabled, or the CaptureFrame must be used within a framebuffer context\r(such as a Filter, DynamicTexture, or a Camera with alpha between 0 and 1).\r\rNote: This method will only be available if the CaptureFrame Game Object has been built into Phaser.", "kind": "function", "name": "captureFrame", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.GameObjectConfig" } }, "description": "The configuration object this Game Object will use to create itself. CaptureFrame only uses the `key`, `visible`, `depth`, and `add` properties.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.CaptureFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.CaptureFrame" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#captureFrame", "scope": "instance", "___id": "T000002R008510", "___s": true }, { "comment": "/**\r\n * Creates a new CaptureFrame Game Object and adds it to the Scene.\r\n *\r\n * A CaptureFrame captures the current state of the WebGL framebuffer at the point it is rendered\r\n * in the display list, storing the result as a texture identified by the given key. Other Game Objects\r\n * can then reference this key to display or process the captured image. This is useful for\r\n * full-scene post-processing effects such as water reflections or screen-space distortions.\r\n *\r\n * This is a WebGL only feature and will not work in Canvas mode. The Camera must have\r\n * `forceComposite` enabled, or the CaptureFrame must be rendered within a framebuffer context\r\n * (such as a Filter, DynamicTexture, or a Camera with a non-default alpha value).\r\n *\r\n * Note: This method will only be available if the CaptureFrame Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#captureFrame\r\n * @since 4.0.0\r\n *\r\n * @param {string} key - The key under which the captured texture will be stored. Other Game Objects can use this key to reference the captured frame.\r\n *\r\n * @return {Phaser.GameObjects.CaptureFrame} The Game Object that was created.\r\n */", "meta": { "filename": "CaptureFrameFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\captureframe", "code": {} }, "description": "Creates a new CaptureFrame Game Object and adds it to the Scene.\r\rA CaptureFrame captures the current state of the WebGL framebuffer at the point it is rendered\rin the display list, storing the result as a texture identified by the given key. Other Game Objects\rcan then reference this key to display or process the captured image. This is useful for\rfull-scene post-processing effects such as water reflections or screen-space distortions.\r\rThis is a WebGL only feature and will not work in Canvas mode. The Camera must have\r`forceComposite` enabled, or the CaptureFrame must be rendered within a framebuffer context\r(such as a Filter, DynamicTexture, or a Camera with a non-default alpha value).\r\rNote: This method will only be available if the CaptureFrame Game Object has been built into Phaser.", "kind": "function", "name": "captureFrame", "since": "4.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key under which the captured texture will be stored. Other Game Objects can use this key to reference the captured frame.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.CaptureFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.CaptureFrame" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#captureFrame", "scope": "instance", "___id": "T000002R008519", "___s": true }, { "comment": "/**\r\n * Provides methods and properties for managing the alpha (opacity) of a Game Object.\r\n * Alpha values range from 0 (fully transparent) to 1 (fully opaque).\r\n *\r\n * Under WebGL, alpha can be set independently for each of the four corners of the\r\n * Game Object, allowing gradient transparency effects. Under Canvas, only a single\r\n * global alpha value is used.\r\n *\r\n * This component is designed to be applied as a mixin to Game Objects and should\r\n * not be used directly.\r\n *\r\n * @namespace Phaser.GameObjects.Components.Alpha\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Alpha.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods and properties for managing the alpha (opacity) of a Game Object.\rAlpha values range from 0 (fully transparent) to 1 (fully opaque).\r\rUnder WebGL, alpha can be set independently for each of the four corners of the\rGame Object, allowing gradient transparency effects. Under Canvas, only a single\rglobal alpha value is used.\r\rThis component is designed to be applied as a mixin to Game Objects and should\rnot be used directly.", "kind": "namespace", "name": "Alpha", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Alpha", "scope": "static", "___id": "T000002R008539", "___s": true }, { "comment": "/**\r\n * Clears all alpha values associated with this Game Object.\r\n *\r\n * Immediately sets the alpha levels back to 1 (fully opaque).\r\n *\r\n * @method Phaser.GameObjects.Components.Alpha#clearAlpha\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Alpha.js", "lineno": 84, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Clears all alpha values associated with this Game Object.\r\rImmediately sets the alpha levels back to 1 (fully opaque).", "kind": "function", "name": "clearAlpha", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Alpha", "longname": "Phaser.GameObjects.Components.Alpha#clearAlpha", "scope": "instance", "___id": "T000002R008551", "___s": true }, { "comment": "/**\r\n * Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\r\n * Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\r\n *\r\n * If your game is running under WebGL you can optionally specify four different alpha values, each of which\r\n * correspond to the four corners of the Game Object. Under Canvas only the `topLeft` value given is used.\r\n *\r\n * @method Phaser.GameObjects.Components.Alpha#setAlpha\r\n * @since 3.0.0\r\n *\r\n * @param {number} [topLeft=1] - 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.\r\n * @param {number} [topRight] - The alpha value used for the top-right of the Game Object. WebGL only.\r\n * @param {number} [bottomLeft] - The alpha value used for the bottom-left of the Game Object. WebGL only.\r\n * @param {number} [bottomRight] - The alpha value used for the bottom-right of the Game Object. WebGL only.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Alpha.js", "lineno": 99, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\rAlpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\r\rIf your game is running under WebGL you can optionally specify four different alpha values, each of which\rcorrespond 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The alpha value used for the top-right of the Game Object. WebGL only.", "name": "topRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The alpha value used for the bottom-left of the Game Object. WebGL only.", "name": "bottomLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The alpha value used for the bottom-right of the Game Object. WebGL only.", "name": "bottomRight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Alpha", "longname": "Phaser.GameObjects.Components.Alpha#setAlpha", "scope": "instance", "___id": "T000002R008553", "___s": true }, { "comment": "/**\r\n * The alpha value of the Game Object, between 0 (fully transparent) and 1 (fully opaque).\r\n *\r\n * This is a global value that impacts the entire Game Object. Setting it also updates\r\n * all four corner alpha values (`alphaTopLeft`, `alphaTopRight`, `alphaBottomLeft`,\r\n * `alphaBottomRight`) to the same value. The input is clamped to the range [0, 1].\r\n *\r\n * @name Phaser.GameObjects.Components.Alpha#alpha\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Alpha.js", "lineno": 136, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The alpha value of the Game Object, between 0 (fully transparent) and 1 (fully opaque).\r\rThis is a global value that impacts the entire Game Object. Setting it also updates\rall four corner alpha values (`alphaTopLeft`, `alphaTopRight`, `alphaBottomLeft`,\r`alphaBottomRight`) to the same value. The input is clamped to the range [0, 1].", "name": "alpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Alpha", "longname": "Phaser.GameObjects.Components.Alpha#alpha", "scope": "instance", "kind": "member", "___id": "T000002R008561", "___s": true }, { "comment": "/**\r\n * The alpha value starting from the top-left of the Game Object.\r\n * This value is interpolated from the corner to the center of the Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Alpha#alphaTopLeft\r\n * @type {number}\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Alpha.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The alpha value starting from the top-left of the Game Object.\rThis value is interpolated from the corner to the center of the Game Object.", "name": "alphaTopLeft", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Alpha", "longname": "Phaser.GameObjects.Components.Alpha#alphaTopLeft", "scope": "instance", "kind": "member", "___id": "T000002R008573", "___s": true }, { "comment": "/**\r\n * The alpha value starting from the top-right of the Game Object.\r\n * This value is interpolated from the corner to the center of the Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Alpha#alphaTopRight\r\n * @type {number}\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Alpha.js", "lineno": 206, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The alpha value starting from the top-right of the Game Object.\rThis value is interpolated from the corner to the center of the Game Object.", "name": "alphaTopRight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Alpha", "longname": "Phaser.GameObjects.Components.Alpha#alphaTopRight", "scope": "instance", "kind": "member", "___id": "T000002R008580", "___s": true }, { "comment": "/**\r\n * The alpha value starting from the bottom-left of the Game Object.\r\n * This value is interpolated from the corner to the center of the Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Alpha#alphaBottomLeft\r\n * @type {number}\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Alpha.js", "lineno": 236, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The alpha value starting from the bottom-left of the Game Object.\rThis value is interpolated from the corner to the center of the Game Object.", "name": "alphaBottomLeft", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Alpha", "longname": "Phaser.GameObjects.Components.Alpha#alphaBottomLeft", "scope": "instance", "kind": "member", "___id": "T000002R008587", "___s": true }, { "comment": "/**\r\n * The alpha value starting from the bottom-right of the Game Object.\r\n * This value is interpolated from the corner to the center of the Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Alpha#alphaBottomRight\r\n * @type {number}\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Alpha.js", "lineno": 266, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The alpha value starting from the bottom-right of the Game Object.\rThis value is interpolated from the corner to the center of the Game Object.", "name": "alphaBottomRight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Alpha", "longname": "Phaser.GameObjects.Components.Alpha#alphaBottomRight", "scope": "instance", "kind": "member", "___id": "T000002R008594", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the alpha property of a Game Object.\r\n * Unlike the full Alpha component, which supports individual alpha values for each corner\r\n * of a Game Object, this component applies a single uniform alpha across the whole object.\r\n * Should be applied as a mixin and not used directly.\r\n *\r\n * @namespace Phaser.GameObjects.Components.AlphaSingle\r\n * @since 3.22.0\r\n */", "meta": { "filename": "AlphaSingle.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for setting the alpha property of a Game Object.\rUnlike the full Alpha component, which supports individual alpha values for each corner\rof a Game Object, this component applies a single uniform alpha across the whole object.\rShould 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", "___id": "T000002R008604", "___s": true }, { "comment": "/**\r\n * Clears the alpha value associated with this Game Object.\r\n *\r\n * Immediately sets the alpha back to 1 (fully opaque).\r\n *\r\n * @method Phaser.GameObjects.Components.AlphaSingle#clearAlpha\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "AlphaSingle.js", "lineno": 35, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Clears the alpha value associated with this Game Object.\r\rImmediately sets the alpha back to 1 (fully opaque).", "kind": "function", "name": "clearAlpha", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.AlphaSingle", "longname": "Phaser.GameObjects.Components.AlphaSingle#clearAlpha", "scope": "instance", "___id": "T000002R008608", "___s": true }, { "comment": "/**\r\n * Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\r\n * Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.\r\n *\r\n * @method Phaser.GameObjects.Components.AlphaSingle#setAlpha\r\n * @since 3.0.0\r\n *\r\n * @param {number} [value=1] - The alpha value applied across the whole Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "AlphaSingle.js", "lineno": 50, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.\rAlpha 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha value applied across the whole Game Object.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.AlphaSingle", "longname": "Phaser.GameObjects.Components.AlphaSingle#setAlpha", "scope": "instance", "___id": "T000002R008610", "___s": true }, { "comment": "/**\r\n * The alpha value of the Game Object.\r\n *\r\n * This is a global value, impacting the entire Game Object, not just a region of it.\r\n * The value is clamped to the range [0, 1]. Setting alpha to 0 also clears the render\r\n * flag, preventing the Game Object from being drawn until the alpha is raised above 0 again.\r\n *\r\n * @name Phaser.GameObjects.Components.AlphaSingle#alpha\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AlphaSingle.js", "lineno": 70, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The alpha value of the Game Object.\r\rThis is a global value, impacting the entire Game Object, not just a region of it.\rThe value is clamped to the range [0, 1]. Setting alpha to 0 also clears the render\rflag, preventing the Game Object from being drawn until the alpha is raised above 0 again.", "name": "alpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.AlphaSingle", "longname": "Phaser.GameObjects.Components.AlphaSingle#alpha", "scope": "instance", "kind": "member", "___id": "T000002R008614", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the blend mode of a Game Object.\r\n * Blend modes control how a Game Object is composited onto the display when rendered.\r\n * They determine how the pixels of the object are blended with the pixels already on screen,\r\n * enabling effects such as additive lighting, screen blending, and erasing.\r\n *\r\n * This component is designed to be applied as a mixin to Game Objects and should not be\r\n * used directly. Any Game Object that mixes in this component gains the `blendMode` property\r\n * and the `setBlendMode` method.\r\n *\r\n * @namespace Phaser.GameObjects.Components.BlendMode\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendMode.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for setting the blend mode of a Game Object.\rBlend modes control how a Game Object is composited onto the display when rendered.\rThey determine how the pixels of the object are blended with the pixels already on screen,\renabling effects such as additive lighting, screen blending, and erasing.\r\rThis component is designed to be applied as a mixin to Game Objects and should not be\rused directly. Any Game Object that mixes in this component gains the `blendMode` property\rand the `setBlendMode` method.", "kind": "namespace", "name": "BlendMode", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.BlendMode", "scope": "static", "___id": "T000002R008624", "___s": true }, { "comment": "/**\r\n * Sets the Blend Mode being used by this Game Object.\r\n *\r\n * This can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\r\n *\r\n * Under WebGL only the following Blend Modes are available:\r\n *\r\n * * NORMAL\r\n * * ADD\r\n * * MULTIPLY\r\n * * SCREEN\r\n * * ERASE\r\n *\r\n * Canvas has more available depending on browser support.\r\n *\r\n * You can also create your own custom Blend Modes in WebGL.\r\n *\r\n * Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending\r\n * on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\r\n * reasons try to be careful about the construction of your Scene and the frequency with which blend modes\r\n * are used.\r\n *\r\n * @name Phaser.GameObjects.Components.BlendMode#blendMode\r\n * @type {(Phaser.BlendModes|string|number)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BlendMode.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the Blend Mode being used by this Game Object.\r\rThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\r\rUnder WebGL only the following Blend Modes are available:\r\r* NORMAL\r* ADD\r* MULTIPLY\r* SCREEN\r* ERASE\r\rCanvas has more available depending on browser support.\r\rYou can also create your own custom Blend Modes in WebGL.\r\rBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\ron support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\rreasons try to be careful about the construction of your Scene and the frequency with which blend modes\rare used.", "name": "blendMode", "type": { "names": [ "Phaser.BlendModes", "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.BlendModes" }, { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.BlendMode", "longname": "Phaser.GameObjects.Components.BlendMode#blendMode", "scope": "instance", "kind": "member", "___id": "T000002R008628", "___s": true }, { "comment": "/**\r\n * Sets the Blend Mode being used by this Game Object.\r\n *\r\n * This can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\r\n *\r\n * Under WebGL only the following Blend Modes are available:\r\n *\r\n * * NORMAL\r\n * * ADD\r\n * * MULTIPLY\r\n * * SCREEN\r\n * * ERASE (only works when rendering to a framebuffer, like a Render Texture)\r\n *\r\n * Canvas has more available depending on browser support.\r\n *\r\n * You can also create your own custom Blend Modes in WebGL.\r\n *\r\n * Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending\r\n * on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\r\n * reasons try to be careful about the construction of your Scene and the frequency with which blend modes\r\n * are used.\r\n *\r\n * @method Phaser.GameObjects.Components.BlendMode#setBlendMode\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.BlendModes|number)} value - The BlendMode value. Either a string, a CONST or a number.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "BlendMode.js", "lineno": 86, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the Blend Mode being used by this Game Object.\r\rThis can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)\r\rUnder WebGL only the following Blend Modes are available:\r\r* NORMAL\r* ADD\r* MULTIPLY\r* SCREEN\r* ERASE (only works when rendering to a framebuffer, like a Render Texture)\r\rCanvas has more available depending on browser support.\r\rYou can also create your own custom Blend Modes in WebGL.\r\rBlend modes have different effects under Canvas and WebGL, and from browser to browser, depending\ron support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these\rreasons try to be careful about the construction of your Scene and the frequency with which blend modes\rare used.", "kind": "function", "name": "setBlendMode", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.BlendModes", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.BlendModes" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The BlendMode value. Either a string, a CONST or a number.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.BlendMode", "longname": "Phaser.GameObjects.Components.BlendMode#setBlendMode", "scope": "instance", "___id": "T000002R008635", "___s": true }, { "comment": "/**\r\n * Provides methods used for calculating and setting the size of a non-Frame based Game Object.\r\n * A non-Frame based Game Object is one that derives its dimensions from internal logic rather\r\n * than from a texture frame, such as Graphics, Text, or BitmapText objects.\r\n *\r\n * The component exposes `width` and `height` as the native (un-scaled) dimensions, and\r\n * `displayWidth` and `displayHeight` as the rendered dimensions after the scale factor is applied.\r\n *\r\n * Should be applied as a mixin and not used directly.\r\n *\r\n * @namespace Phaser.GameObjects.Components.ComputedSize\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ComputedSize.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for calculating and setting the size of a non-Frame based Game Object.\rA non-Frame based Game Object is one that derives its dimensions from internal logic rather\rthan from a texture frame, such as Graphics, Text, or BitmapText objects.\r\rThe component exposes `width` and `height` as the native (un-scaled) dimensions, and\r`displayWidth` and `displayHeight` as the rendered dimensions after the scale factor is applied.\r\rShould 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", "___id": "T000002R008639", "___s": true }, { "comment": "/**\r\n * The native (un-scaled) width of this Game Object.\r\n *\r\n * Changing this value will not change the size that the Game Object is rendered in-game.\r\n * For that you need to either set the scale of the Game Object (`setScale`) or use\r\n * the `displayWidth` property.\r\n *\r\n * @name Phaser.GameObjects.Components.ComputedSize#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ComputedSize.js", "lineno": 23, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The native (un-scaled) width of this Game Object.\r\rChanging this value will not change the size that the Game Object is rendered in-game.\rFor that you need to either set the scale of the Game Object (`setScale`) or use\rthe `displayWidth` property.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.ComputedSize", "longname": "Phaser.GameObjects.Components.ComputedSize#width", "scope": "instance", "kind": "member", "___id": "T000002R008641", "___s": true }, { "comment": "/**\r\n * The native (un-scaled) height of this Game Object.\r\n *\r\n * Changing this value will not change the size that the Game Object is rendered in-game.\r\n * For that you need to either set the scale of the Game Object (`setScale`) or use\r\n * the `displayHeight` property.\r\n *\r\n * @name Phaser.GameObjects.Components.ComputedSize#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ComputedSize.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The native (un-scaled) height of this Game Object.\r\rChanging this value will not change the size that the Game Object is rendered in-game.\rFor that you need to either set the scale of the Game Object (`setScale`) or use\rthe `displayHeight` property.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.ComputedSize", "longname": "Phaser.GameObjects.Components.ComputedSize#height", "scope": "instance", "kind": "member", "___id": "T000002R008643", "___s": true }, { "comment": "/**\r\n * The displayed width of this Game Object.\r\n *\r\n * This value takes into account the scale factor.\r\n *\r\n * Setting this value will adjust the Game Object's scale property.\r\n *\r\n * @name Phaser.GameObjects.Components.ComputedSize#displayWidth\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ComputedSize.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The displayed width of this Game Object.\r\rThis value takes into account the scale factor.\r\rSetting this value will adjust the Game Object's scale property.", "name": "displayWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.ComputedSize", "longname": "Phaser.GameObjects.Components.ComputedSize#displayWidth", "scope": "instance", "kind": "member", "___id": "T000002R008645", "___s": true }, { "comment": "/**\r\n * The displayed height of this Game Object.\r\n *\r\n * This value takes into account the scale factor.\r\n *\r\n * Setting this value will adjust the Game Object's scale property.\r\n *\r\n * @name Phaser.GameObjects.Components.ComputedSize#displayHeight\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ComputedSize.js", "lineno": 74, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The displayed height of this Game Object.\r\rThis value takes into account the scale factor.\r\rSetting this value will adjust the Game Object's scale property.", "name": "displayHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.ComputedSize", "longname": "Phaser.GameObjects.Components.ComputedSize#displayHeight", "scope": "instance", "kind": "member", "___id": "T000002R008650", "___s": true }, { "comment": "/**\r\n * Sets the internal size of this Game Object, as used for frame or physics body creation.\r\n *\r\n * This will not change the size that the Game Object is rendered in-game.\r\n * For that you need to either set the scale of the Game Object (`setScale`) or call the\r\n * `setDisplaySize` method, which is the same thing as changing the scale but allows you\r\n * to do so by giving pixel values.\r\n *\r\n * If you have enabled this Game Object for input, changing the size will _not_ change the\r\n * size of the hit area. To do this you should adjust the `input.hitArea` object directly.\r\n *\r\n * @method Phaser.GameObjects.Components.ComputedSize#setSize\r\n * @since 3.4.0\r\n *\r\n * @param {number} width - The width of this Game Object.\r\n * @param {number} height - The height of this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "ComputedSize.js", "lineno": 99, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the internal size of this Game Object, as used for frame or physics body creation.\r\rThis will not change the size that the Game Object is rendered in-game.\rFor that you need to either set the scale of the Game Object (`setScale`) or call the\r`setDisplaySize` method, which is the same thing as changing the scale but allows you\rto do so by giving pixel values.\r\rIf you have enabled this Game Object for input, changing the size will _not_ change the\rsize 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.ComputedSize", "longname": "Phaser.GameObjects.Components.ComputedSize#setSize", "scope": "instance", "___id": "T000002R008655", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Game Object.\r\n *\r\n * Calling this will adjust the `scaleX` and `scaleY` properties so that the Game Object\r\n * is rendered at the specified pixel dimensions. It is the equivalent of setting the scale\r\n * manually, but expressed in pixels rather than as a multiplier.\r\n *\r\n * @method Phaser.GameObjects.Components.ComputedSize#setDisplaySize\r\n * @since 3.4.0\r\n *\r\n * @param {number} width - The width of this Game Object.\r\n * @param {number} height - The height of this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "ComputedSize.js", "lineno": 126, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the `scaleX` and `scaleY` properties so that the Game Object\ris rendered at the specified pixel dimensions. It is the equivalent of setting the scale\rmanually, but expressed in pixels rather than as a multiplier.", "kind": "function", "name": "setDisplaySize", "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.ComputedSize", "longname": "Phaser.GameObjects.Components.ComputedSize#setDisplaySize", "scope": "instance", "___id": "T000002R008659", "___s": true }, { "comment": "/**\r\n * The Crop component provides the ability to crop the texture frame of a Game Object during rendering.\r\n *\r\n * It is applied as a mixin to Game Objects such as Sprite and Image, adding the `setCrop` method and\r\n * related properties. Cropping limits the visible rectangular region of a texture frame without altering\r\n * the Game Object's size, position, physics body, or hit area — only the rendered output is affected.\r\n * The crop region is always relative to the texture frame's top-left origin and is automatically scaled\r\n * to account for the Game Object's scale.\r\n *\r\n * @namespace Phaser.GameObjects.Components.Crop\r\n * @since 3.12.0\r\n */", "meta": { "filename": "Crop.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Crop component provides the ability to crop the texture frame of a Game Object during rendering.\r\rIt is applied as a mixin to Game Objects such as Sprite and Image, adding the `setCrop` method and\rrelated properties. Cropping limits the visible rectangular region of a texture frame without altering\rthe Game Object's size, position, physics body, or hit area — only the rendered output is affected.\rThe crop region is always relative to the texture frame's top-left origin and is automatically scaled\rto account for the Game Object's scale.", "kind": "namespace", "name": "Crop", "since": "3.12.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Crop", "scope": "static", "___id": "T000002R008664", "___s": true }, { "comment": "/**\r\n * The Texture this Game Object is using to render with.\r\n *\r\n * @name Phaser.GameObjects.Components.Crop#texture\r\n * @type {Phaser.Textures.Texture|Phaser.Textures.CanvasTexture}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Crop.js", "lineno": 22, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Texture this Game Object is using to render with.", "name": "texture", "type": { "names": [ "Phaser.Textures.Texture", "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Textures.Texture" }, { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Crop", "longname": "Phaser.GameObjects.Components.Crop#texture", "scope": "instance", "kind": "member", "___id": "T000002R008666", "___s": true }, { "comment": "/**\r\n * The Texture Frame this Game Object is using to render with.\r\n *\r\n * @name Phaser.GameObjects.Components.Crop#frame\r\n * @type {Phaser.Textures.Frame}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Crop.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Texture Frame this Game Object is using to render with.", "name": "frame", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Crop", "longname": "Phaser.GameObjects.Components.Crop#frame", "scope": "instance", "kind": "member", "___id": "T000002R008668", "___s": true }, { "comment": "/**\r\n * A boolean flag indicating if this Game Object is being cropped or not.\r\n * You can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\r\n * Equally, calling `setCrop` with no arguments will reset the crop and disable it.\r\n *\r\n * @name Phaser.GameObjects.Components.Crop#isCropped\r\n * @type {boolean}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Crop.js", "lineno": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "A boolean flag indicating if this Game Object is being cropped or not.\rYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\rEqually, calling `setCrop` with no arguments will reset the crop and disable it.", "name": "isCropped", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.Components.Crop", "longname": "Phaser.GameObjects.Components.Crop#isCropped", "scope": "instance", "kind": "member", "___id": "T000002R008670", "___s": true }, { "comment": "/**\r\n * Applies a crop to a texture based Game Object, such as a Sprite or Image.\r\n *\r\n * The crop is a rectangle that limits the area of the texture frame that is visible during rendering.\r\n *\r\n * Cropping a Game Object does not change its size, dimensions, physics body or hit area, it just\r\n * changes what is shown when rendered.\r\n *\r\n * The crop size as well as coordinates cannot exceed the size of the texture frame.\r\n *\r\n * The crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\r\n *\r\n * Therefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\r\n * half of it, you could call `setCrop(0, 0, 400, 600)`.\r\n *\r\n * It is also scaled to match the Game Object scale automatically. Therefore a crop rectangle of 100x50 would crop\r\n * an area of 200x100 when applied to a Game Object that had a scale factor of 2.\r\n *\r\n * You can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\r\n *\r\n * Call this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\r\n *\r\n * You should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\r\n * the renderer to skip several internal calculations.\r\n *\r\n * @method Phaser.GameObjects.Components.Crop#setCrop\r\n * @since 3.11.0\r\n *\r\n * @param {(number|Phaser.Geom.Rectangle)} [x] - The x coordinate to start the crop from. Cannot be negative or exceed the Frame width. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.\r\n * @param {number} [y] - The y coordinate to start the crop from. Cannot be negative or exceed the Frame height.\r\n * @param {number} [width] - The width of the crop rectangle in pixels. Cannot exceed the Frame width.\r\n * @param {number} [height] - The height of the crop rectangle in pixels. Cannot exceed the Frame height.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Crop.js", "lineno": 51, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Applies a crop to a texture based Game Object, such as a Sprite or Image.\r\rThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\r\rCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\rchanges what is shown when rendered.\r\rThe crop size as well as coordinates cannot exceed the size of the texture frame.\r\rThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\r\rTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\rhalf of it, you could call `setCrop(0, 0, 400, 600)`.\r\rIt is also scaled to match the Game Object scale automatically. Therefore a crop rectangle of 100x50 would crop\ran area of 200x100 when applied to a Game Object that had a scale factor of 2.\r\rYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\r\rCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\r\rYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\rthe renderer to skip several internal calculations.", "kind": "function", "name": "setCrop", "since": "3.11.0", "params": [ { "type": { "names": [ "number", "Phaser.Geom.Rectangle" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } ] } }, "optional": true, "description": "The x coordinate to start the crop from. Cannot be negative or exceed the Frame width. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y coordinate to start the crop from. Cannot be negative or exceed the Frame height.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels. Cannot exceed the Frame width.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels. Cannot exceed the Frame height.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Crop", "longname": "Phaser.GameObjects.Components.Crop#setCrop", "scope": "instance", "___id": "T000002R008672", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the depth of a Game Object.\r\n * Should be applied as a mixin and not used directly.\r\n *\r\n * @namespace Phaser.GameObjects.Components.Depth\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Depth.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for setting the depth of a Game Object.\rShould 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", "___id": "T000002R008694", "___s": true }, { "comment": "/**\r\n * The depth of this Game Object within the Scene. Ensure this value is only ever set to a number data-type.\r\n *\r\n * The depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\r\n * of Game Objects, without actually moving their position in the display list.\r\n *\r\n * The default depth is zero. A Game Object with a higher depth\r\n * value will always render in front of one with a lower value.\r\n *\r\n * Setting the depth will queue a depth sort event within the Scene.\r\n *\r\n * @name Phaser.GameObjects.Components.Depth#depth\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Depth.js", "lineno": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The depth of this Game Object within the Scene. Ensure this value is only ever set to a number data-type.\r\rThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\rof Game Objects, without actually moving their position in the display list.\r\rThe default depth is zero. A Game Object with a higher depth\rvalue will always render in front of one with a lower value.\r\rSetting the depth will queue a depth sort event within the Scene.", "name": "depth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Depth", "longname": "Phaser.GameObjects.Components.Depth#depth", "scope": "instance", "kind": "member", "___id": "T000002R008699", "___s": true }, { "comment": "/**\r\n * Sets the depth of this Game Object. If the `value` argument is not provided, the depth defaults to `0`.\r\n *\r\n * The depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\r\n * of Game Objects, without actually moving their position in the display list.\r\n *\r\n * A Game Object with a higher depth value will always render in front of one with a lower value.\r\n *\r\n * Setting the depth will queue a depth sort event within the Scene.\r\n *\r\n * @method Phaser.GameObjects.Components.Depth#setDepth\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The depth of this Game Object. Ensure this value is only ever a number data-type.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Depth.js", "lineno": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the depth of this Game Object. If the `value` argument is not provided, the depth defaults to `0`.\r\rThe depth is also known as the 'z-index' in some environments, and allows you to change the rendering order\rof Game Objects, without actually moving their position in the display list.\r\rA Game Object with a higher depth value will always render in front of one with a lower value.\r\rSetting the depth will queue a depth sort event within the Scene.", "kind": "function", "name": "setDepth", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The depth of this Game Object. Ensure this value is only ever a number data-type.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Depth", "longname": "Phaser.GameObjects.Components.Depth#setDepth", "scope": "instance", "___id": "T000002R008704", "___s": true }, { "comment": "/**\r\n * Sets this Game Object to be at the top of the display list, or the top of its parent container.\r\n * \r\n * Being at the top means it will render on top of everything else.\r\n * \r\n * This method does not change this Game Objects `depth` value, it simply alters its list position.\r\n *\r\n * @method Phaser.GameObjects.Components.Depth#setToTop\r\n * @since 3.85.0\r\n * \r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Depth.js", "lineno": 90, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets this Game Object to be at the top of the display list, or the top of its parent container.\r\rBeing at the top means it will render on top of everything else.\r\rThis method does not change this Game Objects `depth` value, it simply alters its list position.", "kind": "function", "name": "setToTop", "since": "3.85.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Depth", "longname": "Phaser.GameObjects.Components.Depth#setToTop", "scope": "instance", "___id": "T000002R008708", "___s": true }, { "comment": "/**\r\n * Sets this Game Object to the back of the display list, or the back of its parent container.\r\n * \r\n * Being at the back means it will render below everything else.\r\n * \r\n * This method does not change this Game Objects `depth` value, it simply alters its list position.\r\n *\r\n * @method Phaser.GameObjects.Components.Depth#setToBack\r\n * @since 3.85.0\r\n * \r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Depth.js", "lineno": 114, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets this Game Object to the back of the display list, or the back of its parent container.\r\rBeing at the back means it will render below everything else.\r\rThis method does not change this Game Objects `depth` value, it simply alters its list position.", "kind": "function", "name": "setToBack", "since": "3.85.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Depth", "longname": "Phaser.GameObjects.Components.Depth#setToBack", "scope": "instance", "___id": "T000002R008711", "___s": true }, { "comment": "/**\r\n * Move this Game Object so that it appears above the given Game Object.\r\n * \r\n * This means it will render immediately after the other object in the display list.\r\n * \r\n * Both objects must belong to the same display list, or parent container.\r\n * \r\n * This method does not change this Game Objects `depth` value, it simply alters its list position.\r\n *\r\n * @method Phaser.GameObjects.Components.Depth#setAbove\r\n * @since 3.85.0\r\n * \r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that this Game Object will be moved to be above.\r\n * \r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Depth.js", "lineno": 138, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Move this Game Object so that it appears above the given Game Object.\r\rThis means it will render immediately after the other object in the display list.\r\rBoth objects must belong to the same display list, or parent container.\r\rThis method does not change this Game Objects `depth` value, it simply alters its list position.", "kind": "function", "name": "setAbove", "since": "3.85.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that this Game Object will be moved to be above.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Depth", "longname": "Phaser.GameObjects.Components.Depth#setAbove", "scope": "instance", "___id": "T000002R008714", "___s": true }, { "comment": "/**\r\n * Move this Game Object so that it appears below the given Game Object.\r\n * \r\n * This means it will render immediately under the other object in the display list.\r\n * \r\n * Both objects must belong to the same display list, or parent container.\r\n * \r\n * This method does not change this Game Objects `depth` value, it simply alters its list position.\r\n *\r\n * @method Phaser.GameObjects.Components.Depth#setBelow\r\n * @since 3.85.0\r\n * \r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that this Game Object will be moved to be below.\r\n * \r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Depth.js", "lineno": 166, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Move this Game Object so that it appears below the given Game Object.\r\rThis means it will render immediately under the other object in the display list.\r\rBoth objects must belong to the same display list, or parent container.\r\rThis method does not change this Game Objects `depth` value, it simply alters its list position.", "kind": "function", "name": "setBelow", "since": "3.85.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that this Game Object will be moved to be below.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Depth", "longname": "Phaser.GameObjects.Components.Depth#setBelow", "scope": "instance", "___id": "T000002R008717", "___s": true }, { "comment": "/**\r\n * Provides methods for managing an elapse timer on a Game Object.\r\n * The timer is used to drive animations and other time-based effects.\r\n *\r\n * This is not necessary for normal animations.\r\n * It is intended to drive shader effects that require a time value.\r\n *\r\n * If you are adding this component to a Game Object,\r\n * ensure that you register a preUpdate method on the Game Object, e.g.:\r\n *\r\n * ```javascript\r\n * // Overrides Game Object method\r\n * addedToScene: function ()\r\n * {\r\n * this.scene.sys.updateList.add(this);\r\n * },\r\n *\r\n * // Overrides Game Object method\r\n * removedFromScene: function ()\r\n * {\r\n * this.scene.sys.updateList.remove(this);\r\n * },\r\n *\r\n * preUpdate: function (time, delta)\r\n * {\r\n * this.updateTimer(time, delta);\r\n * }\r\n * ```\r\n *\r\n * @namespace Phaser.GameObjects.Components.ElapseTimer\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ElapseTimer.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods for managing an elapse timer on a Game Object.\rThe timer is used to drive animations and other time-based effects.\r\rThis is not necessary for normal animations.\rIt is intended to drive shader effects that require a time value.\r\rIf you are adding this component to a Game Object,\rensure that you register a preUpdate method on the Game Object, e.g.:\r\r```javascript\r// Overrides Game Object method\raddedToScene: function ()\r{\r this.scene.sys.updateList.add(this);\r},\r\r// Overrides Game Object method\rremovedFromScene: function ()\r{\r this.scene.sys.updateList.remove(this);\r},\r\rpreUpdate: function (time, delta)\r{\r this.updateTimer(time, delta);\r}\r```", "kind": "namespace", "name": "ElapseTimer", "since": "4.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.ElapseTimer", "scope": "static", "___id": "T000002R008721", "___s": true }, { "comment": "/**\r\n * The time elapsed since timer initialization, in milliseconds.\r\n *\r\n * @name Phaser.GameObjects.Components.ElapseTimer#timeElapsed\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ElapseTimer.js", "lineno": 41, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The time elapsed since timer initialization, in milliseconds.", "name": "timeElapsed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Components.ElapseTimer", "longname": "Phaser.GameObjects.Components.ElapseTimer#timeElapsed", "scope": "instance", "kind": "member", "___id": "T000002R008723", "___s": true }, { "comment": "/**\r\n * The time after which `timeElapsed` will reset, in milliseconds.\r\n * By default, this is 1 hour.\r\n * If you use the timer for animations, you can set this to a period\r\n * that matches the animation durations.\r\n *\r\n * This is necessary for the timer to avoid floating-point precision issues\r\n * in shaders.\r\n * A float32 can represent a few hours of milliseconds accurately,\r\n * but the precision decreases as the value increases.\r\n *\r\n * @name Phaser.GameObjects.Components.ElapseTimer#timeElapsedResetPeriod\r\n * @type {number}\r\n * @since 4.0.0\r\n * @default 3600000\r\n */", "meta": { "filename": "ElapseTimer.js", "lineno": 50, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The time after which `timeElapsed` will reset, in milliseconds.\rBy default, this is 1 hour.\rIf you use the timer for animations, you can set this to a period\rthat matches the animation durations.\r\rThis is necessary for the timer to avoid floating-point precision issues\rin shaders.\rA float32 can represent a few hours of milliseconds accurately,\rbut the precision decreases as the value increases.", "name": "timeElapsedResetPeriod", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "defaultvalue": "3600000", "memberof": "Phaser.GameObjects.Components.ElapseTimer", "longname": "Phaser.GameObjects.Components.ElapseTimer#timeElapsedResetPeriod", "scope": "instance", "kind": "member", "___id": "T000002R008725", "___s": true }, { "comment": "/**\r\n * Whether the elapse timer is paused.\r\n *\r\n * @name Phaser.GameObjects.Components.ElapseTimer#timePaused\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default false\r\n */", "meta": { "filename": "ElapseTimer.js", "lineno": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Whether the elapse timer is paused.", "name": "timePaused", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "false", "memberof": "Phaser.GameObjects.Components.ElapseTimer", "longname": "Phaser.GameObjects.Components.ElapseTimer#timePaused", "scope": "instance", "kind": "member", "___id": "T000002R008727", "___s": true }, { "comment": "/**\r\n * Set the reset period for the elapse timer for this game object.\r\n *\r\n * @method Phaser.GameObjects.Components.ElapseTimer#setTimerResetPeriod\r\n * @since 4.0.0\r\n * @param {number} period - The time after which `timeElapsed` will reset, in milliseconds.\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "ElapseTimer.js", "lineno": 78, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Set the reset period for the elapse timer for this game object.", "kind": "function", "name": "setTimerResetPeriod", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time after which `timeElapsed` will reset, in milliseconds.", "name": "period" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.Components.ElapseTimer", "longname": "Phaser.GameObjects.Components.ElapseTimer#setTimerResetPeriod", "scope": "instance", "___id": "T000002R008729", "___s": true }, { "comment": "/**\r\n * Pauses or resumes the elapse timer for this game object.\r\n *\r\n * @method Phaser.GameObjects.Components.ElapseTimer#setTimerPaused\r\n * @since 4.0.0\r\n * @param {boolean} [paused] - Pause state (`true` to pause, `false` to unpause). If not specified, the timer will unpause.\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "ElapseTimer.js", "lineno": 93, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Pauses or resumes the elapse timer for this game object.", "kind": "function", "name": "setTimerPaused", "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Pause state (`true` to pause, `false` to unpause). If not specified, the timer will unpause.", "name": "paused" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.Components.ElapseTimer", "longname": "Phaser.GameObjects.Components.ElapseTimer#setTimerPaused", "scope": "instance", "___id": "T000002R008732", "___s": true }, { "comment": "/**\r\n * Reset the elapse timer for this game object.\r\n *\r\n * @method Phaser.GameObjects.Components.ElapseTimer#resetTimer\r\n * @since 4.0.0\r\n * @param {number} [ms=0] - The time to reset the timer to, in milliseconds.\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "ElapseTimer.js", "lineno": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Reset the elapse timer for this game object.", "kind": "function", "name": "resetTimer", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The time to reset the timer to, in milliseconds.", "name": "ms" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.Components.ElapseTimer", "longname": "Phaser.GameObjects.Components.ElapseTimer#resetTimer", "scope": "instance", "___id": "T000002R008735", "___s": true }, { "comment": "/**\r\n * Update the elapse timer for this game object.\r\n * This should be called automatically by the preUpdate method.\r\n *\r\n * Override this method to create more advanced time management,\r\n * or set it to a NOOP function to disable the timer update.\r\n * If you want to control animations with a tween or input system,\r\n * disabling the timer update could be useful.\r\n *\r\n * @method Phaser.GameObjects.Components.ElapseTimer#updateTimer\r\n * @since 4.0.0\r\n * @param {number} time - The current time in milliseconds.\r\n * @param {number} delta - The time since the last update, in milliseconds.\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "ElapseTimer.js", "lineno": 124, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Update the elapse timer for this game object.\rThis should be called automatically by the preUpdate method.\r\rOverride this method to create more advanced time management,\ror set it to a NOOP function to disable the timer update.\rIf you want to control animations with a tween or input system,\rdisabling the timer update could be useful.", "kind": "function", "name": "updateTimer", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current time in milliseconds.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time since the last update, in milliseconds.", "name": "delta" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.Components.ElapseTimer", "longname": "Phaser.GameObjects.Components.ElapseTimer#updateTimer", "scope": "instance", "___id": "T000002R008739", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A list of filters being applied to a {@link Phaser.Cameras.Scene2D.Camera}.\r\n *\r\n * Filters can apply special effects and masks.\r\n * They are only available in WebGL.\r\n * Use `gameObject.enableFilters()` to apply them to Game Objects.\r\n *\r\n * Filters include the following:\r\n *\r\n * * Barrel Distortion\r\n * * Blend\r\n * * Blocky\r\n * * Blur\r\n * * Bokeh / Tilt Shift\r\n * * Color Matrix\r\n * * Displacement\r\n * * Glow\r\n * * Key\r\n * * Mask\r\n * * Parallel Filters\r\n * * Pixelate\r\n * * Sampler\r\n * * Shadow\r\n * * Threshold\r\n *\r\n * This list is either 'internal' or 'external'.\r\n * Internal filters apply to things within the camera.\r\n * External filters apply to the camera itself, in its rendering context.\r\n * A complete list of rendering steps for a Camera goes:\r\n *\r\n * 1. Objects render to a texture the size of the camera.\r\n * 2. Internal filters draw that texture to new textures, applying effects.\r\n * These are usually the same size, but may expand to accommodate blur.\r\n * 3. The texture is drawn to a texture the size of the context where the camera\r\n * will be drawn, accounting for transformation of the camera itself.\r\n * 4. External filters draw that texture to new textures,\r\n * again applying effects and expanding where necessary.\r\n * 5. The final texture draws the filtered camera contents to the context.\r\n *\r\n * For example, consider a game object which is rotated 45 degrees.\r\n * Apply a horizontal blur filter.\r\n * If the filter is internal, the blur will appear at 45 degrees,\r\n * because it is applied before the object is rotated.\r\n * If the filter is external, the blur will appear horizontal,\r\n * because it is applied after the object is rotated.\r\n *\r\n * You should use internal filters wherever possible,\r\n * because they apply only to the region of the camera/game object.\r\n * External filters are full-screen and can be more expensive.\r\n *\r\n * Filters can be stacked. The order of the list is the order of application.\r\n *\r\n * As you can appreciate, some effects are more expensive than others. For example, a bloom effect is going to be more\r\n * expensive than a simple color matrix effect, so please consider using them wisely and performance test your target\r\n * platforms early on in production.\r\n *\r\n * This FilterList is created internally and does not need to be instantiated directly.\r\n *\r\n * In Phaser 3, Filters were known as FX.\r\n *\r\n * @class FilterList\r\n * @memberof Phaser.GameObjects.Components\r\n * @constructor\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that owns this list.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 31, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "classdesc": "A list of filters being applied to a {@link Phaser.Cameras.Scene2D.Camera}.\r\rFilters can apply special effects and masks.\rThey are only available in WebGL.\rUse `gameObject.enableFilters()` to apply them to Game Objects.\r\rFilters include the following:\r\r* Barrel Distortion\r* Blend\r* Blocky\r* Blur\r* Bokeh / Tilt Shift\r* Color Matrix\r* Displacement\r* Glow\r* Key\r* Mask\r* Parallel Filters\r* Pixelate\r* Sampler\r* Shadow\r* Threshold\r\rThis list is either 'internal' or 'external'.\rInternal filters apply to things within the camera.\rExternal filters apply to the camera itself, in its rendering context.\rA complete list of rendering steps for a Camera goes:\r\r1. Objects render to a texture the size of the camera.\r2. Internal filters draw that texture to new textures, applying effects.\r These are usually the same size, but may expand to accommodate blur.\r3. The texture is drawn to a texture the size of the context where the camera\r will be drawn, accounting for transformation of the camera itself.\r4. External filters draw that texture to new textures,\r again applying effects and expanding where necessary.\r5. The final texture draws the filtered camera contents to the context.\r\rFor example, consider a game object which is rotated 45 degrees.\rApply a horizontal blur filter.\rIf the filter is internal, the blur will appear at 45 degrees,\rbecause it is applied before the object is rotated.\rIf the filter is external, the blur will appear horizontal,\rbecause it is applied after the object is rotated.\r\rYou should use internal filters wherever possible,\rbecause they apply only to the region of the camera/game object.\rExternal filters are full-screen and can be more expensive.\r\rFilters can be stacked. The order of the list is the order of application.\r\rAs you can appreciate, some effects are more expensive than others. For example, a bloom effect is going to be more\rexpensive than a simple color matrix effect, so please consider using them wisely and performance test your target\rplatforms early on in production.\r\rThis FilterList is created internally and does not need to be instantiated directly.\r\rIn Phaser 3, Filters were known as FX.", "kind": "class", "name": "FilterList", "memberof": "Phaser.GameObjects.Components", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera that owns this list.", "name": "camera" } ], "scope": "static", "longname": "Phaser.GameObjects.Components.FilterList", "___id": "T000002R008767", "___s": true }, { "comment": "/**\r\n * The Camera that owns this list.\r\n *\r\n * @name Phaser.GameObjects.Components.FilterList#camera\r\n * @type {Phaser.Cameras.Scene2D.Camera}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "FilterList.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Camera that owns this list.", "name": "camera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#camera", "scope": "instance", "kind": "member", "___id": "T000002R008770", "___s": true }, { "comment": "/**\r\n * The list of filters.\r\n *\r\n * This list can be manipulated directly.\r\n * If you want to add or remove filters,\r\n * please use the appropriate methods to ensure they are handled correctly.\r\n * Moving filters around in the list is safe.\r\n *\r\n * @name Phaser.GameObjects.Components.FilterList#list\r\n * @type {Phaser.Filters.Controller[]}\r\n * @default []\r\n * @since 4.0.0\r\n */", "meta": { "filename": "FilterList.js", "lineno": 111, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The list of filters.\r\rThis list can be manipulated directly.\rIf you want to add or remove filters,\rplease use the appropriate methods to ensure they are handled correctly.\rMoving filters around in the list is safe.", "name": "list", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Filters.Controller", "type": "NameExpression" } ] } }, "defaultvalue": "[]", "since": "4.0.0", "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#list", "scope": "instance", "kind": "member", "___id": "T000002R008772", "___s": true }, { "comment": "/**\r\n * Destroys and removes all filters in this list.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#clear\r\n * @since 4.0.0\r\n * @return {this} This FilterList instance.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 127, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Destroys and removes all filters in this list.", "kind": "function", "name": "clear", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FilterList instance." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#clear", "scope": "instance", "___id": "T000002R008774", "___s": true }, { "comment": "/**\r\n * Adds a filter to this list.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#add\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Filters.Controller} filter - The filter to add.\r\n * @param {number} [index] - The index to insert the filter at. If not given, the filter is added to the end of the list. If negative, it is inserted from the end.\r\n *\r\n * @return {Phaser.Filters.Controller} The filter that was added.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a filter to this list.", "kind": "function", "name": "add", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Filters.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Controller" } }, "description": "The filter to add.", "name": "filter" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The index to insert the filter at. If not given, the filter is added to the end of the list. If negative, it is inserted from the end.", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Controller" } }, "description": "The filter that was added." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#add", "scope": "instance", "___id": "T000002R008779", "___s": true }, { "comment": "/**\r\n * Removes a filter from this list, then destroys it.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#remove\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Filters.Controller} filter - The filter to remove.\r\n * @param {boolean} [forceDestroy=false] - If `true`, the filter will be destroyed even if it has the `ignoreDestroy` flag set.\r\n *\r\n * @return {this} This FilterList instance.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 175, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Removes a filter from this list, then destroys it.", "kind": "function", "name": "remove", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Filters.Controller" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Controller" } }, "description": "The filter to remove.", "name": "filter" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true`, the filter will be destroyed even if it has the `ignoreDestroy` flag set.", "name": "forceDestroy" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This FilterList instance." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#remove", "scope": "instance", "___id": "T000002R008781", "___s": true }, { "comment": "/**\r\n * Returns all active filters in this list.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#getActive\r\n * @since 4.0.0\r\n * @return {Phaser.Filters.Controller[]} The active filters in this list.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 202, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Returns all active filters in this list.", "kind": "function", "name": "getActive", "since": "4.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Filters.Controller", "type": "NameExpression" } ] } }, "description": "The active filters in this list." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#getActive", "scope": "instance", "___id": "T000002R008784", "___s": true }, { "comment": "/**\r\n * Adds a Barrel effect.\r\n *\r\n * A barrel effect allows you to apply either a 'pinch' or 'expand' distortion to\r\n * a Game Object. The amount of the effect can be modified in real-time.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addBarrel\r\n * @since 4.0.0\r\n * @param {number} [amount=1] - The amount of distortion applied to the barrel effect. A value of 1 is no distortion. Typically keep this within +- 1.\r\n * @return {Phaser.Filters.Barrel} The new Barrel filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 214, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Barrel effect.\r\rA barrel effect allows you to apply either a 'pinch' or 'expand' distortion to\ra Game Object. The amount of the effect can be modified in real-time.", "kind": "function", "name": "addBarrel", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount of distortion applied to the barrel effect. A value of 1 is no distortion. Typically keep this within +- 1.", "name": "amount" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Barrel" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Barrel" } }, "description": "The new Barrel filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addBarrel", "scope": "instance", "___id": "T000002R008786", "___s": true }, { "comment": "/**\r\n * Adds a Blend effect.\r\n *\r\n * A blend effect allows you to apply another texture to the view\r\n * using a specific blend mode.\r\n * This supports blend modes not otherwise available in WebGL.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addBlend\r\n * @since 4.0.0\r\n * @param {string} [texture='__WHITE'] - The texture to apply to the view.\r\n * @param {Phaser.BlendModes} [blendMode=Phaser.BlendModes.NORMAL] - The blend mode to apply to the view.\r\n * @param {number} [amount=1] - The amount of the blend effect to apply to the view. At 0, the original image is preserved. At 1, the blend texture is fully applied. The expected range is 0 to 1, but you can go outside that range for different effects.\r\n * @param {number[]} [color=[1, 1, 1, 1]] - The color to apply to the blend texture. Each value corresponds to a color channel in RGBA. The expected range is 0 to 1, but you can go outside that range for different effects.\r\n * @return {Phaser.Filters.Blend} The new Blend filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Blend effect.\r\rA blend effect allows you to apply another texture to the view\rusing a specific blend mode.\rThis supports blend modes not otherwise available in WebGL.", "kind": "function", "name": "addBlend", "since": "4.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'__WHITE'", "description": "The texture to apply to the view.", "name": "texture" }, { "type": { "names": [ "Phaser.BlendModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.BlendModes" } }, "optional": true, "defaultvalue": "Phaser.BlendModes.NORMAL", "description": "The blend mode to apply to the view.", "name": "blendMode" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount of the blend effect to apply to the view. At 0, the original image is preserved. At 1, the blend texture is fully applied. The expected range is 0 to 1, but you can go outside that range for different effects.", "name": "amount" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[1, 1, 1, 1]", "description": "The color to apply to the blend texture. Each value corresponds to a color channel in RGBA. The expected range is 0 to 1, but you can go outside that range for different effects.", "name": "color" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Blend" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Blend" } }, "description": "The new Blend filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addBlend", "scope": "instance", "___id": "T000002R008788", "___s": true }, { "comment": "/**\r\n * Adds a Blocky effect.\r\n *\r\n * This filter controller manages a blocky effect.\r\n *\r\n * The blocky effect works by taking the central pixel of a block of pixels\r\n * and using it to fill the entire block, creating a pixelated effect.\r\n *\r\n * It reduces the resolution of an image,\r\n * creating a pixelated or blocky appearance.\r\n * This is often used for stylistic purposes, such as pixel art.\r\n * One technique is to render the game at a higher resolution,\r\n * scaled up by a factor of N,\r\n * and then apply the blocky effect at size N.\r\n * This creates large, visible pixels, suitable for further stylization.\r\n * The effect can also be used to obscure certain elements within the game,\r\n * such as during a transition or to censor specific content.\r\n *\r\n * Blocky works best on games with no anti-aliasing,\r\n * so it can read unfiltered pixel colors from the original image.\r\n * It preserves the colors of the original art, instead of blending them\r\n * like the Pixelate filter.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addBlocky\r\n * @since 4.0.0\r\n * @param {Phaser.Types.Filters.BlockyConfig} [config] - The configuration object for the Blocky effect.\r\n * @return {Phaser.Filters.Blocky} The new Blocky filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 256, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Blocky effect.\r\rThis filter controller manages a blocky effect.\r\rThe blocky effect works by taking the central pixel of a block of pixels\rand using it to fill the entire block, creating a pixelated effect.\r\rIt reduces the resolution of an image,\rcreating a pixelated or blocky appearance.\rThis is often used for stylistic purposes, such as pixel art.\rOne technique is to render the game at a higher resolution,\rscaled up by a factor of N,\rand then apply the blocky effect at size N.\rThis creates large, visible pixels, suitable for further stylization.\rThe effect can also be used to obscure certain elements within the game,\rsuch as during a transition or to censor specific content.\r\rBlocky works best on games with no anti-aliasing,\rso it can read unfiltered pixel colors from the original image.\rIt preserves the colors of the original art, instead of blending them\rlike the Pixelate filter.", "kind": "function", "name": "addBlocky", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Filters.BlockyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Filters.BlockyConfig" } }, "optional": true, "description": "The configuration object for the Blocky effect.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Blocky" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Blocky" } }, "description": "The new Blocky filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addBlocky", "scope": "instance", "___id": "T000002R008790", "___s": true }, { "comment": "/**\r\n * Adds a Blur effect.\r\n *\r\n * A Gaussian blur is the result of blurring an image by a Gaussian function. It is a widely used effect,\r\n * typically to reduce image noise and reduce detail. The visual effect of this blurring technique is a\r\n * smooth blur resembling that of viewing the image through a translucent screen, distinctly different\r\n * from the bokeh effect produced by an out-of-focus lens or the shadow of an object under usual illumination.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addBlur\r\n * @since 4.0.0\r\n *\r\n * @param {number} [quality=0] - The quality of the blur effect. Can be either 0 for Low Quality, 1 for Medium Quality or 2 for High Quality.\r\n * @param {number} [x=2] - The horizontal offset of the blur effect.\r\n * @param {number} [y=2] - The vertical offset of the blur effect.\r\n * @param {number} [strength=1] - The strength of the blur effect.\r\n * @param {number} [color=0xffffff] - The color of the blur, as a hex value.\r\n * @param {number} [steps=4] - The number of steps to run the blur effect for. This value should always be an integer.\r\n *\r\n * @return {Phaser.Filters.Blur} The new Blur filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Blur effect.\r\rA Gaussian blur is the result of blurring an image by a Gaussian function. It is a widely used effect,\rtypically to reduce image noise and reduce detail. The visual effect of this blurring technique is a\rsmooth blur resembling that of viewing the image through a translucent screen, distinctly different\rfrom the bokeh effect produced by an out-of-focus lens or the shadow of an object under usual illumination.", "kind": "function", "name": "addBlur", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The quality of the blur effect. Can be either 0 for Low Quality, 1 for Medium Quality or 2 for High Quality.", "name": "quality" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "The horizontal offset of the blur effect.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "The vertical offset of the blur effect.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The strength of the blur effect.", "name": "strength" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color of the blur, as a hex value.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "The number of steps to run the blur effect for. This value should always be an integer.", "name": "steps" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Blur" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Blur" } }, "description": "The new Blur filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addBlur", "scope": "instance", "___id": "T000002R008792", "___s": true }, { "comment": "/**\r\n * Adds a Bokeh effect.\r\n *\r\n * Bokeh refers to a visual effect that mimics the photographic technique of creating a shallow depth of field.\r\n * This effect is used to emphasize the game's main subject or action, by blurring the background or foreground\r\n * elements, resulting in a more immersive and visually appealing experience. It is achieved through rendering\r\n * techniques that simulate the out-of-focus areas, giving a sense of depth and realism to the game's graphics.\r\n *\r\n * See also Tilt Shift.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addBokeh\r\n * @since 4.0.0\r\n *\r\n * @param {number} [radius=0.5] - The radius of the bokeh effect.\r\n * @param {number} [amount=1] - The amount of the bokeh effect.\r\n * @param {number} [contrast=0.2] - The color contrast of the bokeh effect.\r\n *\r\n * @return {Phaser.Filters.Bokeh} The new Bokeh filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 322, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Bokeh effect.\r\rBokeh refers to a visual effect that mimics the photographic technique of creating a shallow depth of field.\rThis effect is used to emphasize the game's main subject or action, by blurring the background or foreground\relements, resulting in a more immersive and visually appealing experience. It is achieved through rendering\rtechniques that simulate the out-of-focus areas, giving a sense of depth and realism to the game's graphics.\r\rSee also Tilt Shift.", "kind": "function", "name": "addBokeh", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The radius of the bokeh effect.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount of the bokeh effect.", "name": "amount" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.2, "description": "The color contrast of the bokeh effect.", "name": "contrast" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Bokeh" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Bokeh" } }, "description": "The new Bokeh filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addBokeh", "scope": "instance", "___id": "T000002R008794", "___s": true }, { "comment": "/**\r\n * Adds a Color Matrix effect.\r\n *\r\n * The color matrix effect is a visual technique that involves manipulating the colors of an image\r\n * or scene using a mathematical matrix. This process can adjust hue, saturation, brightness, and contrast,\r\n * allowing developers to create various stylistic appearances or mood settings within the game.\r\n * Common applications include simulating different lighting conditions, applying color filters,\r\n * or achieving a specific visual style.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addColorMatrix\r\n * @since 4.0.0\r\n * @return {Phaser.Filters.ColorMatrix} The new ColorMatrix filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 351, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Color Matrix effect.\r\rThe color matrix effect is a visual technique that involves manipulating the colors of an image\ror scene using a mathematical matrix. This process can adjust hue, saturation, brightness, and contrast,\rallowing developers to create various stylistic appearances or mood settings within the game.\rCommon applications include simulating different lighting conditions, applying color filters,\ror achieving a specific visual style.", "kind": "function", "name": "addColorMatrix", "since": "4.0.0", "returns": [ { "type": { "names": [ "Phaser.Filters.ColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.ColorMatrix" } }, "description": "The new ColorMatrix filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addColorMatrix", "scope": "instance", "___id": "T000002R008796", "___s": true }, { "comment": "/**\r\n * Adds a Combine Color Matrix effect.\r\n *\r\n * This filter combines channels from two textures.\r\n * There are many possibilities with this.\r\n * However, a significant purpose is to manipulate alpha channels.\r\n * Use `setupAlphaTransfer` to configure common options,\r\n * or set the `colorMatrixSelf` and `colorMatrixTransfer` properties\r\n * directly.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addCombineColorMatrix\r\n * @since 4.0.0\r\n * @param {string | Phaser.Textures.Texture} [texture='__WHITE'] - The texture or texture key to use for the transfer texture.\r\n * @return {Phaser.Filters.CombineColorMatrix} The new CombineColorMatrix filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 369, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Combine Color Matrix effect.\r\rThis filter combines channels from two textures.\rThere are many possibilities with this.\rHowever, a significant purpose is to manipulate alpha channels.\rUse `setupAlphaTransfer` to configure common options,\ror set the `colorMatrixSelf` and `colorMatrixTransfer` properties\rdirectly.", "kind": "function", "name": "addCombineColorMatrix", "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "defaultvalue": "'__WHITE'", "description": "The texture or texture key to use for the transfer texture.", "name": "texture" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.CombineColorMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.CombineColorMatrix" } }, "description": "The new CombineColorMatrix filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addCombineColorMatrix", "scope": "instance", "___id": "T000002R008798", "___s": true }, { "comment": "/**\r\n * Adds a Displacement effect.\r\n *\r\n * The displacement effect is a visual technique that alters the position of pixels in an image\r\n * or texture based on the values of a displacement map. This effect is used to create the illusion\r\n * of depth, surface irregularities, or distortion in otherwise flat elements. It can be applied to\r\n * characters, objects, or backgrounds to enhance realism, convey movement, or achieve various\r\n * stylistic appearances.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addDisplacement\r\n * @since 4.0.0\r\n *\r\n * @param {string} [texture='__WHITE'] - The unique string-based key of the texture to use for displacement, which must exist in the Texture Manager.\r\n * @param {number} [x=0.005] - The amount of horizontal displacement to apply. A very small float number, such as 0.005.\r\n * @param {number} [y=0.005] - The amount of vertical displacement to apply. A very small float number, such as 0.005.\r\n *\r\n * @return {Phaser.Filters.Displacement} The new Displacement filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 389, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Displacement effect.\r\rThe displacement effect is a visual technique that alters the position of pixels in an image\ror texture based on the values of a displacement map. This effect is used to create the illusion\rof depth, surface irregularities, or distortion in otherwise flat elements. It can be applied to\rcharacters, objects, or backgrounds to enhance realism, convey movement, or achieve various\rstylistic appearances.", "kind": "function", "name": "addDisplacement", "since": "4.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'__WHITE'", "description": "The unique string-based key of the texture to use for displacement, which must exist in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.005, "description": "The amount of horizontal displacement to apply. A very small float number, such as 0.005.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.005, "description": "The amount of vertical displacement to apply. A very small float number, such as 0.005.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Displacement" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Displacement" } }, "description": "The new Displacement filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addDisplacement", "scope": "instance", "___id": "T000002R008800", "___s": true }, { "comment": "/**\r\n * Adds a Glow effect.\r\n *\r\n * The glow effect is a visual technique that creates a soft, luminous halo around game objects,\r\n * characters, or UI elements. This effect is used to emphasize importance, enhance visual appeal,\r\n * or convey a sense of energy, magic, or otherworldly presence. The effect can also be set on\r\n * the inside of the edge. The color and strength of the glow can be modified.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addGlow\r\n * @since 4.0.0\r\n *\r\n * @param {number} [color=0xffffff] - The color of the glow effect as a number value.\r\n * @param {number} [outerStrength=4] - The strength of the glow outward from the edge of textures.\r\n * @param {number} [innerStrength=0] - The strength of the glow inward from the edge of textures.\r\n * @param {number} [scale=1] - The scale of the glow effect. This multiplies the fixed distance.\r\n * @param {boolean} [knockout=false] - If `true` only the glow is drawn, not the texture itself.\r\n * @param {number} [quality=10] - The quality of the glow effect. This cannot be changed after the filter has been created.\r\n * @param {number} [distance=10] - The distance of the glow effect. This cannot be changed after the filter has been created.\r\n *\r\n * @return {Phaser.Filters.Glow} The new Glow filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 417, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Glow effect.\r\rThe glow effect is a visual technique that creates a soft, luminous halo around game objects,\rcharacters, or UI elements. This effect is used to emphasize importance, enhance visual appeal,\ror convey a sense of energy, magic, or otherworldly presence. The effect can also be set on\rthe inside of the edge. The color and strength of the glow can be modified.", "kind": "function", "name": "addGlow", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color of the glow effect as a number value.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 4, "description": "The strength of the glow outward from the edge of textures.", "name": "outerStrength" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The strength of the glow inward from the edge of textures.", "name": "innerStrength" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The scale of the glow effect. This multiplies the fixed distance.", "name": "scale" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true` only the glow is drawn, not the texture itself.", "name": "knockout" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The quality of the glow effect. This cannot be changed after the filter has been created.", "name": "quality" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The distance of the glow effect. This cannot be changed after the filter has been created.", "name": "distance" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Glow" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Glow" } }, "description": "The new Glow filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addGlow", "scope": "instance", "___id": "T000002R008802", "___s": true }, { "comment": "/**\r\n * Adds a GradientMap effect.\r\n *\r\n * GradientMap recolors an image using a ColorRamp.\r\n * The image is converted to a progress value at each point,\r\n * and that progress is evaluated as a color along the ramp.\r\n *\r\n * The progress value is normally the brightness of the image.\r\n * You can use the `colorFactor` and `color` properties to customize it.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addGradientMap\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.Filters.GradientMapConfig} [config] - The configuration object for the GradientMap effect.\r\n *\r\n * @return {Phaser.Filters.GradientMap} The new GradientMap filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 452, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a GradientMap effect.\r\rGradientMap recolors an image using a ColorRamp.\rThe image is converted to a progress value at each point,\rand that progress is evaluated as a color along the ramp.\r\rThe progress value is normally the brightness of the image.\rYou can use the `colorFactor` and `color` properties to customize it.", "kind": "function", "name": "addGradientMap", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Filters.GradientMapConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Filters.GradientMapConfig" } }, "optional": true, "description": "The configuration object for the GradientMap effect.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.GradientMap" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.GradientMap" } }, "description": "The new GradientMap filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addGradientMap", "scope": "instance", "___id": "T000002R008804", "___s": true }, { "comment": "/**\r\n * Adds an ImageLight effect.\r\n *\r\n * ImageLight is a filter for image based lighting (IBL).\r\n * It is used to simulate the lighting of an image\r\n * using an environment map and a normal map.\r\n *\r\n * The environment map is an image that describes the lighting of the scene.\r\n * This filter uses a single panorama image as the environment map.\r\n * The top of the image is the sky, the bottom is the ground,\r\n * and the X axis covers a full rotation.\r\n * This kind of image is distorted towards the top and bottom,\r\n * as the X axis is stretched wider and wider,\r\n * so be careful if you're creating your own environment maps.\r\n *\r\n * Cube maps are not supported by Phaser at the time of writing.\r\n *\r\n * The effect is basically a reflection of the environment at infinite range.\r\n * A sharp environment map will produce a sharp reflection,\r\n * while a blurry environment map will produce a diffuse reflection.\r\n * Use the PanoramaBlur filter to create correctly blurred environment maps.\r\n * Use the NormalTools filter to manipulate the normal map if necessary,\r\n * using a DynamicTexture to capture the output.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addImageLight\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.Filters.ImageLightConfig} config - The configuration object for the ImageLight effect.\r\n * @return {Phaser.Filters.ImageLight} The new ImageLight filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 474, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds an ImageLight effect.\r\rImageLight is a filter for image based lighting (IBL).\rIt is used to simulate the lighting of an image\rusing an environment map and a normal map.\r\rThe environment map is an image that describes the lighting of the scene.\rThis filter uses a single panorama image as the environment map.\rThe top of the image is the sky, the bottom is the ground,\rand the X axis covers a full rotation.\rThis kind of image is distorted towards the top and bottom,\ras the X axis is stretched wider and wider,\rso be careful if you're creating your own environment maps.\r\rCube maps are not supported by Phaser at the time of writing.\r\rThe effect is basically a reflection of the environment at infinite range.\rA sharp environment map will produce a sharp reflection,\rwhile a blurry environment map will produce a diffuse reflection.\rUse the PanoramaBlur filter to create correctly blurred environment maps.\rUse the NormalTools filter to manipulate the normal map if necessary,\rusing a DynamicTexture to capture the output.", "kind": "function", "name": "addImageLight", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Filters.ImageLightConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Filters.ImageLightConfig" } }, "description": "The configuration object for the ImageLight effect.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.ImageLight" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.ImageLight" } }, "description": "The new ImageLight filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addImageLight", "scope": "instance", "___id": "T000002R008806", "___s": true }, { "comment": "/**\r\n * Adds a Key effect.\r\n *\r\n * The Key effect removes or isolates a specific color from an image.\r\n * It can be used to remove a background color from an image,\r\n * or to isolate a specific color for further processing.\r\n *\r\n * By default, Key will remove pixels that match the key color.\r\n * You can instead keep only the matching pixels by setting `isolate`.\r\n *\r\n * The threshold and feather settings control how closely the key color matches.\r\n * A match is measured by \"distance between color vectors\";\r\n * that is, how close the RGB values of the pixel are to the RGB values of the key color.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addKey\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.Filters.KeyConfig} [config] - The configuration object for the Key effect.\r\n *\r\n * @return {Phaser.Filters.Key} The new Key filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 509, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Key effect.\r\rThe Key effect removes or isolates a specific color from an image.\rIt can be used to remove a background color from an image,\ror to isolate a specific color for further processing.\r\rBy default, Key will remove pixels that match the key color.\rYou can instead keep only the matching pixels by setting `isolate`.\r\rThe threshold and feather settings control how closely the key color matches.\rA match is measured by \"distance between color vectors\";\rthat is, how close the RGB values of the pixel are to the RGB values of the key color.", "kind": "function", "name": "addKey", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Filters.KeyConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Filters.KeyConfig" } }, "optional": true, "description": "The configuration object for the Key effect.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Key" } }, "description": "The new Key filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addKey", "scope": "instance", "___id": "T000002R008808", "___s": true }, { "comment": "/**\r\n * Adds a Mask effect.\r\n *\r\n * A mask uses a texture to hide parts of an input.\r\n * It multiplies the color and alpha of the input\r\n * by the alpha of the mask in the corresponding texel.\r\n *\r\n * Masks can be inverted, which switches what they hide and what they show.\r\n *\r\n * Masks can use either a texture or a GameObject.\r\n * If a GameObject is used, the mask will render the GameObject\r\n * to a DynamicTexture and use that.\r\n * The mask will automatically update when the GameObject changes,\r\n * unless the `autoUpdate` flag is set to `false`.\r\n *\r\n * When the mask filter is used as an internal filter,\r\n * the mask will match the object/view being filtered.\r\n * This is useful for creating effects that follow the object,\r\n * such as effects intended to match an animated sprite.\r\n *\r\n * When the mask filter is used as an external filter,\r\n * the mask will match the context of the camera.\r\n * This is useful for creating effects that cover the entire view.\r\n *\r\n * An optional `viewCamera` can be specified when creating the mask.\r\n * If not used, mask objects will be viewed through a default camera.\r\n * Set the `viewCamera` to the scene's main camera (`this.cameras.main`)\r\n * to view the mask through the main camera.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addMask\r\n * @since 4.0.0\r\n *\r\n * @param {string|Phaser.GameObjects.GameObject} [mask='__WHITE'] - The source of the mask. This can be a unique string-based key of the texture to use for the mask, which must exist in the Texture Manager. Or it can be a GameObject, in which case the mask will render the GameObject to a DynamicTexture and use that.\r\n * @param {boolean} [invert=false] - Whether to invert the mask.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [viewCamera] - The Camera to use when rendering the mask with a GameObject. If not specified, uses the scene's `main` camera.\r\n * @param {'local'|'world'} [viewTransform='world'] - The transform to use when rendering the mask with a GameObject. 'local' uses the GameObject's own properties. 'world' uses the GameObject's `parentContainer` value to compute a world position.\r\n * @param {number} [scaleFactor=1] - The scale factor to apply to the underlying mask texture. Can be used to balance memory usage and needed mask precision. This just adjusts the size of the texture; you must also adjust mask size to match, e.g. if scaleFactor is 0.5, your mask might be a Container with scale 0.5. It's easy to make things complicated when combining scale factor, object transform, and camera transform, so try to be precise when using this option.\r\n *\r\n * @return {Phaser.Filters.Mask} The new Mask filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 535, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Mask effect.\r\rA mask uses a texture to hide parts of an input.\rIt multiplies the color and alpha of the input\rby the alpha of the mask in the corresponding texel.\r\rMasks can be inverted, which switches what they hide and what they show.\r\rMasks can use either a texture or a GameObject.\rIf a GameObject is used, the mask will render the GameObject\rto a DynamicTexture and use that.\rThe mask will automatically update when the GameObject changes,\runless the `autoUpdate` flag is set to `false`.\r\rWhen the mask filter is used as an internal filter,\rthe mask will match the object/view being filtered.\rThis is useful for creating effects that follow the object,\rsuch as effects intended to match an animated sprite.\r\rWhen the mask filter is used as an external filter,\rthe mask will match the context of the camera.\rThis is useful for creating effects that cover the entire view.\r\rAn optional `viewCamera` can be specified when creating the mask.\rIf not used, mask objects will be viewed through a default camera.\rSet the `viewCamera` to the scene's main camera (`this.cameras.main`)\rto view the mask through the main camera.", "kind": "function", "name": "addMask", "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "optional": true, "defaultvalue": "'__WHITE'", "description": "The source of the mask. This can be a unique string-based key of the texture to use for the mask, which must exist in the Texture Manager. Or it can be a GameObject, in which case the mask will render the GameObject to a DynamicTexture and use that.", "name": "mask" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to invert the mask.", "name": "invert" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera to use when rendering the mask with a GameObject. If not specified, uses the scene's `main` camera.", "name": "viewCamera" }, { "type": { "names": [ "'local'", "'world'" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "'local'" }, { "type": "NameExpression", "name": "'world'" } ] } }, "optional": true, "defaultvalue": "'world'", "description": "The transform to use when rendering the mask with a GameObject. 'local' uses the GameObject's own properties. 'world' uses the GameObject's `parentContainer` value to compute a world position.", "name": "viewTransform" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The scale factor to apply to the underlying mask texture. Can be used to balance memory usage and needed mask precision. This just adjusts the size of the texture; you must also adjust mask size to match, e.g. if scaleFactor is 0.5, your mask might be a Container with scale 0.5. It's easy to make things complicated when combining scale factor, object transform, and camera transform, so try to be precise when using this option.", "name": "scaleFactor" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Mask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Mask" } }, "description": "The new Mask filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addMask", "scope": "instance", "___id": "T000002R008810", "___s": true }, { "comment": "/**\r\n * Adds a NormalTools effect.\r\n *\r\n * NormalTools is a filter for manipulating the normals of a normal map.\r\n * It has several functions:\r\n *\r\n * - Rotate or reorient the normal map.\r\n * - Change how strongly the normals face the camera.\r\n * - Output a grayscale texture showing how strongly the normals face the camera, or some other vector.\r\n *\r\n * The output can be used for various purposes, such as:\r\n *\r\n * - Editing a normal map for special applications.\r\n * - Altering the apparent visual depth of a normal map by manipulating the facing power.\r\n * - Creating a base for other effects, such as a mask for a gradient or other effect.\r\n *\r\n * You can even use the output as a normal map for regular lighting.\r\n * Ordinarily, normal maps are loaded alongside the main texture,\r\n * but you can edit this.\r\n *\r\n * ```js\r\n * // Given a dynamic texture `dyn` where the filter output is drawn,\r\n * // and a texture `spiderTex` with lighting enabled,\r\n * // we can inject the WebGL texture straight into the scene lighting as a normal map.\r\n * const dynTex = dyn.getWebGLTexture();\r\n * const dynSource = new Phaser.Textures.TextureSource(spiderTex, dynTex);\r\n * spiderTex.dataSource[0] = dynSource; // This is where the normal map is located.\r\n * ```\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addNormalTools\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.Filters.NormalToolsConfig} config - The configuration object for the NormalTools effect.\r\n * @return {Phaser.Filters.NormalTools} The new NormalTools filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a NormalTools effect.\r\rNormalTools is a filter for manipulating the normals of a normal map.\rIt has several functions:\r\r- Rotate or reorient the normal map.\r- Change how strongly the normals face the camera.\r- Output a grayscale texture showing how strongly the normals face the camera, or some other vector.\r\rThe output can be used for various purposes, such as:\r\r- Editing a normal map for special applications.\r- Altering the apparent visual depth of a normal map by manipulating the facing power.\r- Creating a base for other effects, such as a mask for a gradient or other effect.\r\rYou can even use the output as a normal map for regular lighting.\rOrdinarily, normal maps are loaded alongside the main texture,\rbut you can edit this.\r\r```js\r// Given a dynamic texture `dyn` where the filter output is drawn,\r// and a texture `spiderTex` with lighting enabled,\r// we can inject the WebGL texture straight into the scene lighting as a normal map.\rconst dynTex = dyn.getWebGLTexture();\rconst dynSource = new Phaser.Textures.TextureSource(spiderTex, dynTex);\rspiderTex.dataSource[0] = dynSource; // This is where the normal map is located.\r```", "kind": "function", "name": "addNormalTools", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Filters.NormalToolsConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Filters.NormalToolsConfig" } }, "description": "The configuration object for the NormalTools effect.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.NormalTools" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.NormalTools" } }, "description": "The new NormalTools filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addNormalTools", "scope": "instance", "___id": "T000002R008812", "___s": true }, { "comment": "/**\r\n * Adds a PanoramaBlur effect.\r\n *\r\n * PanoramaBlur is a filter for blurring a panorama image.\r\n * This is intended for use with filters like ImageLight that use a panorama image as the environment map.\r\n * The blur treats a rectangular map as a sphere,\r\n * and applies heavy distortion close to the poles to get a correct result.\r\n * You should not use it for general purpose blurring.\r\n *\r\n * The effect can be very slow, as it uses a grid of samples.\r\n * Total samples equals samplesX * samplesY. This can get very high,\r\n * very quickly, so be careful when increasing these values.\r\n * They don't need to be too high for good results.\r\n *\r\n * By default, the blur is fully diffuse, sampling an entire hemisphere per point.\r\n * If you reduce the radius, the effect will be more focused.\r\n * Use this to control different levels of glossiness in objects using environment maps.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addPanoramaBlur\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.Filters.PanoramaBlurConfig} config - The configuration object for the PanoramaBlur effect.\r\n *\r\n * @return {Phaser.Filters.PanoramaBlur} The new PanoramaBlur filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 627, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a PanoramaBlur effect.\r\rPanoramaBlur is a filter for blurring a panorama image.\rThis is intended for use with filters like ImageLight that use a panorama image as the environment map.\rThe blur treats a rectangular map as a sphere,\rand applies heavy distortion close to the poles to get a correct result.\rYou should not use it for general purpose blurring.\r\rThe effect can be very slow, as it uses a grid of samples.\rTotal samples equals samplesX * samplesY. This can get very high,\rvery quickly, so be careful when increasing these values.\rThey don't need to be too high for good results.\r\rBy default, the blur is fully diffuse, sampling an entire hemisphere per point.\rIf you reduce the radius, the effect will be more focused.\rUse this to control different levels of glossiness in objects using environment maps.", "kind": "function", "name": "addPanoramaBlur", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Filters.PanoramaBlurConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Filters.PanoramaBlurConfig" } }, "description": "The configuration object for the PanoramaBlur effect.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.PanoramaBlur" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.PanoramaBlur" } }, "description": "The new PanoramaBlur filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addPanoramaBlur", "scope": "instance", "___id": "T000002R008814", "___s": true }, { "comment": "/**\r\n * Adds a Pixelate effect.\r\n *\r\n * The pixelate effect is a visual technique that deliberately reduces the resolution or detail of an image,\r\n * creating a blocky or mosaic appearance composed of large, visible pixels. This effect can be used for stylistic\r\n * purposes, as a homage to retro gaming, or as a means to obscure certain elements within the game, such as\r\n * during a transition or to censor specific content.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addPixelate\r\n * @since 4.0.0\r\n *\r\n * @param {number} [amount] - The amount of pixelation. A higher value creates a more pronounced effect.\r\n *\r\n * @return {Phaser.Filters.Pixelate} The new Pixelate filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 662, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Pixelate effect.\r\rThe pixelate effect is a visual technique that deliberately reduces the resolution or detail of an image,\rcreating a blocky or mosaic appearance composed of large, visible pixels. This effect can be used for stylistic\rpurposes, as a homage to retro gaming, or as a means to obscure certain elements within the game, such as\rduring a transition or to censor specific content.", "kind": "function", "name": "addPixelate", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount of pixelation. A higher value creates a more pronounced effect.", "name": "amount" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Pixelate" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Pixelate" } }, "description": "The new Pixelate filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addPixelate", "scope": "instance", "___id": "T000002R008816", "___s": true }, { "comment": "/**\r\n * Adds a Quantize effect.\r\n *\r\n * Quantization reduces the unique number of colors in an image,\r\n * based on some limited number of steps per color channel.\r\n * This is good for creating a retro or stylized effect.\r\n *\r\n * Basic quantization breaks each channel up into a number of `steps`.\r\n * These steps are normally regular. You can bias them towards the top or bottom\r\n * by changing that channel's `gamma` value.\r\n * You can adjust the lowest step, thus all subsequent steps, with the `offset`.\r\n *\r\n * Quantization is done in either RGBA or HSVA space.\r\n * The steps, gamma, and offset always apply in the same order,\r\n * but depending on color mode, they are either applied to\r\n * `[ red, green, blue, alpha ]` or `[ hue, saturation, value, alpha ]`.\r\n *\r\n * The output may optionally be dithered, to eliminate banding\r\n * and create the illusion that there are many more colors in use.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addQuantize\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.Filters.QuantizeConfig} [config] - The configuration object for the Quantize effect.\r\n *\r\n * @return {this} The new Quantize filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 685, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Quantize effect.\r\rQuantization reduces the unique number of colors in an image,\rbased on some limited number of steps per color channel.\rThis is good for creating a retro or stylized effect.\r\rBasic quantization breaks each channel up into a number of `steps`.\rThese steps are normally regular. You can bias them towards the top or bottom\rby changing that channel's `gamma` value.\rYou can adjust the lowest step, thus all subsequent steps, with the `offset`.\r\rQuantization is done in either RGBA or HSVA space.\rThe steps, gamma, and offset always apply in the same order,\rbut depending on color mode, they are either applied to\r`[ red, green, blue, alpha ]` or `[ hue, saturation, value, alpha ]`.\r\rThe output may optionally be dithered, to eliminate banding\rand create the illusion that there are many more colors in use.", "kind": "function", "name": "addQuantize", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Filters.QuantizeConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Filters.QuantizeConfig" } }, "optional": true, "description": "The configuration object for the Quantize effect.", "name": "config" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The new Quantize filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addQuantize", "scope": "instance", "___id": "T000002R008818", "___s": true }, { "comment": "/**\r\n * Adds a Sampler effect.\r\n *\r\n * This controller manages a sampler.\r\n * It doesn't actually render anything, and leaves the image unaltered.\r\n * It is used to sample a region of the camera view, and pass the results to a callback.\r\n * This is useful for extracting data from the camera view.\r\n *\r\n * This operation is expensive, so use sparingly.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addSampler\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.Renderer.Snapshot.SnapshotCallback} callback - The callback to call with the results of the sampler.\r\n * @param {null|Phaser.Types.Math.Vector2Like|Phaser.Geom.Rectangle} [region=null] - The region to sample. If `null`, the entire camera view is sampled. If a `Phaser.Types.Math.Vector2Like`, a point is sampled. If a `Phaser.Geom.Rectangle`, the region is sampled.\r\n *\r\n * @return {Phaser.Filters.Sampler} The new Sampler filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 717, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Sampler effect.\r\rThis controller manages a sampler.\rIt doesn't actually render anything, and leaves the image unaltered.\rIt is used to sample a region of the camera view, and pass the results to a callback.\rThis is useful for extracting data from the camera view.\r\rThis operation is expensive, so use sparingly.", "kind": "function", "name": "addSampler", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.Snapshot.SnapshotCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.Snapshot.SnapshotCallback" } }, "description": "The callback to call with the results of the sampler.", "name": "callback" }, { "type": { "names": [ "null", "Phaser.Types.Math.Vector2Like", "Phaser.Geom.Rectangle" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NullLiteral" }, { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" }, { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } ] } }, "optional": true, "defaultvalue": null, "description": "The region to sample. If `null`, the entire camera view is sampled. If a `Phaser.Types.Math.Vector2Like`, a point is sampled. If a `Phaser.Geom.Rectangle`, the region is sampled.", "name": "region" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Sampler" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Sampler" } }, "description": "The new Sampler filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addSampler", "scope": "instance", "___id": "T000002R008820", "___s": true }, { "comment": "/**\r\n * Adds a Shadow effect.\r\n *\r\n * The shadow effect is a visual technique used to create the illusion of depth and realism by adding darker,\r\n * offset silhouettes or shapes beneath game objects, characters, or environments. These simulated shadows\r\n * help to enhance the visual appeal and immersion, making the 2D game world appear more dynamic and three-dimensional.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addShadow\r\n * @since 4.0.0\r\n *\r\n * @param {number} [x=0] - The horizontal offset of the shadow effect.\r\n * @param {number} [y=0] - The vertical offset of the shadow effect.\r\n * @param {number} [decay=0.1] - The amount of decay for the shadow effect.\r\n * @param {number} [power=1] - The power of the shadow effect.\r\n * @param {number} [color=0x000000] - The color of the shadow, as a hex value.\r\n * @param {number} [samples=6] - The number of samples that the shadow effect will run for.\r\n * @param {number} [intensity=1] - The intensity of the shadow effect.\r\n *\r\n * @return {Phaser.Filters.Shadow} The new Shadow filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 744, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Shadow effect.\r\rThe shadow effect is a visual technique used to create the illusion of depth and realism by adding darker,\roffset silhouettes or shapes beneath game objects, characters, or environments. These simulated shadows\rhelp to enhance the visual appeal and immersion, making the 2D game world appear more dynamic and three-dimensional.", "kind": "function", "name": "addShadow", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal offset of the shadow effect.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical offset of the shadow effect.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "The amount of decay for the shadow effect.", "name": "decay" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The power of the shadow effect.", "name": "power" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x000000", "description": "The color of the shadow, as a hex value.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 6, "description": "The number of samples that the shadow effect will run for.", "name": "samples" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The intensity of the shadow effect.", "name": "intensity" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Shadow" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Shadow" } }, "description": "The new Shadow filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addShadow", "scope": "instance", "___id": "T000002R008822", "___s": true }, { "comment": "/**\r\n * Adds a Threshold effect.\r\n *\r\n * Input values are compared to a threshold value or range.\r\n * Values below the threshold are set to 0, and values above the threshold are set to 1.\r\n * Values within the range are linearly interpolated between 0 and 1.\r\n *\r\n * This is useful for creating effects such as sharp edges from gradients,\r\n * or for creating binary effects.\r\n *\r\n * The threshold is stored as a range, with two edges.\r\n * Each edge has a value for each channel, between 0 and 1.\r\n * If the two edges are the same, the threshold has no interpolation,\r\n * and will output either 0 or 1.\r\n * Each channel can also be inverted.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addThreshold\r\n * @since 4.0.0\r\n *\r\n * @param {number|number[]} [edge1=0.5] - The first edge of the threshold. This may be an array of the RGBA channels, or a single number for all 4 channels.\r\n * @param {number|number[]} [edge2=0.5] - The second edge of the threshold. This may be an array of the RGBA channels, or a single number for all 4 channels.\r\n * @param {boolean|boolean[]} [invert=false] - Whether each channel is inverted. This may be an array of the RGBA channels, or a single boolean for all 4 channels.\r\n *\r\n * @return {Phaser.Filters.Threshold} The new Threshold filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 778, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Threshold effect.\r\rInput values are compared to a threshold value or range.\rValues below the threshold are set to 0, and values above the threshold are set to 1.\rValues within the range are linearly interpolated between 0 and 1.\r\rThis is useful for creating effects such as sharp edges from gradients,\ror for creating binary effects.\r\rThe threshold is stored as a range, with two edges.\rEach edge has a value for each channel, between 0 and 1.\rIf the two edges are the same, the threshold has no interpolation,\rand will output either 0 or 1.\rEach channel can also be inverted.", "kind": "function", "name": "addThreshold", "since": "4.0.0", "params": [ { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "defaultvalue": 0.5, "description": "The first edge of the threshold. This may be an array of the RGBA channels, or a single number for all 4 channels.", "name": "edge1" }, { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "defaultvalue": 0.5, "description": "The second edge of the threshold. This may be an array of the RGBA channels, or a single number for all 4 channels.", "name": "edge2" }, { "type": { "names": [ "boolean", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "boolean", "type": "NameExpression" } ] } ] } }, "optional": true, "defaultvalue": false, "description": "Whether each channel is inverted. This may be an array of the RGBA channels, or a single boolean for all 4 channels.", "name": "invert" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Threshold" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Threshold" } }, "description": "The new Threshold filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addThreshold", "scope": "instance", "___id": "T000002R008824", "___s": true }, { "comment": "/**\r\n * Adds a Tilt Shift effect.\r\n *\r\n * This Bokeh effect can also be used to generate a Tilt Shift effect, which is a technique used to create a miniature\r\n * effect by blurring everything except a small area of the image. This effect is achieved by blurring the\r\n * top and bottom elements, while keeping the center area in focus.\r\n *\r\n * See also Bokeh.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addTiltShift\r\n * @since 4.0.0\r\n *\r\n * @param {number} [radius] - The radius of the bokeh effect.\r\n * @param {number} [amount] - The amount of the bokeh effect.\r\n * @param {number} [contrast] - The color contrast of the bokeh effect.\r\n * @param {number} [blurX] - The amount of horizontal blur.\r\n * @param {number} [blurY] - The amount of vertical blur.\r\n * @param {number} [strength] - The strength of the blur.\r\n *\r\n * @return {Phaser.Filters.Bokeh} The new Bokeh filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 813, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Tilt Shift effect.\r\rThis Bokeh effect can also be used to generate a Tilt Shift effect, which is a technique used to create a miniature\reffect by blurring everything except a small area of the image. This effect is achieved by blurring the\rtop and bottom elements, while keeping the center area in focus.\r\rSee also Bokeh.", "kind": "function", "name": "addTiltShift", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The radius of the bokeh effect.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount of the bokeh effect.", "name": "amount" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color contrast of the bokeh effect.", "name": "contrast" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount of horizontal blur.", "name": "blurX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount of vertical blur.", "name": "blurY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The strength of the blur.", "name": "strength" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Bokeh" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Bokeh" } }, "description": "The new Bokeh filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addTiltShift", "scope": "instance", "___id": "T000002R008826", "___s": true }, { "comment": "/**\r\n * Adds a Vignette effect.\r\n *\r\n * The vignette effect is a visual technique where the edges of the screen,\r\n * or a Game Object, gradually darken or blur,\r\n * creating a frame-like appearance. This effect is used to draw the player's\r\n * focus towards the central action or subject, enhance immersion,\r\n * and provide a cinematic or artistic quality to the game's visuals.\r\n *\r\n * This filter supports colored borders, and a limited set of blend modes,\r\n * to increase its stylistic power.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addVignette\r\n * @since 4.0.0\r\n *\r\n * @param {number} [x=0.5] - The horizontal offset of the vignette effect. This value is normalized to the range 0 to 1.\r\n * @param {number} [y=0.5] - The vertical offset of the vignette effect. This value is normalized to the range 0 to 1.\r\n * @param {number} [radius=0.5] - The radius of the vignette effect. This value is normalized to the range 0 to 1.\r\n * @param {number} [strength=0.5] - The strength of the vignette effect.\r\n * @param {number | string | Phaser.Types.Display.InputColorObject | Phaser.Display.Color} [color=0x000000] - The color of the vignette effect, as a hex code or Color object.\r\n * @param {number} [blendMode=Phaser.BlendModes.NORMAL] - The blend mode to use with the vignette. Only NORMAL, ADD, MULTIPLY, and SCREEN are supported.\r\n *\r\n * @return {Phaser.Filters.Vignette} The new Vignette filter controller.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 848, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Vignette effect.\r\rThe vignette effect is a visual technique where the edges of the screen,\ror a Game Object, gradually darken or blur,\rcreating a frame-like appearance. This effect is used to draw the player's\rfocus towards the central action or subject, enhance immersion,\rand provide a cinematic or artistic quality to the game's visuals.\r\rThis filter supports colored borders, and a limited set of blend modes,\rto increase its stylistic power.", "kind": "function", "name": "addVignette", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The horizontal offset of the vignette effect. This value is normalized to the range 0 to 1.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The vertical offset of the vignette effect. This value is normalized to the range 0 to 1.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The radius of the vignette effect. This value is normalized to the range 0 to 1.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The strength of the vignette effect.", "name": "strength" }, { "type": { "names": [ "number", "string", "Phaser.Types.Display.InputColorObject", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Display.InputColorObject" }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color of the vignette effect, as a hex code or Color object.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "Phaser.BlendModes.NORMAL", "description": "The blend mode to use with the vignette. Only NORMAL, ADD, MULTIPLY, and SCREEN are supported.", "name": "blendMode" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Vignette" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Vignette" } }, "description": "The new Vignette filter controller." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addVignette", "scope": "instance", "___id": "T000002R008828", "___s": true }, { "comment": "/**\r\n * Adds a Wipe effect.\r\n *\r\n * The wipe or reveal effect is a visual technique that gradually uncovers or conceals elements\r\n * in the game, such as images, text, or scene transitions. This effect is often used to create\r\n * a sense of progression, reveal hidden content, or provide a smooth and visually appealing transition\r\n * between game states.\r\n *\r\n * You can set both the direction and the axis of the wipe effect. The following combinations are possible:\r\n *\r\n * * left to right: direction 0, axis 0\r\n * * right to left: direction 1, axis 0\r\n * * top to bottom: direction 0, axis 1\r\n * * bottom to top: direction 1, axis 1\r\n *\r\n * It is up to you to set the `progress` value yourself, e.g. via a Tween, in order to transition the effect.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#addWipe\r\n * @since 4.0.0\r\n *\r\n * @param {number} [wipeWidth=0.1] - The width of the wipe effect. This value is normalized in the range 0 to 1.\r\n * @param {number} [direction=0] - The direction of the wipe effect. Either 0 (left to right, or top to bottom) or 1 (right to left, or bottom to top). Set in conjunction with the axis property.\r\n * @param {number} [axis=0] - The axis of the wipe effect. Either 0 (X) or 1 (Y). Set in conjunction with the direction property.\r\n * @param {number} [reveal=0] - Is this a reveal (1) or a fade (0) effect? Reveal shows the input in wiped areas; fade shows the input in unwiped areas.\r\n * @param {string | Phaser.Textures.Texture} [wipeTexture='__DEFAULT'] - Texture or texture key to use where the input texture is not shown. The default texture is blank. Use another texture for a wipe transition.\r\n *\r\n * @return {Phaser.Filters.Wipe} - The new Wipe filter instance.\r\n */", "meta": { "filename": "FilterList.js", "lineno": 877, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a Wipe effect.\r\rThe wipe or reveal effect is a visual technique that gradually uncovers or conceals elements\rin the game, such as images, text, or scene transitions. This effect is often used to create\ra sense of progression, reveal hidden content, or provide a smooth and visually appealing transition\rbetween game states.\r\rYou can set both the direction and the axis of the wipe effect. The following combinations are possible:\r\r* left to right: direction 0, axis 0\r* right to left: direction 1, axis 0\r* top to bottom: direction 0, axis 1\r* bottom to top: direction 1, axis 1\r\rIt is up to you to set the `progress` value yourself, e.g. via a Tween, in order to transition the effect.", "kind": "function", "name": "addWipe", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "The width of the wipe effect. This value is normalized in the range 0 to 1.", "name": "wipeWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The direction of the wipe effect. Either 0 (left to right, or top to bottom) or 1 (right to left, or bottom to top). Set in conjunction with the axis property.", "name": "direction" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The axis of the wipe effect. Either 0 (X) or 1 (Y). Set in conjunction with the direction property.", "name": "axis" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Is this a reveal (1) or a fade (0) effect? Reveal shows the input in wiped areas; fade shows the input in unwiped areas.", "name": "reveal" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "defaultvalue": "'__DEFAULT'", "description": "Texture or texture key to use where the input texture is not shown. The default texture is blank. Use another texture for a wipe transition.", "name": "wipeTexture" } ], "returns": [ { "type": { "names": [ "Phaser.Filters.Wipe" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Filters.Wipe" } }, "description": "- The new Wipe filter instance." } ], "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#addWipe", "scope": "instance", "___id": "T000002R008830", "___s": true }, { "comment": "/**\r\n * Destroys this FilterList.\r\n *\r\n * @method Phaser.GameObjects.Components.FilterList#destroy\r\n * @since 4.0.0\r\n */", "meta": { "filename": "FilterList.js", "lineno": 910, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Destroys this FilterList.", "kind": "function", "name": "destroy", "since": "4.0.0", "memberof": "Phaser.GameObjects.Components.FilterList", "longname": "Phaser.GameObjects.Components.FilterList#destroy", "scope": "instance", "___id": "T000002R008832", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the filters properties of a Game Object.\r\n * These apply special effects, post-processing and masks to the object.\r\n * Should be applied as a mixin and not used directly.\r\n *\r\n * Filters work by rendering the object to a texture.\r\n * The texture is then rendered again for each filter, using a shader.\r\n * See {@link Phaser.GameObjects.Components.FilterList} for more information.\r\n *\r\n * Enable filters with `enableFilters()`.\r\n * Each object with filters enabled, and any filters active,\r\n * makes a new draw call, plus one or more per active filter.\r\n * This can be expensive. Use sparingly.\r\n *\r\n * ---\r\n *\r\n * ## Camera\r\n *\r\n * Filters has a `filterCamera` property, which is a Camera.\r\n * The Camera does most of the hard work, including the filters.\r\n *\r\n * The Camera automatically focuses on the Game Object,\r\n * so you should not need to adjust it manually.\r\n * If you do want to adjust it, you can use `focusFiltersOverride`.\r\n *\r\n * ---\r\n *\r\n * ## Framebuffer Coverage\r\n *\r\n * Filters are rendered to a framebuffer, which is a texture.\r\n * Anything outside the bounds of the framebuffer is not rendered.\r\n * Think of it as a window into another world.\r\n *\r\n * To ensure that the game object fits into the framebuffer,\r\n * the internal camera is transformed to match the object.\r\n * The object can transform normally, and the camera will follow\r\n * while `filtersAutoFocus` is enabled.\r\n *\r\n * @namespace Phaser.GameObjects.Components.Filters\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Filters.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for setting the filters properties of a Game Object.\rThese apply special effects, post-processing and masks to the object.\rShould be applied as a mixin and not used directly.\r\rFilters work by rendering the object to a texture.\rThe texture is then rendered again for each filter, using a shader.\rSee {@link Phaser.GameObjects.Components.FilterList} for more information.\r\rEnable filters with `enableFilters()`.\rEach object with filters enabled, and any filters active,\rmakes a new draw call, plus one or more per active filter.\rThis can be expensive. Use sparingly.\r\r---\r\r## Camera\r\rFilters has a `filterCamera` property, which is a Camera.\rThe Camera does most of the hard work, including the filters.\r\rThe Camera automatically focuses on the Game Object,\rso you should not need to adjust it manually.\rIf you do want to adjust it, you can use `focusFiltersOverride`.\r\r---\r\r## Framebuffer Coverage\r\rFilters are rendered to a framebuffer, which is a texture.\rAnything outside the bounds of the framebuffer is not rendered.\rThink of it as a window into another world.\r\rTo ensure that the game object fits into the framebuffer,\rthe internal camera is transformed to match the object.\rThe object can transform normally, and the camera will follow\rwhile `filtersAutoFocus` is enabled.", "kind": "namespace", "name": "Filters", "since": "4.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Filters", "scope": "static", "___id": "T000002R008840", "___s": true }, { "comment": "/**\r\n * The Camera used for filters.\r\n * You can use this to alter the perspective of filters.\r\n * It is not necessary to use this camera for ordinary rendering.\r\n *\r\n * This is only available if you use the `enableFilters` method.\r\n *\r\n * @name Phaser.GameObjects.Components.Filters#filterCamera\r\n * @type {Phaser.Cameras.Scene2D.Camera}\r\n * @default null\r\n * @since 4.0.0\r\n * @webglOnly\r\n */", "meta": { "filename": "Filters.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Camera used for filters.\rYou can use this to alter the perspective of filters.\rIt is not necessary to use this camera for ordinary rendering.\r\rThis is only available if you use the `enableFilters` method.", "name": "filterCamera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "defaultvalue": "null", "since": "4.0.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#filterCamera", "scope": "instance", "kind": "member", "___id": "T000002R008843", "___s": true }, { "comment": "/**\r\n * The filter lists for this Game Object.\r\n * This is an object with `internal` and `external` properties.\r\n * Each list is a {@link Phaser.GameObjects.Components.FilterList} object.\r\n *\r\n * This is only available if you use the `enableFilters` method.\r\n *\r\n * @name Phaser.GameObjects.Components.Filters#filters\r\n * @type {Phaser.Types.GameObjects.FiltersInternalExternal|null}\r\n * @readonly\r\n * @since 4.0.0\r\n * @webglOnly\r\n */", "meta": { "filename": "Filters.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The filter lists for this Game Object.\rThis is an object with `internal` and `external` properties.\rEach list is a {@link Phaser.GameObjects.Components.FilterList} object.\r\rThis is only available if you use the `enableFilters` method.", "name": "filters", "type": { "names": [ "Phaser.Types.GameObjects.FiltersInternalExternal", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.FiltersInternalExternal" }, { "type": "NullLiteral" } ] } }, "readonly": true, "since": "4.0.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#filters", "scope": "instance", "kind": "member", "___id": "T000002R008845", "___s": true }, { "comment": "/**\r\n * Whether any filters should be rendered on this Game Object.\r\n * This is `true` by default, even if there are no filters yet.\r\n * Disable this to skip filter rendering.\r\n *\r\n * Use `willRenderFilters()` to see if there are any active filters.\r\n *\r\n * @name Phaser.GameObjects.Components.Filters#renderFilters\r\n * @type {boolean}\r\n * @default true\r\n * @since 4.0.0\r\n * @webglOnly\r\n */", "meta": { "filename": "Filters.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Whether any filters should be rendered on this Game Object.\rThis is `true` by default, even if there are no filters yet.\rDisable this to skip filter rendering.\r\rUse `willRenderFilters()` to see if there are any active filters.", "name": "renderFilters", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "4.0.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#renderFilters", "scope": "instance", "kind": "member", "___id": "T000002R008848", "___s": true }, { "comment": "/**\r\n * The maximum size of the base filter texture.\r\n * Filters may use a larger texture after the base texture is rendered.\r\n * The maximum texture size is at least 4096 in WebGL, based on the hardware.\r\n * You may set this lower to save memory or prevent resizing.\r\n *\r\n * @name Phaser.GameObjects.Components.Filters#maxFilterSize\r\n * @type {Phaser.Math.Vector2}\r\n * @since 4.0.0\r\n * @webglOnly\r\n */", "meta": { "filename": "Filters.js", "lineno": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The maximum size of the base filter texture.\rFilters may use a larger texture after the base texture is rendered.\rThe maximum texture size is at least 4096 in WebGL, based on the hardware.\rYou may set this lower to save memory or prevent resizing.", "name": "maxFilterSize", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "4.0.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#maxFilterSize", "scope": "instance", "kind": "member", "___id": "T000002R008850", "___s": true }, { "comment": "/**\r\n * Whether `filterCamera` should update every frame\r\n * to focus on the Game Object.\r\n * Disable this if you want to manually control the camera.\r\n *\r\n * @name Phaser.GameObjects.Components.Filters#filtersAutoFocus\r\n * @type {boolean}\r\n * @default true\r\n * @since 4.0.0\r\n * @webglOnly\r\n */", "meta": { "filename": "Filters.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Whether `filterCamera` should update every frame\rto focus on the Game Object.\rDisable this if you want to manually control the camera.", "name": "filtersAutoFocus", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "4.0.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#filtersAutoFocus", "scope": "instance", "kind": "member", "___id": "T000002R008852", "___s": true }, { "comment": "/**\r\n * Whether the filters should focus on the context,\r\n * rather than attempt to focus on the Game Object.\r\n * This is enabled automatically when enabling filters on objects\r\n * which don't have well-defined bounds.\r\n *\r\n * This effectively sets the internal filters to render the same way\r\n * as the external filters.\r\n *\r\n * This is only used if `filtersAutoFocus` is enabled.\r\n *\r\n * The \"context\" is the framebuffer to which the Game Object is rendered.\r\n * This is usually the main framebuffer, but might be another framebuffer.\r\n * It can even be several different framebuffers if the Game Object is\r\n * rendered multiple times.\r\n *\r\n * @name Phaser.GameObjects.Components.Filters#filtersFocusContext\r\n * @type {boolean}\r\n * @default false\r\n * @since 4.0.0\r\n * @webglOnly\r\n */", "meta": { "filename": "Filters.js", "lineno": 138, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Whether the filters should focus on the context,\rrather than attempt to focus on the Game Object.\rThis is enabled automatically when enabling filters on objects\rwhich don't have well-defined bounds.\r\rThis effectively sets the internal filters to render the same way\ras the external filters.\r\rThis is only used if `filtersAutoFocus` is enabled.\r\rThe \"context\" is the framebuffer to which the Game Object is rendered.\rThis is usually the main framebuffer, but might be another framebuffer.\rIt can even be several different framebuffers if the Game Object is\rrendered multiple times.", "name": "filtersFocusContext", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "4.0.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#filtersFocusContext", "scope": "instance", "kind": "member", "___id": "T000002R008854", "___s": true }, { "comment": "/**\r\n * Whether the Filters component should always draw to a framebuffer,\r\n * even if there are no active filters.\r\n *\r\n * @name Phaser.GameObjects.Components.Filters#filtersForceComposite\r\n * @type {boolean}\r\n * @default false\r\n * @since 4.0.0\r\n * @webglOnly\r\n */", "meta": { "filename": "Filters.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Whether the Filters component should always draw to a framebuffer,\reven if there are no active filters.", "name": "filtersForceComposite", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "4.0.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#filtersForceComposite", "scope": "instance", "kind": "member", "___id": "T000002R008856", "___s": true }, { "comment": "/**\r\n * Whether this Game Object will render filters.\r\n * This is true if it has active filters,\r\n * and if the `renderFilters` property is also true.\r\n *\r\n * @method Phaser.GameObjects.Components.Filters#willRenderFilters\r\n * @since 4.0.0\r\n * @webglOnly\r\n * @return {boolean} Whether the Game Object will render filters.\r\n */", "meta": { "filename": "Filters.js", "lineno": 202, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Whether this Game Object will render filters.\rThis is true if it has active filters,\rand if the `renderFilters` property is also true.", "kind": "function", "name": "willRenderFilters", "since": "4.0.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the Game Object will render filters." } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#willRenderFilters", "scope": "instance", "___id": "T000002R008862", "___s": true }, { "comment": "/**\r\n * Enable this Game Object to have filters.\r\n *\r\n * You need to call this method if you want to use the `filterCamera`\r\n * and `filters` properties. It sets up the necessary data structures.\r\n * You may disable filter rendering with the `renderFilters` property.\r\n *\r\n * This is a WebGL only feature. It will return early if not available.\r\n *\r\n * @method Phaser.GameObjects.Components.Filters#enableFilters\r\n * @since 4.0.0\r\n * @webglOnly\r\n * @return {this}\r\n */", "meta": { "filename": "Filters.js", "lineno": 223, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Enable this Game Object to have filters.\r\rYou need to call this method if you want to use the `filterCamera`\rand `filters` properties. It sets up the necessary data structures.\rYou may disable filter rendering with the `renderFilters` property.\r\rThis is a WebGL only feature. It will return early if not available.", "kind": "function", "name": "enableFilters", "since": "4.0.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } } } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#enableFilters", "scope": "instance", "___id": "T000002R008864", "___s": true }, { "comment": "/**\r\n * Render this object using filters.\r\n *\r\n * This function's scope is not guaranteed, so it doesn't refer to `this`.\r\n *\r\n * @method Phaser.GameObjects.Components.Filters#renderWebGLFilters\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @type {Phaser.Types.GameObjects.RenderWebGLStep}\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - The WebGL Renderer instance to render with.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered.\r\n * @param {Phaser.Renderer.WebGL.DrawingContext} drawingContext - The current drawing context.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentMatrix] - The parent matrix of the Game Object, if it has one.\r\n * @param {number} [renderStep=0] - The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions.\r\n */", "meta": { "filename": "Filters.js", "lineno": 291, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Render this object using filters.\r\rThis function's scope is not guaranteed, so it doesn't refer to `this`.", "kind": "function", "name": "renderWebGLFilters", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "type": { "names": [ "Phaser.Types.GameObjects.RenderWebGLStep" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.RenderWebGLStep" } }, "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.RenderWebGLStep" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.RenderWebGLStep" } } } ], "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "The WebGL Renderer instance to render with.", "name": "renderer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Renderer.WebGL.DrawingContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.DrawingContext" } }, "description": "The current drawing context.", "name": "drawingContext" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "The parent matrix of the Game Object, if it has one.", "name": "parentMatrix" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions.", "name": "renderStep" } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#renderWebGLFilters", "scope": "instance", "___id": "T000002R008877", "___s": true }, { "comment": "/**\r\n * Focus the filter camera.\r\n * This sets the size and position of the filter camera to match the GameObject.\r\n * This is called automatically on render if `filtersAutoFocus` is enabled.\r\n *\r\n * This will focus on the GameObject's raw dimensions if available.\r\n * If the GameObject has no dimensions, this will focus on the context:\r\n * the camera belonging to the DrawingContext used to render the GameObject.\r\n * Context focus occurs during rendering,\r\n * as the context is not known until then.\r\n *\r\n * @method Phaser.GameObjects.Components.Filters#focusFilters\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @return {this}\r\n */", "meta": { "filename": "Filters.js", "lineno": 457, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Focus the filter camera.\rThis sets the size and position of the filter camera to match the GameObject.\rThis is called automatically on render if `filtersAutoFocus` is enabled.\r\rThis will focus on the GameObject's raw dimensions if available.\rIf the GameObject has no dimensions, this will focus on the context:\rthe camera belonging to the DrawingContext used to render the GameObject.\rContext focus occurs during rendering,\ras the context is not known until then.", "kind": "function", "name": "focusFilters", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } } } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#focusFilters", "scope": "instance", "___id": "T000002R008902", "___s": true }, { "comment": "/**\r\n * Focus the filter camera on a specific camera.\r\n * This is used internally when `filtersFocusContext` is enabled.\r\n *\r\n * @method Phaser.GameObjects.Components.Filters#focusFiltersOnCamera\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera to focus on.\r\n * @return {this}\r\n */", "meta": { "filename": "Filters.js", "lineno": 526, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Focus the filter camera on a specific camera.\rThis is used internally when `filtersFocusContext` is enabled.", "kind": "function", "name": "focusFiltersOnCamera", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera to focus on.", "name": "camera" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } } } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#focusFiltersOnCamera", "scope": "instance", "___id": "T000002R008920", "___s": true }, { "comment": "/**\r\n * Manually override the focus of the filter camera.\r\n * This allows you to set the size and position of the filter camera manually.\r\n * It deactivates `filtersAutoFocus` when called.\r\n *\r\n * The camera will set scroll to place the game object at the\r\n * given position within a rectangle of the given width and height.\r\n * For example, calling `focusFiltersOverride(400, 200, 800, 600)`\r\n * will focus the camera to place the object's center\r\n * 100 pixels above the center of the camera (which is at 400x300).\r\n *\r\n * @method Phaser.GameObjects.Components.Filters#focusFiltersOverride\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @param {number} [x] - The x-coordinate of the focus point, relative to the filter size. Default is the center.\r\n * @param {number} [y] - The y-coordinate of the focus point, relative to the filter size. Default is the center.\r\n * @param {number} [width] - The width of the focus area. Default is the filter width.\r\n * @param {number} [height] - The height of the focus area. Default is the filter height.\r\n * @return {this}\r\n */", "meta": { "filename": "Filters.js", "lineno": 556, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Manually override the focus of the filter camera.\rThis allows you to set the size and position of the filter camera manually.\rIt deactivates `filtersAutoFocus` when called.\r\rThe camera will set scroll to place the game object at the\rgiven position within a rectangle of the given width and height.\rFor example, calling `focusFiltersOverride(400, 200, 800, 600)`\rwill focus the camera to place the object's center\r100 pixels above the center of the camera (which is at 400x300).", "kind": "function", "name": "focusFiltersOverride", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x-coordinate of the focus point, relative to the filter size. Default is the center.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y-coordinate of the focus point, relative to the filter size. Default is the center.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the focus area. Default is the filter width.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the focus area. Default is the filter height.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } } } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#focusFiltersOverride", "scope": "instance", "___id": "T000002R008929", "___s": true }, { "comment": "/**\r\n * Set the base size of the filter camera.\r\n * This is the size of the texture that internal filters will be drawn to.\r\n * External filters are drawn to the size of the context (usually the game canvas).\r\n *\r\n * This is typically the size of the GameObject.\r\n * It is set automatically when the Game Object is rendered\r\n * and `filtersAutoFocus` is enabled.\r\n * Turn off auto focus to set it manually.\r\n *\r\n * Technically, larger framebuffers may be used to provide padding.\r\n * This is the size of the final framebuffer used for \"internal\" rendering.\r\n *\r\n * @method Phaser.GameObjects.Components.Filters#setFilterSize\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @param {number} width - Base width of the filter texture.\r\n * @param {number} height - Base height of the filter texture.\r\n * @return {this}\r\n */", "meta": { "filename": "Filters.js", "lineno": 617, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Set the base size of the filter camera.\rThis is the size of the texture that internal filters will be drawn to.\rExternal filters are drawn to the size of the context (usually the game canvas).\r\rThis is typically the size of the GameObject.\rIt is set automatically when the Game Object is rendered\rand `filtersAutoFocus` is enabled.\rTurn off auto focus to set it manually.\r\rTechnically, larger framebuffers may be used to provide padding.\rThis is the size of the final framebuffer used for \"internal\" rendering.", "kind": "function", "name": "setFilterSize", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Base width of the filter texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Base height of the filter texture.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } } } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#setFilterSize", "scope": "instance", "___id": "T000002R008941", "___s": true }, { "comment": "/**\r\n * Sets whether the filter camera should automatically re-focus on the Game Object every frame.\r\n * Sets the `filtersAutoFocus` property.\r\n *\r\n * @method Phaser.GameObjects.Components.Filters#setFiltersAutoFocus\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @param {boolean} value - Whether filters should be updated every frame.\r\n * @return {this}\r\n */", "meta": { "filename": "Filters.js", "lineno": 653, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets whether the filter camera should automatically re-focus on the Game Object every frame.\rSets the `filtersAutoFocus` property.", "kind": "function", "name": "setFiltersAutoFocus", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether filters should be updated every frame.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } } } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#setFiltersAutoFocus", "scope": "instance", "___id": "T000002R008946", "___s": true }, { "comment": "/**\r\n * Set whether the filters should focus on the context.\r\n * Sets the `filtersFocusContext` property.\r\n *\r\n * @method Phaser.GameObjects.Components.Filters#setFiltersFocusContext\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @param {boolean} value - Whether the filters should focus on the context.\r\n * @return {this}\r\n */", "meta": { "filename": "Filters.js", "lineno": 670, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Set whether the filters should focus on the context.\rSets the `filtersFocusContext` property.", "kind": "function", "name": "setFiltersFocusContext", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the filters should focus on the context.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } } } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#setFiltersFocusContext", "scope": "instance", "___id": "T000002R008949", "___s": true }, { "comment": "/**\r\n * Set whether the filters should always draw to a framebuffer.\r\n * Sets the `filtersForceComposite` property.\r\n *\r\n * @method Phaser.GameObjects.Components.Filters#setFiltersForceComposite\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @param {boolean} value - Whether the object should always draw to a framebuffer, even if there are no active filters.\r\n * @return {this}\r\n */", "meta": { "filename": "Filters.js", "lineno": 687, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Set whether the filters should always draw to a framebuffer.\rSets the `filtersForceComposite` property.", "kind": "function", "name": "setFiltersForceComposite", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the object should always draw to a framebuffer, even if there are no active filters.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } } } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#setFiltersForceComposite", "scope": "instance", "___id": "T000002R008952", "___s": true }, { "comment": "/**\r\n * Set whether the filters should be rendered.\r\n * Sets the `renderFilters` property.\r\n *\r\n * @method Phaser.GameObjects.Components.Filters#setRenderFilters\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @param {boolean} value - Whether the filters should be rendered.\r\n * @return {this}\r\n */", "meta": { "filename": "Filters.js", "lineno": 704, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Set whether the filters should be rendered.\rSets the `renderFilters` property.", "kind": "function", "name": "setRenderFilters", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the filters should be rendered.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } } } ], "memberof": "Phaser.GameObjects.Components.Filters", "longname": "Phaser.GameObjects.Components.Filters#setRenderFilters", "scope": "instance", "___id": "T000002R008955", "___s": true }, { "comment": "/**\r\n * Provides methods used for visually flipping a Game Object along its horizontal and/or vertical axes.\r\n *\r\n * Flipping mirrors the rendered texture without altering the Game Object's scale, position, or physics body.\r\n * The flip always pivots from the centre of the texture. This component is intended to be mixed in to\r\n * Game Object classes and should not be used directly.\r\n *\r\n * @namespace Phaser.GameObjects.Components.Flip\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for visually flipping a Game Object along its horizontal and/or vertical axes.\r\rFlipping mirrors the rendered texture without altering the Game Object's scale, position, or physics body.\rThe flip always pivots from the centre of the texture. This component is intended to be mixed in to\rGame Object classes and should not be used directly.", "kind": "namespace", "name": "Flip", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Flip", "scope": "static", "___id": "T000002R008959", "___s": true }, { "comment": "/**\r\n * The horizontally flipped state of the Game Object.\r\n *\r\n * A Game Object that is flipped horizontally will render inverted on the horizontal axis.\r\n * Flipping always takes place from the middle of the texture and does not impact the scale value.\r\n * If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.\r\n *\r\n * @name Phaser.GameObjects.Components.Flip#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 20, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The horizontally flipped state of the Game Object.\r\rA Game Object that is flipped horizontally will render inverted on the horizontal axis.\rFlipping always takes place from the middle of the texture and does not impact the scale value.\rIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.", "name": "flipX", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Flip", "longname": "Phaser.GameObjects.Components.Flip#flipX", "scope": "instance", "kind": "member", "___id": "T000002R008961", "___s": true }, { "comment": "/**\r\n * The vertically flipped state of the Game Object.\r\n *\r\n * A Game Object that is flipped vertically will render inverted on the vertical axis (i.e. upside down).\r\n * Flipping always takes place from the middle of the texture and does not impact the scale value.\r\n * If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.\r\n *\r\n * @name Phaser.GameObjects.Components.Flip#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Flip.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The vertically flipped state of the Game Object.\r\rA Game Object that is flipped vertically will render inverted on the vertical axis (i.e. upside down).\rFlipping always takes place from the middle of the texture and does not impact the scale value.\rIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.", "name": "flipY", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Flip", "longname": "Phaser.GameObjects.Components.Flip#flipY", "scope": "instance", "kind": "member", "___id": "T000002R008963", "___s": true }, { "comment": "/**\r\n * Toggles the horizontal flipped state of this Game Object.\r\n *\r\n * A Game Object that is flipped horizontally will render inverted on the horizontal axis.\r\n * Flipping always takes place from the middle of the texture and does not impact the scale value.\r\n * If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.\r\n *\r\n * @method Phaser.GameObjects.Components.Flip#toggleFlipX\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Flip.js", "lineno": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Toggles the horizontal flipped state of this Game Object.\r\rA Game Object that is flipped horizontally will render inverted on the horizontal axis.\rFlipping always takes place from the middle of the texture and does not impact the scale value.\rIf 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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Flip", "longname": "Phaser.GameObjects.Components.Flip#toggleFlipX", "scope": "instance", "___id": "T000002R008965", "___s": true }, { "comment": "/**\r\n * Toggles the vertical flipped state of this Game Object.\r\n *\r\n * A Game Object that is flipped vertically will render inverted on the vertical axis.\r\n * Flipping always takes place from the middle of the texture and does not impact the scale value.\r\n * If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.\r\n *\r\n * @method Phaser.GameObjects.Components.Flip#toggleFlipY\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Flip.js", "lineno": 67, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Toggles the vertical flipped state of this Game Object.\r\rA Game Object that is flipped vertically will render inverted on the vertical axis.\rFlipping always takes place from the middle of the texture and does not impact the scale value.\rIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.", "kind": "function", "name": "toggleFlipY", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Flip", "longname": "Phaser.GameObjects.Components.Flip#toggleFlipY", "scope": "instance", "___id": "T000002R008968", "___s": true }, { "comment": "/**\r\n * Sets the horizontal flipped state of this Game Object.\r\n *\r\n * A Game Object that is flipped horizontally will render inverted on the horizontal axis.\r\n * Flipping always takes place from the middle of the texture and does not impact the scale value.\r\n * If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.\r\n *\r\n * @method Phaser.GameObjects.Components.Flip#setFlipX\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - The flipped state. `false` for no flip, or `true` to be flipped.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Flip.js", "lineno": 86, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the horizontal flipped state of this Game Object.\r\rA Game Object that is flipped horizontally will render inverted on the horizontal axis.\rFlipping always takes place from the middle of the texture and does not impact the scale value.\rIf 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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Flip", "longname": "Phaser.GameObjects.Components.Flip#setFlipX", "scope": "instance", "___id": "T000002R008971", "___s": true }, { "comment": "/**\r\n * Sets the vertical flipped state of this Game Object.\r\n *\r\n * A Game Object that is flipped vertically will render inverted on the vertical axis.\r\n * Flipping always takes place from the middle of the texture and does not impact the scale value.\r\n * If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.\r\n *\r\n * @method Phaser.GameObjects.Components.Flip#setFlipY\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - The flipped state. `false` for no flip, or `true` to be flipped.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Flip.js", "lineno": 107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the vertical flipped state of this Game Object.\r\rA Game Object that is flipped vertically will render inverted on the vertical axis.\rFlipping always takes place from the middle of the texture and does not impact the scale value.\rIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.", "kind": "function", "name": "setFlipY", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The flipped state. `false` for no flip, or `true` to be flipped.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Flip", "longname": "Phaser.GameObjects.Components.Flip#setFlipY", "scope": "instance", "___id": "T000002R008974", "___s": true }, { "comment": "/**\r\n * Sets the horizontal and vertical flipped state of this Game Object.\r\n *\r\n * A Game Object that is flipped will render inverted on the flipped axis.\r\n * Flipping always takes place from the middle of the texture and does not impact the scale value.\r\n * If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.\r\n *\r\n * @method Phaser.GameObjects.Components.Flip#setFlip\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} x - The horizontal flipped state. `false` for no flip, or `true` to be flipped.\r\n * @param {boolean} y - The vertical flipped state. `false` for no flip, or `true` to be flipped.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Flip.js", "lineno": 128, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the horizontal and vertical flipped state of this Game Object.\r\rA Game Object that is flipped will render inverted on the flipped axis.\rFlipping always takes place from the middle of the texture and does not impact the scale value.\rIf 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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The horizontal flipped state. `false` for no flip, or `true` to be flipped.", "name": "x" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The vertical flipped state. `false` for no flip, or `true` to be flipped.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Flip", "longname": "Phaser.GameObjects.Components.Flip#setFlip", "scope": "instance", "___id": "T000002R008977", "___s": true }, { "comment": "/**\r\n * Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.\r\n *\r\n * @method Phaser.GameObjects.Components.Flip#resetFlip\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Flip.js", "lineno": 151, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Flip", "longname": "Phaser.GameObjects.Components.Flip#resetFlip", "scope": "instance", "___id": "T000002R008981", "___s": true }, { "comment": "/**\r\n * Provides methods used for obtaining the bounds of a Game Object, including\r\n * its corners, edge midpoints, center point, and overall axis-aligned bounding\r\n * rectangle. All methods account for the Game Object's rotation and display\r\n * size, and can optionally factor in any parent Container transforms.\r\n * Should be applied as a mixin and not used directly.\r\n *\r\n * @namespace Phaser.GameObjects.Components.GetBounds\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GetBounds.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for obtaining the bounds of a Game Object, including\rits corners, edge midpoints, center point, and overall axis-aligned bounding\rrectangle. All methods account for the Game Object's rotation and display\rsize, and can optionally factor in any parent Container transforms.\rShould 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", "___id": "T000002R008989", "___s": true }, { "comment": "/**\r\n * Gets the center coordinate of this Game Object, regardless of origin.\r\n *\r\n * The returned point is calculated in local space and does not factor in any parent Containers,\r\n * unless the `includeParent` argument is set to `true`.\r\n *\r\n * @method Phaser.GameObjects.Components.GetBounds#getCenter\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Types.Math.Vector2Like} O - [output,$return]\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} [output] - An object to store the values in. If not provided a new Vector2 will be created.\r\n * @param {boolean} [includeParent=false] - If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The values stored in the output object.\r\n */", "meta": { "filename": "GetBounds.js", "lineno": 57, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the center coordinate of this Game Object, regardless of origin.\r\rThe returned point is calculated in local space and does not factor in any parent Containers,\runless the `includeParent` argument is set to `true`.", "kind": "function", "name": "getCenter", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Types.Math.Vector2Like} O - [output,$return]", "value": "{Phaser.Types.Math.Vector2Like} O - [output,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "An object to store the values in. If not provided a new Vector2 will be created.", "name": "output" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?", "name": "includeParent" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The values stored in the output object." } ], "memberof": "Phaser.GameObjects.Components.GetBounds", "longname": "Phaser.GameObjects.Components.GetBounds#getCenter", "scope": "instance", "___id": "T000002R008995", "___s": true }, { "comment": "/**\r\n * Gets the top-left corner coordinate of this Game Object, regardless of origin.\r\n *\r\n * The returned point is calculated in local space and does not factor in any parent Containers,\r\n * unless the `includeParent` argument is set to `true`.\r\n *\r\n * @method Phaser.GameObjects.Components.GetBounds#getTopLeft\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Types.Math.Vector2Like} O - [output,$return]\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} [output] - An object to store the values in. If not provided a new Vector2 will be created.\r\n * @param {boolean} [includeParent=false] - If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The values stored in the output object.\r\n */", "meta": { "filename": "GetBounds.js", "lineno": 83, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the top-left corner coordinate of this Game Object, regardless of origin.\r\rThe returned point is calculated in local space and does not factor in any parent Containers,\runless the `includeParent` argument is set to `true`.", "kind": "function", "name": "getTopLeft", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Types.Math.Vector2Like} O - [output,$return]", "value": "{Phaser.Types.Math.Vector2Like} O - [output,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "An object to store the values in. If not provided a new Vector2 will be created.", "name": "output" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?", "name": "includeParent" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The values stored in the output object." } ], "memberof": "Phaser.GameObjects.Components.GetBounds", "longname": "Phaser.GameObjects.Components.GetBounds#getTopLeft", "scope": "instance", "___id": "T000002R009000", "___s": true }, { "comment": "/**\r\n * Gets the top-center coordinate of this Game Object, regardless of origin.\r\n *\r\n * The returned point is calculated in local space and does not factor in any parent Containers,\r\n * unless the `includeParent` argument is set to `true`.\r\n *\r\n * @method Phaser.GameObjects.Components.GetBounds#getTopCenter\r\n * @since 3.18.0\r\n *\r\n * @generic {Phaser.Types.Math.Vector2Like} O - [output,$return]\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} [output] - An object to store the values in. If not provided a new Vector2 will be created.\r\n * @param {boolean} [includeParent=false] - If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The values stored in the output object.\r\n */", "meta": { "filename": "GetBounds.js", "lineno": 109, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the top-center coordinate of this Game Object, regardless of origin.\r\rThe returned point is calculated in local space and does not factor in any parent Containers,\runless the `includeParent` argument is set to `true`.", "kind": "function", "name": "getTopCenter", "since": "3.18.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Types.Math.Vector2Like} O - [output,$return]", "value": "{Phaser.Types.Math.Vector2Like} O - [output,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "An object to store the values in. If not provided a new Vector2 will be created.", "name": "output" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?", "name": "includeParent" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The values stored in the output object." } ], "memberof": "Phaser.GameObjects.Components.GetBounds", "longname": "Phaser.GameObjects.Components.GetBounds#getTopCenter", "scope": "instance", "___id": "T000002R009005", "___s": true }, { "comment": "/**\r\n * Gets the top-right corner coordinate of this Game Object, regardless of origin.\r\n *\r\n * The returned point is calculated in local space and does not factor in any parent Containers,\r\n * unless the `includeParent` argument is set to `true`.\r\n *\r\n * @method Phaser.GameObjects.Components.GetBounds#getTopRight\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Types.Math.Vector2Like} O - [output,$return]\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} [output] - An object to store the values in. If not provided a new Vector2 will be created.\r\n * @param {boolean} [includeParent=false] - If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The values stored in the output object.\r\n */", "meta": { "filename": "GetBounds.js", "lineno": 135, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the top-right corner coordinate of this Game Object, regardless of origin.\r\rThe returned point is calculated in local space and does not factor in any parent Containers,\runless the `includeParent` argument is set to `true`.", "kind": "function", "name": "getTopRight", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Types.Math.Vector2Like} O - [output,$return]", "value": "{Phaser.Types.Math.Vector2Like} O - [output,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "An object to store the values in. If not provided a new Vector2 will be created.", "name": "output" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?", "name": "includeParent" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The values stored in the output object." } ], "memberof": "Phaser.GameObjects.Components.GetBounds", "longname": "Phaser.GameObjects.Components.GetBounds#getTopRight", "scope": "instance", "___id": "T000002R009010", "___s": true }, { "comment": "/**\r\n * Gets the left-center coordinate of this Game Object, regardless of origin.\r\n *\r\n * The returned point is calculated in local space and does not factor in any parent Containers,\r\n * unless the `includeParent` argument is set to `true`.\r\n *\r\n * @method Phaser.GameObjects.Components.GetBounds#getLeftCenter\r\n * @since 3.18.0\r\n *\r\n * @generic {Phaser.Types.Math.Vector2Like} O - [output,$return]\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} [output] - An object to store the values in. If not provided a new Vector2 will be created.\r\n * @param {boolean} [includeParent=false] - If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The values stored in the output object.\r\n */", "meta": { "filename": "GetBounds.js", "lineno": 161, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the left-center coordinate of this Game Object, regardless of origin.\r\rThe returned point is calculated in local space and does not factor in any parent Containers,\runless the `includeParent` argument is set to `true`.", "kind": "function", "name": "getLeftCenter", "since": "3.18.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Types.Math.Vector2Like} O - [output,$return]", "value": "{Phaser.Types.Math.Vector2Like} O - [output,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "An object to store the values in. If not provided a new Vector2 will be created.", "name": "output" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?", "name": "includeParent" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The values stored in the output object." } ], "memberof": "Phaser.GameObjects.Components.GetBounds", "longname": "Phaser.GameObjects.Components.GetBounds#getLeftCenter", "scope": "instance", "___id": "T000002R009015", "___s": true }, { "comment": "/**\r\n * Gets the right-center coordinate of this Game Object, regardless of origin.\r\n *\r\n * The returned point is calculated in local space and does not factor in any parent Containers,\r\n * unless the `includeParent` argument is set to `true`.\r\n *\r\n * @method Phaser.GameObjects.Components.GetBounds#getRightCenter\r\n * @since 3.18.0\r\n *\r\n * @generic {Phaser.Types.Math.Vector2Like} O - [output,$return]\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} [output] - An object to store the values in. If not provided a new Vector2 will be created.\r\n * @param {boolean} [includeParent=false] - If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The values stored in the output object.\r\n */", "meta": { "filename": "GetBounds.js", "lineno": 187, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the right-center coordinate of this Game Object, regardless of origin.\r\rThe returned point is calculated in local space and does not factor in any parent Containers,\runless the `includeParent` argument is set to `true`.", "kind": "function", "name": "getRightCenter", "since": "3.18.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Types.Math.Vector2Like} O - [output,$return]", "value": "{Phaser.Types.Math.Vector2Like} O - [output,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "An object to store the values in. If not provided a new Vector2 will be created.", "name": "output" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?", "name": "includeParent" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The values stored in the output object." } ], "memberof": "Phaser.GameObjects.Components.GetBounds", "longname": "Phaser.GameObjects.Components.GetBounds#getRightCenter", "scope": "instance", "___id": "T000002R009020", "___s": true }, { "comment": "/**\r\n * Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\r\n *\r\n * The returned point is calculated in local space and does not factor in any parent Containers,\r\n * unless the `includeParent` argument is set to `true`.\r\n *\r\n * @method Phaser.GameObjects.Components.GetBounds#getBottomLeft\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Types.Math.Vector2Like} O - [output,$return]\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} [output] - An object to store the values in. If not provided a new Vector2 will be created.\r\n * @param {boolean} [includeParent=false] - If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The values stored in the output object.\r\n */", "meta": { "filename": "GetBounds.js", "lineno": 213, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the bottom-left corner coordinate of this Game Object, regardless of origin.\r\rThe returned point is calculated in local space and does not factor in any parent Containers,\runless the `includeParent` argument is set to `true`.", "kind": "function", "name": "getBottomLeft", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Types.Math.Vector2Like} O - [output,$return]", "value": "{Phaser.Types.Math.Vector2Like} O - [output,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "An object to store the values in. If not provided a new Vector2 will be created.", "name": "output" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?", "name": "includeParent" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The values stored in the output object." } ], "memberof": "Phaser.GameObjects.Components.GetBounds", "longname": "Phaser.GameObjects.Components.GetBounds#getBottomLeft", "scope": "instance", "___id": "T000002R009025", "___s": true }, { "comment": "/**\r\n * Gets the bottom-center coordinate of this Game Object, regardless of origin.\r\n *\r\n * The returned point is calculated in local space and does not factor in any parent Containers,\r\n * unless the `includeParent` argument is set to `true`.\r\n *\r\n * @method Phaser.GameObjects.Components.GetBounds#getBottomCenter\r\n * @since 3.18.0\r\n *\r\n * @generic {Phaser.Types.Math.Vector2Like} O - [output,$return]\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} [output] - An object to store the values in. If not provided a new Vector2 will be created.\r\n * @param {boolean} [includeParent=false] - If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The values stored in the output object.\r\n */", "meta": { "filename": "GetBounds.js", "lineno": 239, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the bottom-center coordinate of this Game Object, regardless of origin.\r\rThe returned point is calculated in local space and does not factor in any parent Containers,\runless the `includeParent` argument is set to `true`.", "kind": "function", "name": "getBottomCenter", "since": "3.18.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Types.Math.Vector2Like} O - [output,$return]", "value": "{Phaser.Types.Math.Vector2Like} O - [output,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "An object to store the values in. If not provided a new Vector2 will be created.", "name": "output" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?", "name": "includeParent" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The values stored in the output object." } ], "memberof": "Phaser.GameObjects.Components.GetBounds", "longname": "Phaser.GameObjects.Components.GetBounds#getBottomCenter", "scope": "instance", "___id": "T000002R009030", "___s": true }, { "comment": "/**\r\n * Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\r\n *\r\n * The returned point is calculated in local space and does not factor in any parent Containers,\r\n * unless the `includeParent` argument is set to `true`.\r\n *\r\n * @method Phaser.GameObjects.Components.GetBounds#getBottomRight\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Types.Math.Vector2Like} O - [output,$return]\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} [output] - An object to store the values in. If not provided a new Vector2 will be created.\r\n * @param {boolean} [includeParent=false] - If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The values stored in the output object.\r\n */", "meta": { "filename": "GetBounds.js", "lineno": 265, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the bottom-right corner coordinate of this Game Object, regardless of origin.\r\rThe returned point is calculated in local space and does not factor in any parent Containers,\runless the `includeParent` argument is set to `true`.", "kind": "function", "name": "getBottomRight", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Types.Math.Vector2Like} O - [output,$return]", "value": "{Phaser.Types.Math.Vector2Like} O - [output,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "An object to store the values in. If not provided a new Vector2 will be created.", "name": "output" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If this Game Object has a parent Container, include it (and all other ancestors) in the resulting vector?", "name": "includeParent" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The values stored in the output object." } ], "memberof": "Phaser.GameObjects.Components.GetBounds", "longname": "Phaser.GameObjects.Components.GetBounds#getBottomRight", "scope": "instance", "___id": "T000002R009035", "___s": true }, { "comment": "/**\r\n * Gets the axis-aligned bounding rectangle of this Game Object, regardless of origin.\r\n *\r\n * The bounding rectangle is computed by retrieving all four corner positions of the\r\n * Game Object (top-left, top-right, bottom-left, bottom-right), applying any rotation\r\n * and parent Container transforms, and then calculating the smallest axis-aligned\r\n * rectangle that fully encloses all four points.\r\n *\r\n * The values are stored and returned in a Rectangle, or Rectangle-like, object.\r\n *\r\n * @method Phaser.GameObjects.Components.GetBounds#getBounds\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [output,$return]\r\n *\r\n * @param {(Phaser.Geom.Rectangle|object)} [output] - An object to store the values in. If not provided a new Rectangle will be created.\r\n *\r\n * @return {(Phaser.Geom.Rectangle|object)} The values stored in the output object.\r\n */", "meta": { "filename": "GetBounds.js", "lineno": 291, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the axis-aligned bounding rectangle of this Game Object, regardless of origin.\r\rThe bounding rectangle is computed by retrieving all four corner positions of the\rGame Object (top-left, top-right, bottom-left, bottom-right), applying any rotation\rand parent Container transforms, and then calculating the smallest axis-aligned\rrectangle that fully encloses all four points.\r\rThe values are stored and returned in a Rectangle, or Rectangle-like, object.", "kind": "function", "name": "getBounds", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The values stored in the output object." } ], "memberof": "Phaser.GameObjects.Components.GetBounds", "longname": "Phaser.GameObjects.Components.GetBounds#getBounds", "scope": "instance", "___id": "T000002R009040", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.GameObjects.Components\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "kind": "namespace", "name": "Components", "memberof": "Phaser.GameObjects", "longname": "Phaser.GameObjects.Components", "scope": "static", "___id": "T000002R009073", "___s": true }, { "comment": "/**\r\n * Provides methods for enabling WebGL-based per-pixel lighting effects on a Game Object,\r\n * using normal maps to simulate surface depth under dynamic light sources.\r\n *\r\n * When lighting is enabled, the Game Object will respond to lights added to the scene\r\n * via the Lights plugin. This component also supports self-shadowing, which creates\r\n * contact shadows on the surface based on the object's normal map.\r\n *\r\n * This component should only be applied to Game Objects that have RenderNodes, and\r\n * requires the WebGL renderer. It has no effect in Canvas rendering mode.\r\n *\r\n * @namespace Phaser.GameObjects.Components.Lighting\r\n * @webglOnly\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Lighting.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods for enabling WebGL-based per-pixel lighting effects on a Game Object,\rusing normal maps to simulate surface depth under dynamic light sources.\r\rWhen lighting is enabled, the Game Object will respond to lights added to the scene\rvia the Lights plugin. This component also supports self-shadowing, which creates\rcontact shadows on the surface based on the object's normal map.\r\rThis component should only be applied to Game Objects that have RenderNodes, and\rrequires the WebGL renderer. It has no effect in Canvas rendering mode.", "kind": "namespace", "name": "Lighting", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Lighting", "scope": "static", "___id": "T000002R009102", "___s": true }, { "comment": "/**\r\n * Controls whether this Game Object participates in the WebGL lighting system.\r\n * When `true`, the object will respond to dynamic lights added via the Lights plugin,\r\n * using normal maps to calculate per-pixel diffuse lighting.\r\n *\r\n * This flag is used to select the appropriate WebGL shader at render time.\r\n *\r\n * @name Phaser.GameObjects.Components.Lighting#lighting\r\n * @type {boolean}\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @default false\r\n * @readonly\r\n */", "meta": { "filename": "Lighting.js", "lineno": 24, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Controls whether this Game Object participates in the WebGL lighting system.\rWhen `true`, the object will respond to dynamic lights added via the Lights plugin,\rusing normal maps to calculate per-pixel diffuse lighting.\r\rThis flag is used to select the appropriate WebGL shader at render time.", "name": "lighting", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "defaultvalue": "false", "readonly": true, "memberof": "Phaser.GameObjects.Components.Lighting", "longname": "Phaser.GameObjects.Components.Lighting#lighting", "scope": "instance", "kind": "member", "___id": "T000002R009104", "___s": true }, { "comment": "/**\r\n * Configuration object controlling self-shadowing for this Game Object.\r\n * Self-shadowing causes surfaces to cast contact shadows on themselves based on\r\n * the normal map, giving the appearance of depth. It is only active when\r\n * `lighting` is also enabled.\r\n *\r\n * If `enabled` is `null`, the value from the game config option `render.selfShadow`\r\n * is used instead.\r\n *\r\n * This object is used to select and configure the appropriate WebGL shader at render time.\r\n *\r\n * @name Phaser.GameObjects.Components.Lighting#selfShadow\r\n * @type {{ enabled: boolean, penumbra: number, diffuseFlatThreshold: number }}\r\n * @webglOnly\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Lighting.js", "lineno": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Configuration object controlling self-shadowing for this Game Object.\rSelf-shadowing causes surfaces to cast contact shadows on themselves based on\rthe normal map, giving the appearance of depth. It is only active when\r`lighting` is also enabled.\r\rIf `enabled` is `null`, the value from the game config option `render.selfShadow`\ris used instead.\r\rThis object is used to select and configure the appropriate WebGL shader at render time.", "name": "selfShadow", "type": { "names": [ "Object" ], "parsedType": { "type": "RecordType", "fields": [ { "type": "FieldType", "key": { "type": "NameExpression", "name": "enabled" }, "value": { "type": "NameExpression", "name": "boolean" } }, { "type": "FieldType", "key": { "type": "NameExpression", "name": "penumbra" }, "value": { "type": "NameExpression", "name": "number" } }, { "type": "FieldType", "key": { "type": "NameExpression", "name": "diffuseFlatThreshold" }, "value": { "type": "NameExpression", "name": "number" } } ] } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "memberof": "Phaser.GameObjects.Components.Lighting", "longname": "Phaser.GameObjects.Components.Lighting#selfShadow", "scope": "instance", "kind": "member", "___id": "T000002R009106", "___s": true }, { "comment": "/**\r\n * Enables or disables WebGL-based per-pixel lighting for this Game Object.\r\n * When enabled, the object will respond to dynamic lights added to the scene\r\n * via the Lights plugin, using a normal map for lighting calculations.\r\n * Disabling lighting restores the standard unlit rendering path.\r\n *\r\n * @method Phaser.GameObjects.Components.Lighting#setLighting\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @param {boolean} enable - `true` to use lighting, or `false` to disable it.\r\n * @return {this} This GameObject instance.\r\n */", "meta": { "filename": "Lighting.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Enables or disables WebGL-based per-pixel lighting for this Game Object.\rWhen enabled, the object will respond to dynamic lights added to the scene\rvia the Lights plugin, using a normal map for lighting calculations.\rDisabling lighting restores the standard unlit rendering path.", "kind": "function", "name": "setLighting", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` to use lighting, or `false` to disable it.", "name": "enable" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject instance." } ], "memberof": "Phaser.GameObjects.Components.Lighting", "longname": "Phaser.GameObjects.Components.Lighting#setLighting", "scope": "instance", "___id": "T000002R009111", "___s": true }, { "comment": "/**\r\n * Configures the self-shadowing properties of this Game Object.\r\n * Self-shadowing uses the normal map to cast contact shadows on the surface itself,\r\n * giving the impression of depth and raised detail. It is only active when\r\n * `lighting` is also enabled on this Game Object.\r\n *\r\n * Parameters that are `undefined` are left unchanged, allowing partial updates.\r\n *\r\n * @method Phaser.GameObjects.Components.Lighting#setSelfShadow\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @param {?boolean} [enabled] - `true` to use self-shadowing, `false` to disable it, `null` to use the game default from `config.render.selfShadow`, or `undefined` to keep the setting.\r\n * @param {number} [penumbra] - The penumbra value for the shadow. Lower is sharper but more jagged. Default is 0.5.\r\n * @param {number} [diffuseFlatThreshold] - The texture brightness threshold at which the diffuse lighting will be considered flat. Range is 0-1. Default is 1/3.\r\n * @return {this} This GameObject instance.\r\n */", "meta": { "filename": "Lighting.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Configures the self-shadowing properties of this Game Object.\rSelf-shadowing uses the normal map to cast contact shadows on the surface itself,\rgiving the impression of depth and raised detail. It is only active when\r`lighting` is also enabled on this Game Object.\r\rParameters that are `undefined` are left unchanged, allowing partial updates.", "kind": "function", "name": "setSelfShadow", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "optional": true, "nullable": true, "description": "`true` to use self-shadowing, `false` to disable it, `null` to use the game default from `config.render.selfShadow`, or `undefined` to keep the setting.", "name": "enabled" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The penumbra value for the shadow. Lower is sharper but more jagged. Default is 0.5.", "name": "penumbra" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The texture brightness threshold at which the diffuse lighting will be considered flat. Range is 0-1. Default is 1/3.", "name": "diffuseFlatThreshold" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject instance." } ], "memberof": "Phaser.GameObjects.Components.Lighting", "longname": "Phaser.GameObjects.Components.Lighting#setSelfShadow", "scope": "instance", "___id": "T000002R009114", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting, clearing, and creating masks on a Game Object.\r\n *\r\n * A mask clips the rendered output of a Game Object to the shape defined by a Graphics\r\n * or Shape Game Object. Only pixels that fall within the mask geometry are drawn to the screen.\r\n * Masks have no effect on physics or input detection; they are purely a visual rendering tool.\r\n *\r\n * This component only works under the Canvas Renderer.\r\n * For WebGL, see {@link Phaser.GameObjects.Components.FilterList#addMask}.\r\n *\r\n * @namespace Phaser.GameObjects.Components.Mask\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for setting, clearing, and creating masks on a Game Object.\r\rA mask clips the rendered output of a Game Object to the shape defined by a Graphics\ror Shape Game Object. Only pixels that fall within the mask geometry are drawn to the screen.\rMasks have no effect on physics or input detection; they are purely a visual rendering tool.\r\rThis component only works under the Canvas Renderer.\rFor WebGL, see {@link Phaser.GameObjects.Components.FilterList#addMask}.", "kind": "namespace", "name": "Mask", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Mask", "scope": "static", "___id": "T000002R009123", "___s": true }, { "comment": "/**\r\n * The Mask this Game Object is using during render, or `null` if no mask has been set.\r\n *\r\n * @name Phaser.GameObjects.Components.Mask#mask\r\n * @type {Phaser.Display.Masks.GeometryMask}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Mask.js", "lineno": 26, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Mask this Game Object is using during render, or `null` if no mask has been set.", "name": "mask", "type": { "names": [ "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Mask", "longname": "Phaser.GameObjects.Components.Mask#mask", "scope": "instance", "kind": "member", "___id": "T000002R009125", "___s": true }, { "comment": "/**\r\n * Sets the mask that this Game Object will use to render with.\r\n *\r\n * The mask must have been previously created and must be a GeometryMask.\r\n * This only works in the Canvas Renderer.\r\n * In WebGL, use a Mask filter instead (see {@link Phaser.GameObjects.Components.FilterList#addMask}).\r\n *\r\n * If a mask is already set on this Game Object it will be immediately replaced.\r\n *\r\n * Masks are positioned in global space and are not relative to the Game Object to which they\r\n * are applied. The reason for this is that multiple Game Objects can all share the same mask.\r\n *\r\n * Masks have no impact on physics or input detection. They are purely a rendering component\r\n * that allows you to limit what is visible during the render pass.\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#setMask\r\n * @since 3.6.2\r\n *\r\n * @param {Phaser.Display.Masks.GeometryMask} mask - The mask this Game Object will use when rendering.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mask.js", "lineno": 35, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the mask that this Game Object will use to render with.\r\rThe mask must have been previously created and must be a GeometryMask.\rThis only works in the Canvas Renderer.\rIn WebGL, use a Mask filter instead (see {@link Phaser.GameObjects.Components.FilterList#addMask}).\r\rIf a mask is already set on this Game Object it will be immediately replaced.\r\rMasks are positioned in global space and are not relative to the Game Object to which they\rare applied. The reason for this is that multiple Game Objects can all share the same mask.\r\rMasks have no impact on physics or input detection. They are purely a rendering component\rthat 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.GeometryMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } }, "description": "The mask this Game Object will use when rendering.", "name": "mask" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Mask", "longname": "Phaser.GameObjects.Components.Mask#setMask", "scope": "instance", "___id": "T000002R009127", "___s": true }, { "comment": "/**\r\n * Clears the mask that this Game Object was using.\r\n *\r\n * This only works in the Canvas Renderer.\r\n * In WebGL, use a Mask filter instead (see {@link Phaser.GameObjects.Components.FilterList#addMask}).\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#clearMask\r\n * @since 3.6.2\r\n *\r\n * @param {boolean} [destroyMask=false] - Destroy the mask before clearing it?\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Mask.js", "lineno": 70, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Clears the mask that this Game Object was using.\r\rThis only works in the Canvas Renderer.\rIn WebGL, use a Mask filter instead (see {@link Phaser.GameObjects.Components.FilterList#addMask}).", "kind": "function", "name": "clearMask", "since": "3.6.2", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Destroy the mask before clearing it?", "name": "destroyMask" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Mask", "longname": "Phaser.GameObjects.Components.Mask#clearMask", "scope": "instance", "___id": "T000002R009130", "___s": true }, { "comment": "/**\r\n * Creates and returns a Geometry Mask. This mask can be used by any Game Object,\r\n * including this one.\r\n *\r\n * To create the mask you need to pass in a reference to a Graphics Game Object.\r\n *\r\n * If you do not provide a graphics object, and this Game Object is an instance\r\n * of a Graphics object, then it will use itself to create the mask.\r\n *\r\n * This means you can call this method to create a Geometry Mask from any Graphics Game Object.\r\n *\r\n * This only works in the Canvas Renderer.\r\n * In WebGL, use a Mask filter instead (see {@link Phaser.GameObjects.Components.FilterList#addMask}).\r\n *\r\n * @method Phaser.GameObjects.Components.Mask#createGeometryMask\r\n * @since 3.6.2\r\n *\r\n * @generic {Phaser.GameObjects.Graphics} G\r\n * @generic {Phaser.GameObjects.Shape} S\r\n * @genericUse {(G|S)} [graphics]\r\n *\r\n * @param {Phaser.GameObjects.Graphics|Phaser.GameObjects.Shape} [graphics] - A Graphics Game Object, or any kind of Shape Game Object. The geometry within it will be used as the mask.\r\n *\r\n * @return {Phaser.Display.Masks.GeometryMask} This Geometry Mask that was created.\r\n */", "meta": { "filename": "Mask.js", "lineno": 97, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Creates and returns a Geometry Mask. This mask can be used by any Game Object,\rincluding this one.\r\rTo create the mask you need to pass in a reference to a Graphics Game Object.\r\rIf you do not provide a graphics object, and this Game Object is an instance\rof a Graphics object, then it will use itself to create the mask.\r\rThis means you can call this method to create a Geometry Mask from any Graphics Game Object.\r\rThis only works in the Canvas Renderer.\rIn WebGL, use a Mask filter instead (see {@link Phaser.GameObjects.Components.FilterList#addMask}).", "kind": "function", "name": "createGeometryMask", "since": "3.6.2", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.Graphics} G", "value": "{Phaser.GameObjects.Graphics} G" }, { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.Shape} S", "value": "{Phaser.GameObjects.Shape} S" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(G|S)} [graphics]", "value": "{(G|S)} [graphics]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.Graphics", "Phaser.GameObjects.Shape" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Shape" } ] } }, "optional": true, "description": "A Graphics Game Object, or any kind of Shape Game Object. The geometry within it will be used as the mask.", "name": "graphics" } ], "returns": [ { "type": { "names": [ "Phaser.Display.Masks.GeometryMask" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Masks.GeometryMask" } }, "description": "This Geometry Mask that was created." } ], "memberof": "Phaser.GameObjects.Components.Mask", "longname": "Phaser.GameObjects.Components.Mask#createGeometryMask", "scope": "instance", "___id": "T000002R009134", "___s": true }, { "comment": "/**\r\n * Provides methods used for getting and setting the origin of a Game Object.\r\n * Values are normalized, given in the range 0 to 1.\r\n * Display values contain the calculated pixel values.\r\n * Should be applied as a mixin and not used directly.\r\n *\r\n * @namespace Phaser.GameObjects.Components.Origin\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for getting and setting the origin of a Game Object.\rValues are normalized, given in the range 0 to 1.\rDisplay values contain the calculated pixel values.\rShould 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", "___id": "T000002R009138", "___s": true }, { "comment": "/**\r\n * The horizontal origin of this Game Object.\r\n * The origin maps the relationship between the size and position of the Game Object.\r\n * The default value is 0.5, meaning all Game Objects are positioned based on their center.\r\n * Setting the value to 0 means the position now relates to the left of the Game Object.\r\n * Set this value with `setOrigin()`.\r\n *\r\n * @name Phaser.GameObjects.Components.Origin#originX\r\n * @type {number}\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The horizontal origin of this Game Object.\rThe origin maps the relationship between the size and position of the Game Object.\rThe default value is 0.5, meaning all Game Objects are positioned based on their center.\rSetting the value to 0 means the position now relates to the left of the Game Object.\rSet this value with `setOrigin()`.", "name": "originX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Origin", "longname": "Phaser.GameObjects.Components.Origin#originX", "scope": "instance", "kind": "member", "___id": "T000002R009142", "___s": true }, { "comment": "/**\r\n * The vertical origin of this Game Object.\r\n * The origin maps the relationship between the size and position of the Game Object.\r\n * The default value is 0.5, meaning all Game Objects are positioned based on their center.\r\n * Setting the value to 0 means the position now relates to the top of the Game Object.\r\n * Set this value with `setOrigin()`.\r\n *\r\n * @name Phaser.GameObjects.Components.Origin#originY\r\n * @type {number}\r\n * @default 0.5\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 44, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The vertical origin of this Game Object.\rThe origin maps the relationship between the size and position of the Game Object.\rThe default value is 0.5, meaning all Game Objects are positioned based on their center.\rSetting the value to 0 means the position now relates to the top of the Game Object.\rSet this value with `setOrigin()`.", "name": "originY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.5", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Origin", "longname": "Phaser.GameObjects.Components.Origin#originY", "scope": "instance", "kind": "member", "___id": "T000002R009144", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Game Object, expressed in pixels.\r\n * Unlike `originX`, which is a normalized value between 0 and 1, the display origin is the\r\n * calculated pixel offset derived from the Game Object's width multiplied by its `originX` value.\r\n * Setting this property updates `originX` accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.Origin#displayOriginX\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The horizontal display origin of this Game Object, expressed in pixels.\rUnlike `originX`, which is a normalized value between 0 and 1, the display origin is the\rcalculated pixel offset derived from the Game Object's width multiplied by its `originX` value.\rSetting this property updates `originX` accordingly.", "name": "displayOriginX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Origin", "longname": "Phaser.GameObjects.Components.Origin#displayOriginX", "scope": "instance", "kind": "member", "___id": "T000002R009148", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Game Object, expressed in pixels.\r\n * Unlike `originY`, which is a normalized value between 0 and 1, the display origin is the\r\n * calculated pixel offset derived from the Game Object's height multiplied by its `originY` value.\r\n * Setting this property updates `originY` accordingly.\r\n *\r\n * @name Phaser.GameObjects.Components.Origin#displayOriginY\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Origin.js", "lineno": 87, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The vertical display origin of this Game Object, expressed in pixels.\rUnlike `originY`, which is a normalized value between 0 and 1, the display origin is the\rcalculated pixel offset derived from the Game Object's height multiplied by its `originY` value.\rSetting this property updates `originY` accordingly.", "name": "displayOriginY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Origin", "longname": "Phaser.GameObjects.Components.Origin#displayOriginY", "scope": "instance", "kind": "member", "___id": "T000002R009154", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object.\r\n *\r\n * The values are given in the range 0 to 1.\r\n *\r\n * @method Phaser.GameObjects.Components.Origin#setOrigin\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0.5] - The horizontal origin value.\r\n * @param {number} [y=x] - The vertical origin value. If not defined it will be set to the value of `x`.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Origin.js", "lineno": 112, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "kind": "function", "name": "setOrigin", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The horizontal origin value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Origin", "longname": "Phaser.GameObjects.Components.Origin#setOrigin", "scope": "instance", "___id": "T000002R009160", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object based on the Pivot values in its Frame.\r\n * If the Frame has a custom pivot point defined, the origin is set to match it.\r\n * If the Frame does not have a custom pivot, this method falls back to `setOrigin()`,\r\n * resetting the origin to the default value of 0.5 for both axes.\r\n *\r\n * @method Phaser.GameObjects.Components.Origin#setOriginFromFrame\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Origin.js", "lineno": 136, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the origin of this Game Object based on the Pivot values in its Frame.\rIf the Frame has a custom pivot point defined, the origin is set to match it.\rIf the Frame does not have a custom pivot, this method falls back to `setOrigin()`,\rresetting the origin to the default value of 0.5 for both axes.", "kind": "function", "name": "setOriginFromFrame", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Origin", "longname": "Phaser.GameObjects.Components.Origin#setOriginFromFrame", "scope": "instance", "___id": "T000002R009166", "___s": true }, { "comment": "/**\r\n * Sets the display origin of this Game Object.\r\n * The difference between this and setting the origin is that you can use pixel values for setting the display origin.\r\n *\r\n * @method Phaser.GameObjects.Components.Origin#setDisplayOrigin\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The horizontal display origin value.\r\n * @param {number} [y=x] - The vertical display origin value. If not defined it will be set to the value of `x`.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Origin.js", "lineno": 162, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the display origin of this Game Object.\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal display origin value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Origin", "longname": "Phaser.GameObjects.Components.Origin#setDisplayOrigin", "scope": "instance", "___id": "T000002R009170", "___s": true }, { "comment": "/**\r\n * Updates the Display Origin cached values internally stored on this Game Object.\r\n * You don't usually call this directly, but it is exposed for edge-cases where you may.\r\n *\r\n * @method Phaser.GameObjects.Components.Origin#updateDisplayOrigin\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Origin.js", "lineno": 185, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Updates the Display Origin cached values internally stored on this Game Object.\rYou 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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Origin", "longname": "Phaser.GameObjects.Components.Origin#updateDisplayOrigin", "scope": "instance", "___id": "T000002R009176", "___s": true }, { "comment": "/**\r\n * Provides methods for making a Game Object follow a {@link Phaser.Curves.Path} at a configurable speed.\r\n * The follower uses an internal Tween to animate progress along the path, and can optionally rotate\r\n * the Game Object to face the direction of travel. This component is mixed in to Game Objects such as\r\n * {@link Phaser.GameObjects.PathFollower} and should be applied as a mixin rather than used directly.\r\n *\r\n * @namespace Phaser.GameObjects.Components.PathFollower\r\n * @since 3.17.0\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods for making a Game Object follow a {@link Phaser.Curves.Path} at a configurable speed.\rThe follower uses an internal Tween to animate progress along the path, and can optionally rotate\rthe Game Object to face the direction of travel. This component is mixed in to Game Objects such as\r{@link Phaser.GameObjects.PathFollower} and should be applied as a mixin rather than used directly.", "kind": "namespace", "name": "PathFollower", "since": "3.17.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.PathFollower", "scope": "static", "___id": "T000002R009186", "___s": true }, { "comment": "/**\r\n * The Path this PathFollower is following. It can only follow one Path at a time.\r\n *\r\n * @name Phaser.GameObjects.Components.PathFollower#path\r\n * @type {Phaser.Curves.Path}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 25, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Path this PathFollower is following. It can only follow one Path at a time.", "name": "path", "type": { "names": [ "Phaser.Curves.Path" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Curves.Path" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.PathFollower", "longname": "Phaser.GameObjects.Components.PathFollower#path", "scope": "instance", "kind": "member", "___id": "T000002R009188", "___s": true }, { "comment": "/**\r\n * Should the PathFollower automatically rotate to point in the direction of the Path?\r\n *\r\n * @name Phaser.GameObjects.Components.PathFollower#rotateToPath\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 34, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Should the PathFollower automatically rotate to point in the direction of the Path?", "name": "rotateToPath", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.PathFollower", "longname": "Phaser.GameObjects.Components.PathFollower#rotateToPath", "scope": "instance", "kind": "member", "___id": "T000002R009190", "___s": true }, { "comment": "/**\r\n * If the PathFollower is rotating to match the Path (@see Phaser.GameObjects.Components.PathFollower#rotateToPath)\r\n * this value is added to the rotation value, in degrees. This allows you to rotate objects to a path but control\r\n * the angle of the rotation as well.\r\n *\r\n * @name Phaser.GameObjects.Components.PathFollower#pathRotationOffset\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 44, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "If the PathFollower is rotating to match the Path (@see Phaser.GameObjects.Components.PathFollower#rotateToPath)\rthis value is added to the rotation value, in degrees. This allows you to rotate objects to a path but control\rthe angle of the rotation as well.", "name": "pathRotationOffset", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.PathFollower", "longname": "Phaser.GameObjects.Components.PathFollower#pathRotationOffset", "scope": "instance", "kind": "member", "___id": "T000002R009192", "___s": true }, { "comment": "/**\r\n * An additional vector to add to the PathFollowers position, allowing you to offset it from the\r\n * Path coordinates.\r\n *\r\n * @name Phaser.GameObjects.PathFollower#pathOffset\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "An additional vector to add to the PathFollowers position, allowing you to offset it from the\rPath coordinates.", "name": "pathOffset", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "longname": "Phaser.GameObjects.PathFollower#pathOffset", "scope": "instance", "kind": "member", "___id": "T000002R009194", "___s": true }, { "comment": "/**\r\n * A Vector2 that stores the current point of the path the follower is on.\r\n *\r\n * @name Phaser.GameObjects.PathFollower#pathVector\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 66, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "A Vector2 that stores the current point of the path the follower is on.", "name": "pathVector", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "longname": "Phaser.GameObjects.PathFollower#pathVector", "scope": "instance", "kind": "member", "___id": "T000002R009196", "___s": true }, { "comment": "/**\r\n * The distance the follower has traveled from the previous point to the current one, at the last update.\r\n *\r\n * @name Phaser.GameObjects.PathFollower#pathDelta\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 75, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The distance the follower has traveled from the previous point to the current one, at the last update.", "name": "pathDelta", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.23.0", "memberof": "Phaser.GameObjects.PathFollower", "longname": "Phaser.GameObjects.PathFollower#pathDelta", "scope": "instance", "kind": "member", "___id": "T000002R009198", "___s": true }, { "comment": "/**\r\n * The Tween used for following the Path.\r\n *\r\n * @name Phaser.GameObjects.PathFollower#pathTween\r\n * @type {Phaser.Tweens.Tween}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 84, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Tween used for following the Path.", "name": "pathTween", "type": { "names": [ "Phaser.Tweens.Tween" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Tweens.Tween" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "longname": "Phaser.GameObjects.PathFollower#pathTween", "scope": "instance", "kind": "member", "___id": "T000002R009200", "___s": true }, { "comment": "/**\r\n * Settings for the PathFollower.\r\n *\r\n * @name Phaser.GameObjects.PathFollower#pathConfig\r\n * @type {?Phaser.Types.GameObjects.PathFollower.PathConfig}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 93, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Settings for the PathFollower.", "name": "pathConfig", "type": { "names": [ "Phaser.Types.GameObjects.PathFollower.PathConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.PathFollower.PathConfig", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.PathFollower", "longname": "Phaser.GameObjects.PathFollower#pathConfig", "scope": "instance", "kind": "member", "___id": "T000002R009202", "___s": true }, { "comment": "/**\r\n * Set the Path that this PathFollower should follow.\r\n *\r\n * Optionally accepts {@link Phaser.Types.GameObjects.PathFollower.PathConfig} settings.\r\n *\r\n * @method Phaser.GameObjects.Components.PathFollower#setPath\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Curves.Path} path - The Path this PathFollower is following. It can only follow one Path at a time.\r\n * @param {(number|Phaser.Types.GameObjects.PathFollower.PathConfig|Phaser.Types.Tweens.NumberTweenBuilderConfig)} [config] - Settings for the PathFollower.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Set the Path that this PathFollower should follow.\r\rOptionally accepts {@link Phaser.Types.GameObjects.PathFollower.PathConfig} settings.", "kind": "function", "name": "setPath", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Curves.Path" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.PathFollower.PathConfig" }, { "type": "NameExpression", "name": "Phaser.Types.Tweens.NumberTweenBuilderConfig" } ] } }, "optional": true, "description": "Settings for the PathFollower.", "name": "config" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Components.PathFollower", "longname": "Phaser.GameObjects.Components.PathFollower#setPath", "scope": "instance", "___id": "T000002R009206", "___s": true }, { "comment": "/**\r\n * Set whether the PathFollower should automatically rotate to point in the direction of the Path.\r\n *\r\n * @method Phaser.GameObjects.Components.PathFollower#setRotateToPath\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - Whether the PathFollower should automatically rotate to point in the direction of the Path.\r\n * @param {number} [offset=0] - Rotation offset in degrees.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 147, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the PathFollower should automatically rotate to point in the direction of the Path.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Rotation offset in degrees.", "name": "offset" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Components.PathFollower", "longname": "Phaser.GameObjects.Components.PathFollower#setRotateToPath", "scope": "instance", "___id": "T000002R009211", "___s": true }, { "comment": "/**\r\n * Is this PathFollower actively following a Path or not?\r\n *\r\n * To be considered as `isFollowing` it must be currently moving on a Path, and not paused.\r\n *\r\n * @method Phaser.GameObjects.Components.PathFollower#isFollowing\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if this PathFollower is actively following a Path, otherwise `false`.\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 169, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Is this PathFollower actively following a Path or not?\r\rTo 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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if this PathFollower is actively following a Path, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Components.PathFollower", "longname": "Phaser.GameObjects.Components.PathFollower#isFollowing", "scope": "instance", "___id": "T000002R009216", "___s": true }, { "comment": "/**\r\n * Starts this PathFollower following its given Path.\r\n *\r\n * @method Phaser.GameObjects.Components.PathFollower#startFollow\r\n * @since 3.3.0\r\n *\r\n * @param {(number|Phaser.Types.GameObjects.PathFollower.PathConfig|Phaser.Types.Tweens.NumberTweenBuilderConfig)} [config={}] - The duration of the follow, or a PathFollower config object.\r\n * @param {number} [startAt=0] - Optional start position of the follow, between 0 and 1.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 186, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.PathFollower.PathConfig" }, { "type": "NameExpression", "name": "Phaser.Types.Tweens.NumberTweenBuilderConfig" } ] } }, "optional": true, "defaultvalue": "{}", "description": "The duration of the follow, or a PathFollower config object.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optional start position of the follow, between 0 and 1.", "name": "startAt" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Components.PathFollower", "longname": "Phaser.GameObjects.Components.PathFollower#startFollow", "scope": "instance", "___id": "T000002R009219", "___s": true }, { "comment": "/**\r\n * Pauses this PathFollower. It will still continue to render, but it will remain motionless at the\r\n * point on the Path at which you paused it.\r\n *\r\n * @method Phaser.GameObjects.Components.PathFollower#pauseFollow\r\n * @since 3.3.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Pauses this PathFollower. It will still continue to render, but it will remain motionless at the\rpoint on the Path at which you paused it.", "kind": "function", "name": "pauseFollow", "since": "3.3.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Components.PathFollower", "longname": "Phaser.GameObjects.Components.PathFollower#pauseFollow", "scope": "instance", "___id": "T000002R009251", "___s": true }, { "comment": "/**\r\n * Resumes a previously paused PathFollower.\r\n *\r\n * If the PathFollower was not paused this has no effect.\r\n *\r\n * @method Phaser.GameObjects.Components.PathFollower#resumeFollow\r\n * @since 3.3.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 308, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Resumes a previously paused PathFollower.\r\rIf the PathFollower was not paused this has no effect.", "kind": "function", "name": "resumeFollow", "since": "3.3.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Components.PathFollower", "longname": "Phaser.GameObjects.Components.PathFollower#resumeFollow", "scope": "instance", "___id": "T000002R009254", "___s": true }, { "comment": "/**\r\n * Stops this PathFollower from following the path any longer.\r\n *\r\n * This will invoke any 'stop' conditions that may exist on the Path, or for the follower.\r\n *\r\n * @method Phaser.GameObjects.Components.PathFollower#stopFollow\r\n * @since 3.3.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Stops this PathFollower from following the path any longer.\r\rThis 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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Components.PathFollower", "longname": "Phaser.GameObjects.Components.PathFollower#stopFollow", "scope": "instance", "___id": "T000002R009257", "___s": true }, { "comment": "/**\r\n * Internal update handler that advances this PathFollower along the path.\r\n *\r\n * Called automatically by the Scene step, should not typically be called directly.\r\n *\r\n * @method Phaser.GameObjects.Components.PathFollower#pathUpdate\r\n * @since 3.17.0\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 352, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Internal update handler that advances this PathFollower along the path.\r\rCalled 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", "___id": "T000002R009260", "___s": true }, { "comment": "/**\r\n * Provides methods for configuring WebGL render nodes on a Game Object. Render nodes are modular units responsible for different phases of the rendering pipeline (submitting draw calls, transforming vertices, handling textures). Each Game Object has a set of default render nodes, but you can override them with custom nodes for advanced rendering effects. This component is WebGL only.\r\n *\r\n * @namespace Phaser.GameObjects.Components.RenderNodes\r\n * @webglOnly\r\n * @since 4.0.0\r\n */", "meta": { "filename": "RenderNodes.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods for configuring WebGL render nodes on a Game Object. Render nodes are modular units responsible for different phases of the rendering pipeline (submitting draw calls, transforming vertices, handling textures). Each Game Object has a set of default render nodes, but you can override them with custom nodes for advanced rendering effects. This component is WebGL only.", "kind": "namespace", "name": "RenderNodes", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.RenderNodes", "scope": "static", "___id": "T000002R009274", "___s": true }, { "comment": "/**\r\n * Customized WebGL render nodes of this Game Object.\r\n * RenderNodes are responsible for managing the rendering process of this Game Object.\r\n * A default set of RenderNodes is coded into the engine,\r\n * but the renderer will check this object first to see if a custom node has been set.\r\n *\r\n * @name Phaser.GameObjects.Components.RenderNodes#customRenderNodes\r\n * @type {object}\r\n * @webglOnly\r\n * @since 4.0.0\r\n */", "meta": { "filename": "RenderNodes.js", "lineno": 17, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Customized WebGL render nodes of this Game Object.\rRenderNodes are responsible for managing the rendering process of this Game Object.\rA default set of RenderNodes is coded into the engine,\rbut the renderer will check this object first to see if a custom node has been set.", "name": "customRenderNodes", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "memberof": "Phaser.GameObjects.Components.RenderNodes", "longname": "Phaser.GameObjects.Components.RenderNodes#customRenderNodes", "scope": "instance", "kind": "member", "___id": "T000002R009276", "___s": true }, { "comment": "/**\r\n * The default RenderNodes for this Game Object.\r\n * RenderNodes are responsible for managing the rendering process of this Game Object.\r\n * These are the nodes that are used if no custom ones are set.\r\n *\r\n * RenderNodes are identified by a unique key for their role.\r\n *\r\n * Common role keys include:\r\n *\r\n * - 'Submitter': responsible for running other node roles for each element.\r\n * - 'Transformer': responsible for providing vertex coordinates for an element.\r\n * - 'Texturer': responsible for handling textures for an element.\r\n *\r\n * @name Phaser.GameObjects.Components.RenderNodes#defaultRenderNodes\r\n * @type {object}\r\n * @webglOnly\r\n * @since 4.0.0\r\n */", "meta": { "filename": "RenderNodes.js", "lineno": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The default RenderNodes for this Game Object.\rRenderNodes are responsible for managing the rendering process of this Game Object.\rThese are the nodes that are used if no custom ones are set.\r\rRenderNodes are identified by a unique key for their role.\r\rCommon role keys include:\r\r- 'Submitter': responsible for running other node roles for each element.\r- 'Transformer': responsible for providing vertex coordinates for an element.\r- 'Texturer': responsible for handling textures for an element.", "name": "defaultRenderNodes", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "memberof": "Phaser.GameObjects.Components.RenderNodes", "longname": "Phaser.GameObjects.Components.RenderNodes#defaultRenderNodes", "scope": "instance", "kind": "member", "___id": "T000002R009278", "___s": true }, { "comment": "/**\r\n * An object to store render node specific data in, to be read by the render nodes this Game Object uses.\r\n *\r\n * Render nodes store their data under their own name, not their role.\r\n *\r\n * @name Phaser.GameObjects.Components.RenderNodes#renderNodeData\r\n * @type {object}\r\n * @webglOnly\r\n * @since 4.0.0\r\n */", "meta": { "filename": "RenderNodes.js", "lineno": 50, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "An object to store render node specific data in, to be read by the render nodes this Game Object uses.\r\rRender nodes store their data under their own name, not their role.", "name": "renderNodeData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "memberof": "Phaser.GameObjects.Components.RenderNodes", "longname": "Phaser.GameObjects.Components.RenderNodes#renderNodeData", "scope": "instance", "kind": "member", "___id": "T000002R009280", "___s": true }, { "comment": "/**\r\n * Initializes the render nodes for this Game Object.\r\n *\r\n * This method is called when the Game Object is added to the Scene.\r\n * It is responsible for setting up the default render nodes\r\n * this Game Object will use.\r\n *\r\n * @method Phaser.GameObjects.Components.RenderNodes#initRenderNodes\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @param {Map} defaultNodes - The default render nodes to set for this Game Object.\r\n */", "meta": { "filename": "RenderNodes.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Initializes the render nodes for this Game Object.\r\rThis method is called when the Game Object is added to the Scene.\rIt is responsible for setting up the default render nodes\rthis Game Object will use.", "kind": "function", "name": "initRenderNodes", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "Map." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Map" }, "applications": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The default render nodes to set for this Game Object.", "name": "defaultNodes" } ], "memberof": "Phaser.GameObjects.Components.RenderNodes", "longname": "Phaser.GameObjects.Components.RenderNodes#initRenderNodes", "scope": "instance", "___id": "T000002R009282", "___s": true }, { "comment": "/**\r\n * Sets the RenderNode for a given role.\r\n *\r\n * Also sets the relevant render node data object, if specified.\r\n *\r\n * If the node cannot be set, no changes are made.\r\n *\r\n * @method Phaser.GameObjects.Components.RenderNodes#setRenderNodeRole\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @param {string} key - The key of the role to set the render node for.\r\n * @param {string|Phaser.Renderer.WebGL.RenderNodes.RenderNode|null} renderNode - The render node to set on this Game Object. Either a string, or a RenderNode instance. If `null`, the render node is removed, along with its data.\r\n * @param {object} [renderNodeData] - An object to store render node specific data in, to be read by the render nodes this Game Object uses.\r\n * @param {boolean} [copyData=false] - Should the data be copied from the `renderNodeData` object?\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "RenderNodes.js", "lineno": 101, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the RenderNode for a given role.\r\rAlso sets the relevant render node data object, if specified.\r\rIf the node cannot be set, no changes are made.", "kind": "function", "name": "setRenderNodeRole", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the role to set the render node for.", "name": "key" }, { "type": { "names": [ "string", "Phaser.Renderer.WebGL.RenderNodes.RenderNode", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderNodes.RenderNode" }, { "type": "NullLiteral" } ] } }, "description": "The render node to set on this Game Object. Either a string, or a RenderNode instance. If `null`, the render node is removed, along with its data.", "name": "renderNode" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An object to store render node specific data in, to be read by the render nodes this Game Object uses.", "name": "renderNodeData" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the data be copied from the `renderNodeData` object?", "name": "copyData" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.RenderNodes", "longname": "Phaser.GameObjects.Components.RenderNodes#setRenderNodeRole", "scope": "instance", "___id": "T000002R009291", "___s": true }, { "comment": "/**\r\n * Sets or removes a property in the data object for a specific render node within `renderNodeData`.\r\n *\r\n * If `key` is not set, it is created. If it is set, it is updated.\r\n *\r\n * If `value` is undefined and `key` exists, the key is removed.\r\n *\r\n * @method Phaser.GameObjects.Components.RenderNodes#setRenderNodeData\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @param {string|Phaser.Renderer.WebGL.RenderNodes.RenderNode} renderNode - The render node to set the data for. If a string, it should be the name of the render node.\r\n * @param {string} key - The key of the property to set.\r\n * @param {*} value - The value to set the property to.\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "RenderNodes.js", "lineno": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets or removes a property in the data object for a specific render node within `renderNodeData`.\r\rIf `key` is not set, it is created. If it is set, it is updated.\r\rIf `value` is undefined and `key` exists, the key is removed.", "kind": "function", "name": "setRenderNodeData", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Renderer.WebGL.RenderNodes.RenderNode" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderNodes.RenderNode" } ] } }, "description": "The render node to set the data for. If a string, it should be the name of the render node.", "name": "renderNode" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the property to set.", "name": "key" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value to set the property to.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.RenderNodes", "longname": "Phaser.GameObjects.Components.RenderNodes#setRenderNodeData", "scope": "instance", "___id": "T000002R009300", "___s": true }, { "comment": "/**\r\n * Handles render steps for a Game Object.\r\n * The render step is a point in the render process that allows you to inject your own logic.\r\n *\r\n * @namespace Phaser.GameObjects.Components.RenderSteps\r\n * @webglOnly\r\n * @since 4.0.0\r\n */", "meta": { "filename": "RenderSteps.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Handles render steps for a Game Object.\rThe render step is a point in the render process that allows you to inject your own logic.", "kind": "namespace", "name": "RenderSteps", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.RenderSteps", "scope": "static", "___id": "T000002R009307", "___s": true }, { "comment": "/**\r\n * Run a step in the render process.\r\n * This is called automatically by the Render module.\r\n *\r\n * In most cases, it just runs the `renderWebGL` function.\r\n *\r\n * When `_renderSteps` has more than one entry,\r\n * such as when Filters are enabled for this object,\r\n * it allows those processes to defer `renderWebGL`\r\n * and otherwise manage the flow of rendering.\r\n *\r\n * @method Phaser.GameObjects.Components.RenderSteps#renderWebGLStep\r\n * @webglOnly\r\n * @since 4.0.0\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - The WebGL Renderer instance to render with.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered.\r\n * @param {Phaser.Renderer.WebGL.DrawingContext} drawingContext - The current drawing context.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentMatrix] - The parent matrix of the Game Object, if it has one.\r\n * @param {number} [renderStep=0] - Which step of the rendering process should be run?\r\n * @param {Phaser.GameObjects.GameObject[]} [displayList] - The display list which is currently being rendered. If not provided, it will be created with the Game Object.\r\n * @param {number} [displayListIndex=0] - The index of the Game Object within the display list.\r\n */", "meta": { "filename": "RenderSteps.js", "lineno": 34, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Run a step in the render process.\rThis is called automatically by the Render module.\r\rIn most cases, it just runs the `renderWebGL` function.\r\rWhen `_renderSteps` has more than one entry,\rsuch as when Filters are enabled for this object,\rit allows those processes to defer `renderWebGL`\rand otherwise manage the flow of rendering.", "kind": "function", "name": "renderWebGLStep", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "The WebGL Renderer instance to render with.", "name": "renderer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Renderer.WebGL.DrawingContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.DrawingContext" } }, "description": "The current drawing context.", "name": "drawingContext" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "The parent matrix of the Game Object, if it has one.", "name": "parentMatrix" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Which step of the rendering process should be run?", "name": "renderStep" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "optional": true, "description": "The display list which is currently being rendered. If not provided, it will be created with the Game Object.", "name": "displayList" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The index of the Game Object within the display list.", "name": "displayListIndex" } ], "memberof": "Phaser.GameObjects.Components.RenderSteps", "longname": "Phaser.GameObjects.Components.RenderSteps#renderWebGLStep", "scope": "instance", "___id": "T000002R009312", "___s": true }, { "comment": "/**\r\n * Adds a render step function to this Game Object's WebGL render pipeline.\r\n *\r\n * The first render step in `_renderSteps` is run first.\r\n * It should call the next render step in the list.\r\n * This allows render steps to control the rendering flow.\r\n *\r\n * @method Phaser.GameObjects.Components.RenderSteps#addRenderStep\r\n * @param {Phaser.Types.GameObjects.RenderWebGLStep} fn - The render step function to add.\r\n * @param {number} [index] - The index in the render list to add the step to. Omit to add to the end.\r\n * \r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "RenderSteps.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Adds a render step function to this Game Object's WebGL render pipeline.\r\rThe first render step in `_renderSteps` is run first.\rIt should call the next render step in the list.\rThis allows render steps to control the rendering flow.", "kind": "function", "name": "addRenderStep", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.RenderWebGLStep" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.RenderWebGLStep" } }, "description": "The render step function to add.", "name": "fn" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The index in the render list to add the step to. Omit to add to the end.", "name": "index" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.RenderSteps", "longname": "Phaser.GameObjects.Components.RenderSteps#addRenderStep", "scope": "instance", "___id": "T000002R009319", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the Scroll Factor of a Game Object.\r\n *\r\n * @namespace Phaser.GameObjects.Components.ScrollFactor\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ScrollFactor.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for 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", "___id": "T000002R009323", "___s": true }, { "comment": "/**\r\n * The horizontal scroll factor of this Game Object.\r\n *\r\n * The scroll factor controls the influence of the movement of a Camera upon this Game Object.\r\n *\r\n * When a camera scrolls it will change the location at which this Game Object is rendered on-screen.\r\n * It does not change the Game Objects actual position values.\r\n *\r\n * A value of 1 means it will move exactly in sync with a camera.\r\n * A value of 0 means it will not move at all, even if the camera moves.\r\n * Other values control the degree to which the camera movement is mapped to this Game Object.\r\n *\r\n * Please be aware that scroll factor values other than 1 are not taken into consideration when\r\n * calculating physics collisions. Bodies always collide based on their world position, but changing\r\n * the scroll factor is a visual adjustment to where the textures are rendered, which can offset\r\n * them from physics bodies if not accounted for in your code.\r\n *\r\n * @name Phaser.GameObjects.Components.ScrollFactor#scrollFactorX\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ScrollFactor.js", "lineno": 16, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The horizontal scroll factor of this Game Object.\r\rThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\r\rWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\rIt does not change the Game Objects actual position values.\r\rA value of 1 means it will move exactly in sync with a camera.\rA value of 0 means it will not move at all, even if the camera moves.\rOther values control the degree to which the camera movement is mapped to this Game Object.\r\rPlease be aware that scroll factor values other than 1 are not taken into consideration when\rcalculating physics collisions. Bodies always collide based on their world position, but changing\rthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\rthem from physics bodies if not accounted for in your code.", "name": "scrollFactorX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.ScrollFactor", "longname": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorX", "scope": "instance", "kind": "member", "___id": "T000002R009325", "___s": true }, { "comment": "/**\r\n * The vertical scroll factor of this Game Object.\r\n *\r\n * The scroll factor controls the influence of the movement of a Camera upon this Game Object.\r\n *\r\n * When a camera scrolls it will change the location at which this Game Object is rendered on-screen.\r\n * It does not change the Game Objects actual position values.\r\n *\r\n * A value of 1 means it will move exactly in sync with a camera.\r\n * A value of 0 means it will not move at all, even if the camera moves.\r\n * Other values control the degree to which the camera movement is mapped to this Game Object.\r\n *\r\n * Please be aware that scroll factor values other than 1 are not taken into consideration when\r\n * calculating physics collisions. Bodies always collide based on their world position, but changing\r\n * the scroll factor is a visual adjustment to where the textures are rendered, which can offset\r\n * them from physics bodies if not accounted for in your code.\r\n *\r\n * @name Phaser.GameObjects.Components.ScrollFactor#scrollFactorY\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ScrollFactor.js", "lineno": 40, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The vertical scroll factor of this Game Object.\r\rThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\r\rWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\rIt does not change the Game Objects actual position values.\r\rA value of 1 means it will move exactly in sync with a camera.\rA value of 0 means it will not move at all, even if the camera moves.\rOther values control the degree to which the camera movement is mapped to this Game Object.\r\rPlease be aware that scroll factor values other than 1 are not taken into consideration when\rcalculating physics collisions. Bodies always collide based on their world position, but changing\rthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\rthem from physics bodies if not accounted for in your code.", "name": "scrollFactorY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.ScrollFactor", "longname": "Phaser.GameObjects.Components.ScrollFactor#scrollFactorY", "scope": "instance", "kind": "member", "___id": "T000002R009327", "___s": true }, { "comment": "/**\r\n * Sets the horizontal and vertical scroll factor of this Game Object. If only the `x` value is\r\n * provided, it is applied to both axes. This is a convenience method for setting `scrollFactorX`\r\n * and `scrollFactorY` in a single call.\r\n *\r\n * The scroll factor controls the influence of the movement of a Camera upon this Game Object.\r\n *\r\n * When a camera scrolls it will change the location at which this Game Object is rendered on-screen.\r\n * It does not change the Game Objects actual position values.\r\n *\r\n * A value of 1 means it will move exactly in sync with a camera.\r\n * A value of 0 means it will not move at all, even if the camera moves.\r\n * Other values control the degree to which the camera movement is mapped to this Game Object.\r\n *\r\n * Please be aware that scroll factor values other than 1 are not taken into consideration when\r\n * calculating physics collisions. Bodies always collide based on their world position, but changing\r\n * the scroll factor is a visual adjustment to where the textures are rendered, which can offset\r\n * them from physics bodies if not accounted for in your code.\r\n *\r\n * @method Phaser.GameObjects.Components.ScrollFactor#setScrollFactor\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal scroll factor of this Game Object.\r\n * @param {number} [y=x] - The vertical scroll factor of this Game Object. If not set it will use the `x` value.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "ScrollFactor.js", "lineno": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the horizontal and vertical scroll factor of this Game Object. If only the `x` value is\rprovided, it is applied to both axes. This is a convenience method for setting `scrollFactorX`\rand `scrollFactorY` in a single call.\r\rThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\r\rWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\rIt does not change the Game Objects actual position values.\r\rA value of 1 means it will move exactly in sync with a camera.\rA value of 0 means it will not move at all, even if the camera moves.\rOther values control the degree to which the camera movement is mapped to this Game Object.\r\rPlease be aware that scroll factor values other than 1 are not taken into consideration when\rcalculating physics collisions. Bodies always collide based on their world position, but changing\rthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\rthem from physics bodies if not accounted for in your code.", "kind": "function", "name": "setScrollFactor", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal scroll factor of this Game Object.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.ScrollFactor", "longname": "Phaser.GameObjects.Components.ScrollFactor#setScrollFactor", "scope": "instance", "___id": "T000002R009329", "___s": true }, { "comment": "/**\r\n * Provides methods used for getting and setting the size of a Game Object.\r\n *\r\n * This component distinguishes between two size concepts. The native size (`width` and `height`)\r\n * is the un-scaled logical size, typically derived from the Game Object's texture frame. The\r\n * display size (`displayWidth` and `displayHeight`) is the actual rendered size in pixels, which\r\n * factors in the Game Object's scale. Setting the display size adjusts the scale automatically,\r\n * while setting the native size does not affect rendering directly.\r\n *\r\n * This component is mixed into Game Objects such as Sprites and Images by the Phaser Game Object\r\n * Factory and is not intended to be used standalone.\r\n *\r\n * @namespace Phaser.GameObjects.Components.Size\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Size.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for getting and setting the size of a Game Object.\r\rThis component distinguishes between two size concepts. The native size (`width` and `height`)\ris the un-scaled logical size, typically derived from the Game Object's texture frame. The\rdisplay size (`displayWidth` and `displayHeight`) is the actual rendered size in pixels, which\rfactors in the Game Object's scale. Setting the display size adjusts the scale automatically,\rwhile setting the native size does not affect rendering directly.\r\rThis component is mixed into Game Objects such as Sprites and Images by the Phaser Game Object\rFactory and is not intended to be used standalone.", "kind": "namespace", "name": "Size", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Size", "scope": "static", "___id": "T000002R009335", "___s": true }, { "comment": "/**\r\n * The native (un-scaled) width of this Game Object.\r\n *\r\n * Changing this value will not change the size that the Game Object is rendered in-game.\r\n * For that you need to either set the scale of the Game Object (`setScale`) or use\r\n * the `displayWidth` property.\r\n *\r\n * @name Phaser.GameObjects.Components.Size#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Size.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The native (un-scaled) width of this Game Object.\r\rChanging this value will not change the size that the Game Object is rendered in-game.\rFor that you need to either set the scale of the Game Object (`setScale`) or use\rthe `displayWidth` property.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Size", "longname": "Phaser.GameObjects.Components.Size#width", "scope": "instance", "kind": "member", "___id": "T000002R009339", "___s": true }, { "comment": "/**\r\n * The native (un-scaled) height of this Game Object.\r\n *\r\n * Changing this value will not change the size that the Game Object is rendered in-game.\r\n * For that you need to either set the scale of the Game Object (`setScale`) or use\r\n * the `displayHeight` property.\r\n *\r\n * @name Phaser.GameObjects.Components.Size#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Size.js", "lineno": 49, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The native (un-scaled) height of this Game Object.\r\rChanging this value will not change the size that the Game Object is rendered in-game.\rFor that you need to either set the scale of the Game Object (`setScale`) or use\rthe `displayHeight` property.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Size", "longname": "Phaser.GameObjects.Components.Size#height", "scope": "instance", "kind": "member", "___id": "T000002R009341", "___s": true }, { "comment": "/**\r\n * The displayed width of this Game Object.\r\n *\r\n * This value takes into account the scale factor.\r\n *\r\n * Setting this value will adjust the Game Object's scale property.\r\n *\r\n * @name Phaser.GameObjects.Components.Size#displayWidth\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Size.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The displayed width of this Game Object.\r\rThis value takes into account the scale factor.\r\rSetting this value will adjust the Game Object's scale property.", "name": "displayWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Size", "longname": "Phaser.GameObjects.Components.Size#displayWidth", "scope": "instance", "kind": "member", "___id": "T000002R009343", "___s": true }, { "comment": "/**\r\n * The displayed height of this Game Object.\r\n *\r\n * This value takes into account the scale factor.\r\n *\r\n * Setting this value will adjust the Game Object's scale property.\r\n *\r\n * @name Phaser.GameObjects.Components.Size#displayHeight\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Size.js", "lineno": 87, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The displayed height of this Game Object.\r\rThis value takes into account the scale factor.\r\rSetting this value will adjust the Game Object's scale property.", "name": "displayHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Size", "longname": "Phaser.GameObjects.Components.Size#displayHeight", "scope": "instance", "kind": "member", "___id": "T000002R009348", "___s": true }, { "comment": "/**\r\n * Sets the size of this Game Object to be that of the given Frame.\r\n *\r\n * This will not change the size that the Game Object is rendered in-game.\r\n * For that you need to either set the scale of the Game Object (`setScale`) or call the\r\n * `setDisplaySize` method, which is the same thing as changing the scale but allows you\r\n * to do so by giving pixel values.\r\n *\r\n * If you have enabled this Game Object for input, changing the size will _not_ change the\r\n * size of the hit area. To do this you should adjust the `input.hitArea` object directly.\r\n *\r\n * @method Phaser.GameObjects.Components.Size#setSizeToFrame\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Textures.Frame|boolean} [frame] - The frame to base the size of this Game Object on.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 112, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the size of this Game Object to be that of the given Frame.\r\rThis will not change the size that the Game Object is rendered in-game.\rFor that you need to either set the scale of the Game Object (`setScale`) or call the\r`setDisplaySize` method, which is the same thing as changing the scale but allows you\rto do so by giving pixel values.\r\rIf you have enabled this Game Object for input, changing the size will _not_ change the\rsize 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", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Textures.Frame" }, { "type": "NameExpression", "name": "boolean" } ] } }, "optional": true, "description": "The frame to base the size of this Game Object on.", "name": "frame" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Size", "longname": "Phaser.GameObjects.Components.Size#setSizeToFrame", "scope": "instance", "___id": "T000002R009353", "___s": true }, { "comment": "/**\r\n * Sets the internal size of this Game Object, as used for frame or physics body creation.\r\n *\r\n * This will not change the size that the Game Object is rendered in-game.\r\n * For that you need to either set the scale of the Game Object (`setScale`) or call the\r\n * `setDisplaySize` method, which is the same thing as changing the scale but allows you\r\n * to do so by giving pixel values.\r\n *\r\n * If you have enabled this Game Object for input, changing the size will _not_ change the\r\n * size of the hit area. To do this you should adjust the `input.hitArea` object directly.\r\n *\r\n * @method Phaser.GameObjects.Components.Size#setSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width of this Game Object.\r\n * @param {number} height - The height of this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 148, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the internal size of this Game Object, as used for frame or physics body creation.\r\rThis will not change the size that the Game Object is rendered in-game.\rFor that you need to either set the scale of the Game Object (`setScale`) or call the\r`setDisplaySize` method, which is the same thing as changing the scale but allows you\rto do so by giving pixel values.\r\rIf you have enabled this Game Object for input, changing the size will _not_ change the\rsize 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Size", "longname": "Phaser.GameObjects.Components.Size#setSize", "scope": "instance", "___id": "T000002R009361", "___s": true }, { "comment": "/**\r\n * Sets the display (rendered) size of this Game Object in pixels.\r\n *\r\n * Unlike `setSize`, which changes the native logical dimensions without affecting rendering,\r\n * this method adjusts the `scaleX` and `scaleY` properties so that the Game Object appears\r\n * at exactly the given pixel dimensions in-game. It is equivalent to calculating and setting\r\n * the scale manually, but more convenient when you want to work in pixel values directly.\r\n *\r\n * @method Phaser.GameObjects.Components.Size#setDisplaySize\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width of this Game Object.\r\n * @param {number} height - The height of this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Size.js", "lineno": 175, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the display (rendered) size of this Game Object in pixels.\r\rUnlike `setSize`, which changes the native logical dimensions without affecting rendering,\rthis method adjusts the `scaleX` and `scaleY` properties so that the Game Object appears\rat exactly the given pixel dimensions in-game. It is equivalent to calculating and setting\rthe scale manually, but more convenient when you want to work in pixel values directly.", "kind": "function", "name": "setDisplaySize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Size", "longname": "Phaser.GameObjects.Components.Size#setDisplaySize", "scope": "instance", "___id": "T000002R009365", "___s": true }, { "comment": "/**\r\n * Provides methods used for modifying the stencil buffer.\r\n * This component is mixed in to Game Objects that can modify the stencil buffer,\r\n * such as Stencil and StencilReference.\r\n *\r\n * StencilModifier objects are assumed to draw to the stencil buffer.\r\n * The `isStencilModifier` property is checked to determine whether\r\n * extra compositing steps are necessary within other StencilModifier objects.\r\n *\r\n * @namespace Phaser.GameObjects.Components.StencilModifier\r\n * @since 4.2.0\r\n */", "meta": { "filename": "StencilModifier.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for modifying the stencil buffer.\rThis component is mixed in to Game Objects that can modify the stencil buffer,\rsuch as Stencil and StencilReference.\r\rStencilModifier objects are assumed to draw to the stencil buffer.\rThe `isStencilModifier` property is checked to determine whether\rextra compositing steps are necessary within other StencilModifier objects.", "kind": "namespace", "name": "StencilModifier", "since": "4.2.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.StencilModifier", "scope": "static", "___id": "T000002R009370", "___s": true }, { "comment": "/**\r\n * The mode to use when rendering the stencil.\r\n *\r\n * - 'addLayer' - Add a stencil layer.\r\n * - 'subtractLayer' - Subtract a stencil layer.\r\n * - 'clear' - Clear the stencil buffer.\r\n * - 'clearRegion' - Clear a region of the stencil buffer.\r\n *\r\n * @name Phaser.GameObjects.Components.StencilModifier#stencilLayerMode\r\n * @since 4.2.0\r\n * @type {Phaser.Types.GameObjects.Stencil.StencilLayerMode}\r\n * @default 'addLayer'\r\n */", "meta": { "filename": "StencilModifier.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The mode to use when rendering the stencil.\r\r- 'addLayer' - Add a stencil layer.\r- 'subtractLayer' - Subtract a stencil layer.\r- 'clear' - Clear the stencil buffer.\r- 'clearRegion' - Clear a region of the stencil buffer.", "name": "stencilLayerMode", "since": "4.2.0", "type": { "names": [ "Phaser.Types.GameObjects.Stencil.StencilLayerMode" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Stencil.StencilLayerMode" } }, "defaultvalue": "'addLayer'", "memberof": "Phaser.GameObjects.Components.StencilModifier", "longname": "Phaser.GameObjects.Components.StencilModifier#stencilLayerMode", "scope": "instance", "kind": "member", "___id": "T000002R009372", "___s": true }, { "comment": "/**\r\n * Whether to invert the stencil, using an extra draw call.\r\n *\r\n * @name Phaser.GameObjects.Components.StencilModifier#stencilInvert\r\n * @since 4.2.0\r\n * @type {boolean}\r\n * @default false\r\n */", "meta": { "filename": "StencilModifier.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Whether to invert the stencil, using an extra draw call.", "name": "stencilInvert", "since": "4.2.0", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "memberof": "Phaser.GameObjects.Components.StencilModifier", "longname": "Phaser.GameObjects.Components.StencilModifier#stencilInvert", "scope": "instance", "kind": "member", "___id": "T000002R009374", "___s": true }, { "comment": "/**\r\n * The alpha strategy to use when rendering the stencil.\r\n * This is usually set to `dither`, or the default game config setting.\r\n *\r\n * @name Phaser.GameObjects.Components.StencilModifier#stencilAlphaStrategy\r\n * @since 4.2.0\r\n * @type {Phaser.Types.Renderer.WebGL.AlphaStrategy}\r\n * @default 'dither'\r\n */", "meta": { "filename": "StencilModifier.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The alpha strategy to use when rendering the stencil.\rThis is usually set to `dither`, or the default game config setting.", "name": "stencilAlphaStrategy", "since": "4.2.0", "type": { "names": [ "Phaser.Types.Renderer.WebGL.AlphaStrategy" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.AlphaStrategy" } }, "defaultvalue": "'dither'", "memberof": "Phaser.GameObjects.Components.StencilModifier", "longname": "Phaser.GameObjects.Components.StencilModifier#stencilAlphaStrategy", "scope": "instance", "kind": "member", "___id": "T000002R009376", "___s": true }, { "comment": "/**\r\n * Whether to composite the contents of the stencil to a framebuffer.\r\n * This is necessary when the stencil contains stencils.\r\n * It requires extra draw calls to composite.\r\n * You should set this to `false` or `true` if you know the answer,\r\n * or `auto` to have Phaser automatically determine the best option.\r\n *\r\n * This will set `filtersForceComposite` to `true` during rendering.\r\n *\r\n * @name Phaser.GameObjects.Components.StencilModifier#stencilCompositeCheck\r\n * @since 4.2.0\r\n * @type {boolean|'auto'}\r\n * @default 'auto'\r\n */", "meta": { "filename": "StencilModifier.js", "lineno": 57, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Whether to composite the contents of the stencil to a framebuffer.\rThis is necessary when the stencil contains stencils.\rIt requires extra draw calls to composite.\rYou should set this to `false` or `true` if you know the answer,\ror `auto` to have Phaser automatically determine the best option.\r\rThis will set `filtersForceComposite` to `true` during rendering.", "name": "stencilCompositeCheck", "since": "4.2.0", "type": { "names": [ "boolean", "'auto'" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "'auto'" } ] } }, "defaultvalue": "'auto'", "memberof": "Phaser.GameObjects.Components.StencilModifier", "longname": "Phaser.GameObjects.Components.StencilModifier#stencilCompositeCheck", "scope": "instance", "kind": "member", "___id": "T000002R009378", "___s": true }, { "comment": "/**\r\n * The value to clear the stencil buffer to,\r\n * if the `stencilLayerMode` is `clear` or `clearRegion`.\r\n * Should be between 0 and 255, as the buffer is 8 bits.\r\n *\r\n * @name Phaser.GameObjects.Components.StencilModifier#stencilClearValue\r\n * @since 4.2.0\r\n * @type {number}\r\n * @default 0\r\n */", "meta": { "filename": "StencilModifier.js", "lineno": 73, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The value to clear the stencil buffer to,\rif the `stencilLayerMode` is `clear` or `clearRegion`.\rShould be between 0 and 255, as the buffer is 8 bits.", "name": "stencilClearValue", "since": "4.2.0", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "memberof": "Phaser.GameObjects.Components.StencilModifier", "longname": "Phaser.GameObjects.Components.StencilModifier#stencilClearValue", "scope": "instance", "kind": "member", "___id": "T000002R009380", "___s": true }, { "comment": "/**\r\n * Whether to wrap the value in the stencil buffer when it overflows or underflows\r\n * when using the `addLayer` or `subtractLayer` mode.\r\n * This is useful when defining stencils with subtraction,\r\n * and you don't want to underflow from 0 to 255.\r\n *\r\n * @name Phaser.GameObjects.Components.StencilModifier#stencilValueWrap\r\n * @since 4.2.0\r\n * @type {boolean}\r\n * @default true\r\n */", "meta": { "filename": "StencilModifier.js", "lineno": 85, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Whether to wrap the value in the stencil buffer when it overflows or underflows\rwhen using the `addLayer` or `subtractLayer` mode.\rThis is useful when defining stencils with subtraction,\rand you don't want to underflow from 0 to 255.", "name": "stencilValueWrap", "since": "4.2.0", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "memberof": "Phaser.GameObjects.Components.StencilModifier", "longname": "Phaser.GameObjects.Components.StencilModifier#stencilValueWrap", "scope": "instance", "kind": "member", "___id": "T000002R009382", "___s": true }, { "comment": "/**\r\n * Whether this Game Object is a stencil modifier.\r\n * Do not edit this property. It is used internally.\r\n *\r\n * Any object with `isStencilModifier` set to `true` is a positive result\r\n * for `hasStencilChildren`, and can affect stencil compositing.\r\n *\r\n * @name Phaser.GameObjects.Components.StencilModifier#isStencilModifier\r\n * @since 4.2.0\r\n * @type {boolean}\r\n * @readonly\r\n * @default true\r\n */", "meta": { "filename": "StencilModifier.js", "lineno": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Whether this Game Object is a stencil modifier.\rDo not edit this property. It is used internally.\r\rAny object with `isStencilModifier` set to `true` is a positive result\rfor `hasStencilChildren`, and can affect stencil compositing.", "name": "isStencilModifier", "since": "4.2.0", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "memberof": "Phaser.GameObjects.Components.StencilModifier", "longname": "Phaser.GameObjects.Components.StencilModifier#isStencilModifier", "scope": "instance", "kind": "member", "___id": "T000002R009384", "___s": true }, { "comment": "/**\r\n * Sets the alpha strategy to use when rendering the stencil.\r\n *\r\n * @method Phaser.GameObjects.Components.StencilModifier#setStencilAlphaStrategy\r\n * @since 4.2.0\r\n * @param {Phaser.Types.Renderer.WebGL.AlphaStrategy} stencilAlphaStrategy - The alpha strategy to use when rendering the stencil.\r\n * @returns {this} This Game Object instance.\r\n */", "meta": { "filename": "StencilModifier.js", "lineno": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the alpha strategy to use when rendering the stencil.", "kind": "function", "name": "setStencilAlphaStrategy", "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.AlphaStrategy" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.AlphaStrategy" } }, "description": "The alpha strategy to use when rendering the stencil.", "name": "stencilAlphaStrategy" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.StencilModifier", "longname": "Phaser.GameObjects.Components.StencilModifier#setStencilAlphaStrategy", "scope": "instance", "___id": "T000002R009388", "___s": true }, { "comment": "/**\r\n * Sets the value to clear the stencil to,\r\n * if the `stencilLayerMode` is `clear` or `clearRegion`.\r\n * Should be between 0 and 255, as the buffer is 8 bits.\r\n *\r\n * @method Phaser.GameObjects.Components.StencilModifier#setStencilClearValue\r\n * @since 4.2.0\r\n * @param {number} stencilClearValue - The value to clear the stencil buffer to.\r\n * @returns {this} This Game Object instance.\r\n */", "meta": { "filename": "StencilModifier.js", "lineno": 134, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the value to clear the stencil to,\rif the `stencilLayerMode` is `clear` or `clearRegion`.\rShould be between 0 and 255, as the buffer is 8 bits.", "kind": "function", "name": "setStencilClearValue", "since": "4.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to clear the stencil buffer to.", "name": "stencilClearValue" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.StencilModifier", "longname": "Phaser.GameObjects.Components.StencilModifier#setStencilClearValue", "scope": "instance", "___id": "T000002R009391", "___s": true }, { "comment": "/**\r\n * Sets whether to composite the contents of the stencil to a framebuffer.\r\n * While `auto` is default, it must run extra checks,\r\n * so you should set it to `true` or `false` if you know the answer.\r\n *\r\n * - `true` - Composite the contents of the stencil to a framebuffer.\r\n * - `false` - Do not composite the contents of the stencil to a framebuffer.\r\n * - `'auto'` - Automatically determine whether to composite the contents of the stencil to a framebuffer.\r\n *\r\n * @method Phaser.GameObjects.Components.StencilModifier#setStencilCompositeCheck\r\n * @since 4.2.0\r\n * @param {boolean|'auto'} stencilCompositeCheck - The check mode to use.\r\n * @returns {this} This Game Object instance.\r\n */", "meta": { "filename": "StencilModifier.js", "lineno": 150, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets whether to composite the contents of the stencil to a framebuffer.\rWhile `auto` is default, it must run extra checks,\rso you should set it to `true` or `false` if you know the answer.\r\r- `true` - Composite the contents of the stencil to a framebuffer.\r- `false` - Do not composite the contents of the stencil to a framebuffer.\r- `'auto'` - Automatically determine whether to composite the contents of the stencil to a framebuffer.", "kind": "function", "name": "setStencilCompositeCheck", "since": "4.2.0", "params": [ { "type": { "names": [ "boolean", "'auto'" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "'auto'" } ] } }, "description": "The check mode to use.", "name": "stencilCompositeCheck" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.StencilModifier", "longname": "Phaser.GameObjects.Components.StencilModifier#setStencilCompositeCheck", "scope": "instance", "___id": "T000002R009394", "___s": true }, { "comment": "/**\r\n * Sets whether to invert the stencil, using an extra draw call.\r\n *\r\n * @method Phaser.GameObjects.Components.StencilModifier#setStencilInvert\r\n * @since 4.2.0\r\n * @param {boolean} stencilInvert - Whether to invert the stencil.\r\n * @returns {this} This Game Object instance.\r\n */", "meta": { "filename": "StencilModifier.js", "lineno": 170, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets whether to invert the stencil, using an extra draw call.", "kind": "function", "name": "setStencilInvert", "since": "4.2.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to invert the stencil.", "name": "stencilInvert" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.StencilModifier", "longname": "Phaser.GameObjects.Components.StencilModifier#setStencilInvert", "scope": "instance", "___id": "T000002R009397", "___s": true }, { "comment": "/**\r\n * Sets the mode to use when rendering the stencil.\r\n *\r\n * - 'addLayer' - Add a stencil layer.\r\n * - 'subtractLayer' - Subtract a stencil layer.\r\n * - 'clear' - Clear the whole stencil buffer.\r\n * - 'clearRegion' - Clear a specific region of the stencil buffer.\r\n * You can also use this to fill a region with a specific value.\r\n *\r\n * @method Phaser.GameObjects.Components.StencilModifier#setStencilLayerMode\r\n * @since 4.2.0\r\n * @param {Phaser.Types.GameObjects.Stencil.StencilLayerMode} stencilLayerMode - The mode which the Stencil should run in.\r\n * @returns {this} This Game Object instance.\r\n */", "meta": { "filename": "StencilModifier.js", "lineno": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the mode to use when rendering the stencil.\r\r- 'addLayer' - Add a stencil layer.\r- 'subtractLayer' - Subtract a stencil layer.\r- 'clear' - Clear the whole stencil buffer.\r- 'clearRegion' - Clear a specific region of the stencil buffer.\r You can also use this to fill a region with a specific value.", "kind": "function", "name": "setStencilLayerMode", "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Stencil.StencilLayerMode" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Stencil.StencilLayerMode" } }, "description": "The mode which the Stencil should run in.", "name": "stencilLayerMode" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.StencilModifier", "longname": "Phaser.GameObjects.Components.StencilModifier#setStencilLayerMode", "scope": "instance", "___id": "T000002R009400", "___s": true }, { "comment": "/**\r\n * Sets whether to wrap the value in the stencil buffer when it overflows or underflows.\r\n * This is useful when defining stencils with subtraction,\r\n * and you don't want to underflow from 0 to 255.\r\n *\r\n * @method Phaser.GameObjects.Components.StencilModifier#setStencilValueWrap\r\n * @since 4.2.0\r\n * @param {boolean} stencilValueWrap - Whether to wrap the value in the stencil buffer when it overflows or underflows.\r\n * @returns {this} This Game Object instance.\r\n */", "meta": { "filename": "StencilModifier.js", "lineno": 204, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets whether to wrap the value in the stencil buffer when it overflows or underflows.\rThis is useful when defining stencils with subtraction,\rand you don't want to underflow from 0 to 255.", "kind": "function", "name": "setStencilValueWrap", "since": "4.2.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to wrap the value in the stencil buffer when it overflows or underflows.", "name": "stencilValueWrap" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.StencilModifier", "longname": "Phaser.GameObjects.Components.StencilModifier#setStencilValueWrap", "scope": "instance", "___id": "T000002R009403", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the texture and frame of a Game Object.\r\n *\r\n * This component is mixed in to Game Objects that support texture-based rendering,\r\n * such as Sprites and Images. It allows a Game Object to reference a texture stored\r\n * in the Texture Manager by key, and optionally a specific frame within that texture,\r\n * as used with texture atlases and sprite sheets. Changing the texture or frame will\r\n * automatically update the Game Object's size and origin to match.\r\n *\r\n * @namespace Phaser.GameObjects.Components.Texture\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for setting the texture and frame of a Game Object.\r\rThis component is mixed in to Game Objects that support texture-based rendering,\rsuch as Sprites and Images. It allows a Game Object to reference a texture stored\rin the Texture Manager by key, and optionally a specific frame within that texture,\ras used with texture atlases and sprite sheets. Changing the texture or frame will\rautomatically update the Game Object's size and origin to match.", "kind": "namespace", "name": "Texture", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Texture", "scope": "static", "___id": "T000002R009409", "___s": true }, { "comment": "/**\r\n * The Texture this Game Object is using to render with.\r\n *\r\n * @name Phaser.GameObjects.Components.Texture#texture\r\n * @type {Phaser.Textures.Texture|Phaser.Textures.CanvasTexture}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Texture this Game Object is using to render with.", "name": "texture", "type": { "names": [ "Phaser.Textures.Texture", "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Textures.Texture" }, { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Texture", "longname": "Phaser.GameObjects.Components.Texture#texture", "scope": "instance", "kind": "member", "___id": "T000002R009411", "___s": true }, { "comment": "/**\r\n * The Texture Frame this Game Object is using to render with.\r\n *\r\n * @name Phaser.GameObjects.Components.Texture#frame\r\n * @type {Phaser.Textures.Frame}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Texture.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Texture Frame this Game Object is using to render with.", "name": "frame", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Texture", "longname": "Phaser.GameObjects.Components.Texture#frame", "scope": "instance", "kind": "member", "___id": "T000002R009413", "___s": true }, { "comment": "/**\r\n * Sets the texture and frame this Game Object will use to render with.\r\n *\r\n * Textures are referenced by their string-based keys, as stored in the Texture Manager.\r\n *\r\n * Calling this method will modify the `width` and `height` properties of your Game Object.\r\n *\r\n * It will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.\r\n *\r\n * @method Phaser.GameObjects.Components.Texture#setTexture\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Textures.Texture)} key - The key of the texture to be used, as stored in the Texture Manager, or a Texture instance.\r\n * @param {(string|number)} [frame] - The name or index of the frame within the Texture.\r\n * @param {boolean} [updateSize=true] - Should this call adjust the size of the Game Object?\r\n * @param {boolean} [updateOrigin=true] - Should this call change the origin of the Game Object?\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Texture.js", "lineno": 55, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the texture and frame this Game Object will use to render with.\r\rTextures are referenced by their string-based keys, as stored in the Texture Manager.\r\rCalling this method will modify the `width` and `height` properties of your Game Object.\r\rIt will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.", "kind": "function", "name": "setTexture", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "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", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The name or index of the frame within the Texture.", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should this call adjust the size of the Game Object?", "name": "updateSize" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should this call change the origin of the Game Object?", "name": "updateOrigin" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Texture", "longname": "Phaser.GameObjects.Components.Texture#setTexture", "scope": "instance", "___id": "T000002R009417", "___s": true }, { "comment": "/**\r\n * Sets the frame this Game Object will use to render with.\r\n *\r\n * If you pass a string or index then the Frame has to belong to the current Texture being used\r\n * by this Game Object.\r\n *\r\n * If you pass a Frame instance, then the Texture being used by this Game Object will also be updated.\r\n *\r\n * Calling `setFrame` will modify the `width` and `height` properties of your Game Object.\r\n *\r\n * It will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.\r\n *\r\n * @method Phaser.GameObjects.Components.Texture#setFrame\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number|Phaser.Textures.Frame)} frame - The name or index of the frame within the Texture, or a Frame instance.\r\n * @param {boolean} [updateSize=true] - Should this call adjust the size of the Game Object?\r\n * @param {boolean} [updateOrigin=true] - Should this call adjust the origin of the Game Object?\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Texture.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the frame this Game Object will use to render with.\r\rIf you pass a string or index then the Frame has to belong to the current Texture being used\rby this Game Object.\r\rIf you pass a Frame instance, then the Texture being used by this Game Object will also be updated.\r\rCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\r\rIt 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", "number", "Phaser.Textures.Frame" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Textures.Frame" } ] } }, "description": "The name or index of the frame within the Texture, or a Frame instance.", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should this call adjust the size of the Game Object?", "name": "updateSize" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should this call adjust the origin of the Game Object?", "name": "updateOrigin" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Texture", "longname": "Phaser.GameObjects.Components.Texture#setFrame", "scope": "instance", "___id": "T000002R009420", "___s": true }, { "comment": "/**\r\n * Provides methods used for getting and setting the texture of a Game Object, with integrated support for cropping. This is used by Game Objects like Image and Sprite that need both texture management and crop functionality in a single mixin.\r\n *\r\n * @namespace Phaser.GameObjects.Components.TextureCrop\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureCrop.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for getting and setting the texture of a Game Object, with integrated support for cropping. This is used by Game Objects like Image and Sprite that need both texture management and crop functionality in a single mixin.", "kind": "namespace", "name": "TextureCrop", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.TextureCrop", "scope": "static", "___id": "T000002R009432", "___s": true }, { "comment": "/**\r\n * The Texture this Game Object is using to render with.\r\n *\r\n * @name Phaser.GameObjects.Components.TextureCrop#texture\r\n * @type {Phaser.Textures.Texture|Phaser.Textures.CanvasTexture}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureCrop.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Texture this Game Object is using to render with.", "name": "texture", "type": { "names": [ "Phaser.Textures.Texture", "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Textures.Texture" }, { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.TextureCrop", "longname": "Phaser.GameObjects.Components.TextureCrop#texture", "scope": "instance", "kind": "member", "___id": "T000002R009434", "___s": true }, { "comment": "/**\r\n * The Texture Frame this Game Object is using to render with.\r\n *\r\n * @name Phaser.GameObjects.Components.TextureCrop#frame\r\n * @type {Phaser.Textures.Frame}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextureCrop.js", "lineno": 30, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Texture Frame this Game Object is using to render with.", "name": "frame", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.TextureCrop", "longname": "Phaser.GameObjects.Components.TextureCrop#frame", "scope": "instance", "kind": "member", "___id": "T000002R009436", "___s": true }, { "comment": "/**\r\n * A boolean flag indicating if this Game Object is being cropped or not.\r\n * You can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\r\n * Equally, calling `setCrop` with no arguments will reset the crop and disable it.\r\n *\r\n * @name Phaser.GameObjects.Components.TextureCrop#isCropped\r\n * @type {boolean}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "TextureCrop.js", "lineno": 39, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "A boolean flag indicating if this Game Object is being cropped or not.\rYou can toggle this at any time after `setCrop` has been called, to turn cropping on or off.\rEqually, calling `setCrop` with no arguments will reset the crop and disable it.", "name": "isCropped", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.Components.TextureCrop", "longname": "Phaser.GameObjects.Components.TextureCrop#isCropped", "scope": "instance", "kind": "member", "___id": "T000002R009438", "___s": true }, { "comment": "/**\r\n * Applies a crop to a texture based Game Object, such as a Sprite or Image.\r\n *\r\n * The crop is a rectangle that limits the area of the texture frame that is visible during rendering.\r\n *\r\n * Cropping a Game Object does not change its size, dimensions, physics body or hit area, it just\r\n * changes what is shown when rendered.\r\n *\r\n * The crop size as well as coordinates can not exceed the size of the texture frame.\r\n *\r\n * The crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\r\n *\r\n * Therefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\r\n * half of it, you could call `setCrop(0, 0, 400, 600)`.\r\n *\r\n * It is also scaled to match the Game Object scale automatically. Therefore a crop rectangle of 100x50 would crop\r\n * an area of 200x100 when applied to a Game Object that had a scale factor of 2.\r\n *\r\n * You can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\r\n *\r\n * Call this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\r\n *\r\n * You should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\r\n * the renderer to skip several internal calculations.\r\n *\r\n * @method Phaser.GameObjects.Components.TextureCrop#setCrop\r\n * @since 3.11.0\r\n *\r\n * @param {(number|Phaser.Geom.Rectangle)} [x] - The x coordinate to start the crop from. Cannot be negative or exceed the Frame width. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.\r\n * @param {number} [y] - The y coordinate to start the crop from. Cannot be negative or exceed the Frame height.\r\n * @param {number} [width] - The width of the crop rectangle in pixels. Cannot exceed the Frame width.\r\n * @param {number} [height] - The height of the crop rectangle in pixels. Cannot exceed the Frame height.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "TextureCrop.js", "lineno": 50, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Applies a crop to a texture based Game Object, such as a Sprite or Image.\r\rThe crop is a rectangle that limits the area of the texture frame that is visible during rendering.\r\rCropping a Game Object does not change its size, dimensions, physics body or hit area, it just\rchanges what is shown when rendered.\r\rThe crop size as well as coordinates can not exceed the size of the texture frame.\r\rThe crop coordinates are relative to the texture frame, not the Game Object, meaning 0 x 0 is the top-left.\r\rTherefore, if you had a Game Object that had an 800x600 sized texture, and you wanted to show only the left\rhalf of it, you could call `setCrop(0, 0, 400, 600)`.\r\rIt is also scaled to match the Game Object scale automatically. Therefore a crop rectangle of 100x50 would crop\ran area of 200x100 when applied to a Game Object that had a scale factor of 2.\r\rYou can either pass in numeric values directly, or you can provide a single Rectangle object as the first argument.\r\rCall this method with no arguments at all to reset the crop, or toggle the property `isCropped` to `false`.\r\rYou should do this if the crop rectangle becomes the same size as the frame itself, as it will allow\rthe renderer to skip several internal calculations.", "kind": "function", "name": "setCrop", "since": "3.11.0", "params": [ { "type": { "names": [ "number", "Phaser.Geom.Rectangle" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } ] } }, "optional": true, "description": "The x coordinate to start the crop from. Cannot be negative or exceed the Frame width. Or a Phaser.Geom.Rectangle object, in which case the rest of the arguments are ignored.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y coordinate to start the crop from. Cannot be negative or exceed the Frame height.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the crop rectangle in pixels. Cannot exceed the Frame width.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the crop rectangle in pixels. Cannot exceed the Frame height.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.TextureCrop", "longname": "Phaser.GameObjects.Components.TextureCrop#setCrop", "scope": "instance", "___id": "T000002R009440", "___s": true }, { "comment": "/**\r\n * Sets the texture and frame this Game Object will use to render with.\r\n *\r\n * Textures are referenced by their string-based keys, as stored in the Texture Manager.\r\n *\r\n * @method Phaser.GameObjects.Components.TextureCrop#setTexture\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key of the texture to be used, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - The name or index of the frame within the Texture.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "TextureCrop.js", "lineno": 110, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the texture and frame this Game Object will use to render with.\r\rTextures 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture to be used, as stored in the Texture Manager.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The name or index of the frame within the Texture.", "name": "frame" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.TextureCrop", "longname": "Phaser.GameObjects.Components.TextureCrop#setTexture", "scope": "instance", "___id": "T000002R009445", "___s": true }, { "comment": "/**\r\n * Sets the frame this Game Object will use to render with.\r\n *\r\n * If you pass a string or index then the Frame has to belong to the current Texture being used\r\n * by this Game Object.\r\n *\r\n * If you pass a Frame instance, then the Texture being used by this Game Object will also be updated.\r\n *\r\n * Calling `setFrame` will modify the `width` and `height` properties of your Game Object.\r\n *\r\n * It will also change the `origin` if the Frame has a custom pivot point, as exported from packages like Texture Packer.\r\n *\r\n * @method Phaser.GameObjects.Components.TextureCrop#setFrame\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number|Phaser.Textures.Frame)} frame - The name or index of the frame within the Texture, or a Frame instance.\r\n * @param {boolean} [updateSize=true] - Should this call adjust the size of the Game Object?\r\n * @param {boolean} [updateOrigin=true] - Should this call adjust the origin of the Game Object?\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "TextureCrop.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the frame this Game Object will use to render with.\r\rIf you pass a string or index then the Frame has to belong to the current Texture being used\rby this Game Object.\r\rIf you pass a Frame instance, then the Texture being used by this Game Object will also be updated.\r\rCalling `setFrame` will modify the `width` and `height` properties of your Game Object.\r\rIt 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", "number", "Phaser.Textures.Frame" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Textures.Frame" } ] } }, "description": "The name or index of the frame within the Texture, or a Frame instance.", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should this call adjust the size of the Game Object?", "name": "updateSize" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should this call adjust the origin of the Game Object?", "name": "updateOrigin" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.TextureCrop", "longname": "Phaser.GameObjects.Components.TextureCrop#setFrame", "scope": "instance", "___id": "T000002R009448", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the tint of a Game Object.\r\n * Should be applied as a mixin and not used directly.\r\n *\r\n * @namespace Phaser.GameObjects.Components.Tint\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for setting the tint of a Game Object.\rShould be applied as a mixin and not used directly.", "kind": "namespace", "name": "Tint", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.Tint", "scope": "static", "___id": "T000002R009475", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-left vertex of the Game Object.\r\n * This value is interpolated from the corner to the center of the Game Object.\r\n * The value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintTopLeft\r\n * @type {number}\r\n * @default 0xffffff\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 20, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The tint value being applied to the top-left vertex of the Game Object.\rThis value is interpolated from the corner to the center of the Game Object.\rThe value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.", "name": "tintTopLeft", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#tintTopLeft", "scope": "instance", "kind": "member", "___id": "T000002R009477", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the top-right vertex of the Game Object.\r\n * This value is interpolated from the corner to the center of the Game Object.\r\n * The value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintTopRight\r\n * @type {number}\r\n * @default 0xffffff\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The tint value being applied to the top-right vertex of the Game Object.\rThis value is interpolated from the corner to the center of the Game Object.\rThe value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.", "name": "tintTopRight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#tintTopRight", "scope": "instance", "kind": "member", "___id": "T000002R009479", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-left vertex of the Game Object.\r\n * This value is interpolated from the corner to the center of the Game Object.\r\n * The value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintBottomLeft\r\n * @type {number}\r\n * @default 0xffffff\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 44, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The tint value being applied to the bottom-left vertex of the Game Object.\rThis value is interpolated from the corner to the center of the Game Object.\rThe value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.", "name": "tintBottomLeft", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#tintBottomLeft", "scope": "instance", "kind": "member", "___id": "T000002R009481", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the bottom-right vertex of the Game Object.\r\n * This value is interpolated from the corner to the center of the Game Object.\r\n * The value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintBottomRight\r\n * @type {number}\r\n * @default 0xffffff\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 56, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The tint value being applied to the bottom-right vertex of the Game Object.\rThis value is interpolated from the corner to the center of the Game Object.\rThe value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.", "name": "tintBottomRight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#tintBottomRight", "scope": "instance", "kind": "member", "___id": "T000002R009483", "___s": true }, { "comment": "/**\r\n * The secondary tint value being applied to the top-left vertex of the Game Object.\r\n * Used in two-color tint modes.\r\n * This value is interpolated from the corner to the center of the Game Object.\r\n * The value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tint2TopLeft\r\n * @type {number}\r\n * @default 0x000000\r\n * @since 4.2.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The secondary tint value being applied to the top-left vertex of the Game Object.\rUsed in two-color tint modes.\rThis value is interpolated from the corner to the center of the Game Object.\rThe value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.", "name": "tint2TopLeft", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0x000000", "since": "4.2.0", "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#tint2TopLeft", "scope": "instance", "kind": "member", "___id": "T000002R009485", "___s": true }, { "comment": "/**\r\n * The secondary tint value being applied to the top-right vertex of the Game Object.\r\n * Used in two-color tint modes.\r\n * This value is interpolated from the corner to the center of the Game Object.\r\n * The value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tint2TopRight\r\n * @type {number}\r\n * @default 0x000000\r\n * @since 4.2.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The secondary tint value being applied to the top-right vertex of the Game Object.\rUsed in two-color tint modes.\rThis value is interpolated from the corner to the center of the Game Object.\rThe value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.", "name": "tint2TopRight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0x000000", "since": "4.2.0", "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#tint2TopRight", "scope": "instance", "kind": "member", "___id": "T000002R009487", "___s": true }, { "comment": "/**\r\n * The secondary tint value being applied to the bottom-left vertex of the Game Object.\r\n * Used in two-color tint modes.\r\n * This value is interpolated from the corner to the center of the Game Object.\r\n * The value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tint2BottomLeft\r\n * @type {number}\r\n * @default 0x000000\r\n * @since 4.2.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 94, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The secondary tint value being applied to the bottom-left vertex of the Game Object.\rUsed in two-color tint modes.\rThis value is interpolated from the corner to the center of the Game Object.\rThe value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.", "name": "tint2BottomLeft", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0x000000", "since": "4.2.0", "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#tint2BottomLeft", "scope": "instance", "kind": "member", "___id": "T000002R009489", "___s": true }, { "comment": "/**\r\n * The secondary tint value being applied to the bottom-right vertex of the Game Object.\r\n * Used in two-color tint modes.\r\n * This value is interpolated from the corner to the center of the Game Object.\r\n * The value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tint2BottomRight\r\n * @type {number}\r\n * @default 0x000000\r\n * @since 4.2.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 107, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The secondary tint value being applied to the bottom-right vertex of the Game Object.\rUsed in two-color tint modes.\rThis value is interpolated from the corner to the center of the Game Object.\rThe value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.", "name": "tint2BottomRight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0x000000", "since": "4.2.0", "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#tint2BottomRight", "scope": "instance", "kind": "member", "___id": "T000002R009491", "___s": true }, { "comment": "/**\r\n * The tint mode to use when applying the tint to the texture.\r\n *\r\n * Available modes are:\r\n * - Phaser.TintModes.MULTIPLY (default)\r\n * - Phaser.TintModes.FILL\r\n * - Phaser.TintModes.ADD\r\n * - Phaser.TintModes.SCREEN\r\n * - Phaser.TintModes.OVERLAY\r\n * - Phaser.TintModes.HARD_LIGHT\r\n * - Phaser.TintModes.MULTIPLY_TWO\r\n *\r\n * Note that in Phaser 3, tint mode and color were set at the same time.\r\n * In Phaser 4 they are separate settings.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tintMode\r\n * @type {Phaser.TintModes}\r\n * @default Phaser.TintModes.MULTIPLY\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The tint mode to use when applying the tint to the texture.\r\rAvailable modes are:\r- Phaser.TintModes.MULTIPLY (default)\r- Phaser.TintModes.FILL\r- Phaser.TintModes.ADD\r- Phaser.TintModes.SCREEN\r- Phaser.TintModes.OVERLAY\r- Phaser.TintModes.HARD_LIGHT\r- Phaser.TintModes.MULTIPLY_TWO\r\rNote that in Phaser 3, tint mode and color were set at the same time.\rIn Phaser 4 they are separate settings.", "name": "tintMode", "type": { "names": [ "Phaser.TintModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.TintModes" } }, "defaultvalue": "Phaser.TintModes.MULTIPLY", "since": "4.0.0", "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#tintMode", "scope": "instance", "kind": "member", "___id": "T000002R009493", "___s": true }, { "comment": "/**\r\n * Clears all tint values associated with this Game Object.\r\n *\r\n * Immediately sets the color values back to 0xffffff and the tint mode to `MULTIPLY`,\r\n * which results in no visible change to the texture.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#clearTint\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Tint.js", "lineno": 142, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint mode to `MULTIPLY`,\rwhich results in no visible change to the texture.", "kind": "function", "name": "clearTint", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#clearTint", "scope": "instance", "___id": "T000002R009495", "___s": true }, { "comment": "/**\r\n * Sets the tint color on this Game Object.\r\n *\r\n * The tint works by taking the pixel color values from the Game Objects texture, and then\r\n * combining it with the color value of the tint. You can provide either one color value,\r\n * in which case the whole Game Object will be tinted in that color. Or you can provide a color\r\n * per corner. The colors are blended together across the extent of the Game Object.\r\n *\r\n * To modify the tint color once set, either call this method again with new values or use the\r\n * `tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight`,\r\n * `tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\r\n *\r\n * To remove a tint call `clearTint`.\r\n *\r\n * The tint color is combined according to the tint mode.\r\n * By default, this is `MULTIPLY`.\r\n *\r\n * Note that, in Phaser 3, this would also swap the tint mode if it was set\r\n * to fill. In Phaser 4, the tint mode is separate: use `setTintMode`.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTint\r\n * @webglOnly\r\n * @since 3.0.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - 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.\r\n * @param {number} [topRight] - The tint being applied to the top-right of the Game Object.\r\n * @param {number} [bottomLeft] - The tint being applied to the bottom-left of the Game Object.\r\n * @param {number} [bottomRight] - The tint being applied to the bottom-right of the Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Tint.js", "lineno": 163, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the tint color on this Game Object.\r\rThe tint works by taking the pixel color values from the Game Objects texture, and then\rcombining it with the color value of the tint. You can provide either one color value,\rin which case the whole Game Object will be tinted in that color. Or you can provide a color\rper corner. The colors are blended together across the extent of the Game Object.\r\rTo modify the tint color once set, either call this method again with new values or use the\r`tint` property to set all colors at once. Or, use the properties `tintTopLeft`, `tintTopRight`,\r`tintBottomLeft` and `tintBottomRight` to set the corner color values independently.\r\rTo remove a tint call `clearTint`.\r\rThe tint color is combined according to the tint mode.\rBy default, this is `MULTIPLY`.\r\rNote that, in Phaser 3, this would also swap the tint mode if it was set\rto fill. In Phaser 4, the tint mode is separate: use `setTintMode`.", "kind": "function", "name": "setTint", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint being applied to the top-right of the Game Object.", "name": "topRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint being applied to the bottom-left of the Game Object.", "name": "bottomLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint being applied to the bottom-right of the Game Object.", "name": "bottomRight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#setTint", "scope": "instance", "___id": "T000002R009497", "___s": true }, { "comment": "/**\r\n * Sets the secondary tint color on this Game Object.\r\n * This is used in two-color tint modes.\r\n * See {@link Phaser.GameObjects.Components.Tint#setTint} for more information.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTint2\r\n * @webglOnly\r\n * @since 4.2.0\r\n *\r\n * @param {number} [topLeft=0xffffff] - The secondary 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.\r\n * @param {number} [topRight] - The secondary tint being applied to the top-right of the Game Object.\r\n * @param {number} [bottomLeft] - The secondary tint being applied to the bottom-left of the Game Object.\r\n * @param {number} [bottomRight] - The secondary tint being applied to the bottom-right of the Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Tint.js", "lineno": 213, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the secondary tint color on this Game Object.\rThis is used in two-color tint modes.\rSee {@link Phaser.GameObjects.Components.Tint#setTint} for more information.", "kind": "function", "name": "setTint2", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The secondary 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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The secondary tint being applied to the top-right of the Game Object.", "name": "topRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The secondary tint being applied to the bottom-left of the Game Object.", "name": "bottomLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The secondary tint being applied to the bottom-right of the Game Object.", "name": "bottomRight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#setTint2", "scope": "instance", "___id": "T000002R009507", "___s": true }, { "comment": "/**\r\n * Sets the tint mode to use when applying the tint to the texture.\r\n *\r\n * Note that, in Phaser 3, tint mode and color were set at the same time.\r\n * In Phaser 4 they are separate settings.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintMode\r\n * @webglOnly\r\n * @since 4.0.0\r\n *\r\n * @param {number | Phaser.TintModes} mode - The tint mode to use.\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Tint.js", "lineno": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the tint mode to use when applying the tint to the texture.\r\rNote that, in Phaser 3, tint mode and color were set at the same time.\rIn Phaser 4 they are separate settings.", "kind": "function", "name": "setTintMode", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "number", "Phaser.TintModes" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.TintModes" } ] } }, "description": "The tint mode to use.", "name": "mode" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#setTintMode", "scope": "instance", "___id": "T000002R009517", "___s": true }, { "comment": "/**\r\n * Deprecated method which does nothing.\r\n * In Phaser 3, this would set the tint color, and set the tint mode to fill.\r\n * In Phaser 4, use `gameObject.setTint(color).setTintMode(Phaser.TintModes.FILL)` instead.\r\n *\r\n * @method Phaser.GameObjects.Components.Tint#setTintFill\r\n * @webglOnly\r\n * @since 3.11.0\r\n * @deprecated\r\n */", "meta": { "filename": "Tint.js", "lineno": 266, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Deprecated method which does nothing.\rIn Phaser 3, this would set the tint color, and set the tint mode to fill.\rIn Phaser 4, use `gameObject.setTint(color).setTintMode(Phaser.TintModes.FILL)` instead.", "kind": "function", "name": "setTintFill", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.11.0", "deprecated": true, "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#setTintFill", "scope": "instance", "___id": "T000002R009520", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the whole of the Game Object.\r\n * Returns the value of `tintTopLeft` when read. When written, the same\r\n * color value is applied to all four corner tint properties (`tintTopLeft`,\r\n * `tintTopRight`, `tintBottomLeft`, and `tintBottomRight`) simultaneously.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#tint\r\n * @type {number}\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 282, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The tint value being applied to the whole of the Game Object.\rReturns the value of `tintTopLeft` when read. When written, the same\rcolor value is applied to all four corner tint properties (`tintTopLeft`,\r`tintTopRight`, `tintBottomLeft`, and `tintBottomRight`) simultaneously.", "name": "tint", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#tint", "scope": "instance", "kind": "member", "___id": "T000002R009522", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * Returns `true` if any of the four corner tint values differ from 0xffffff,\r\n * or if the `tintMode` property is set to anything other than `MULTIPLY`,\r\n * or if any of the four secondary corner tint values differ from 0x000000.\r\n * Returns `false` in the default untinted state.\r\n *\r\n * @name Phaser.GameObjects.Components.Tint#isTinted\r\n * @type {boolean}\r\n * @webglOnly\r\n * @readonly\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Tint.js", "lineno": 306, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Does this Game Object have a tint applied?\r\rReturns `true` if any of the four corner tint values differ from 0xffffff,\ror if the `tintMode` property is set to anything other than `MULTIPLY`,\ror if any of the four secondary corner tint values differ from 0x000000.\rReturns `false` in the default untinted state.", "name": "isTinted", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.11.0", "memberof": "Phaser.GameObjects.Components.Tint", "longname": "Phaser.GameObjects.Components.Tint#isTinted", "scope": "instance", "kind": "member", "___id": "T000002R009526", "___s": true }, { "comment": "/**\r\n * Build a JSON representation of the given Game Object.\r\n *\r\n * This is typically extended further by Game Object specific implementations.\r\n *\r\n * @method Phaser.GameObjects.Components.ToJSON\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to export as JSON.\r\n *\r\n * @return {Phaser.Types.GameObjects.JSONGameObject} A JSON representation of the Game Object.\r\n */", "meta": { "filename": "ToJSON.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Build a JSON representation of the given Game Object.\r\rThis is typically extended further by Game Object specific implementations.", "kind": "function", "name": "ToJSON", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to export as JSON.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.JSONGameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.JSONGameObject" } }, "description": "A JSON representation of the Game Object." } ], "memberof": "Phaser.GameObjects.Components", "longname": "Phaser.GameObjects.Components.ToJSON", "scope": "static", "___id": "T000002R009532", "___s": true }, { "comment": "/**\r\n * Provides methods used for getting and setting the position, scale and rotation of a Game Object.\r\n *\r\n * @namespace Phaser.GameObjects.Components.Transform\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "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", "___id": "T000002R009565", "___s": true }, { "comment": "/**\r\n * A property indicating that a Game Object has this component.\r\n *\r\n * @name Phaser.GameObjects.Components.Transform#hasTransformComponent\r\n * @type {boolean}\r\n * @readonly\r\n * @default true\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 26, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "A property indicating that a Game Object has this component.", "name": "hasTransformComponent", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#hasTransformComponent", "scope": "instance", "kind": "member", "___id": "T000002R009567", "___s": true }, { "comment": "/**\r\n * The x position of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Transform#x\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 70, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The x position of this Game Object.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#x", "scope": "instance", "kind": "member", "___id": "T000002R009575", "___s": true }, { "comment": "/**\r\n * The y position of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Transform#y\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The y position of this Game Object.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#y", "scope": "instance", "kind": "member", "___id": "T000002R009577", "___s": true }, { "comment": "/**\r\n * The z position of this Game Object.\r\n *\r\n * Note: The z position does not control the rendering order of 2D Game Objects. Use\r\n * {@link Phaser.GameObjects.Components.Depth#depth} instead.\r\n *\r\n * @name Phaser.GameObjects.Components.Transform#z\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 90, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The z position of this Game Object.\r\rNote: The z position does not control the rendering order of 2D Game Objects. Use\r{@link Phaser.GameObjects.Components.Depth#depth} instead.", "name": "z", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#z", "scope": "instance", "kind": "member", "___id": "T000002R009579", "___s": true }, { "comment": "/**\r\n * The w position of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Transform#w\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The w position of this Game Object.", "name": "w", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#w", "scope": "instance", "kind": "member", "___id": "T000002R009581", "___s": true }, { "comment": "/**\r\n * This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\r\n * to the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\r\n *\r\n * Use of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\r\n * isn't the case, use the `scaleX` or `scaleY` properties instead.\r\n *\r\n * @name Phaser.GameObjects.Components.Transform#scale\r\n * @type {number}\r\n * @default 1\r\n * @since 3.18.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object\rto the same value, at the same time. When reading this value the result returned is `(scaleX + scaleY) / 2`.\r\rUse of this property implies you wish the horizontal and vertical scales to be equal to each other. If this\risn't the case, use the `scaleX` or `scaleY` properties instead.", "name": "scale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.18.0", "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#scale", "scope": "instance", "kind": "member", "___id": "T000002R009583", "___s": true }, { "comment": "/**\r\n * The horizontal scale of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Transform#scaleX\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 149, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The horizontal scale of this Game Object.", "name": "scaleX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#scaleX", "scope": "instance", "kind": "member", "___id": "T000002R009591", "___s": true }, { "comment": "/**\r\n * The vertical scale of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Components.Transform#scaleY\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The vertical scale of this Game Object.", "name": "scaleY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#scaleY", "scope": "instance", "kind": "member", "___id": "T000002R009598", "___s": true }, { "comment": "/**\r\n * The angle of this Game Object as expressed in degrees.\r\n *\r\n * Phaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\r\n * and -90 is up.\r\n *\r\n * If you prefer to work in radians, see the `rotation` property instead.\r\n *\r\n * @name Phaser.GameObjects.Components.Transform#angle\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 211, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The angle of this Game Object as expressed in degrees.\r\rPhaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left\rand -90 is up.\r\rIf you prefer to work in radians, see the `rotation` property instead.", "name": "angle", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#angle", "scope": "instance", "kind": "member", "___id": "T000002R009605", "___s": true }, { "comment": "/**\r\n * The angle of this Game Object in radians.\r\n *\r\n * Phaser uses a right-hand clockwise rotation system, where 0 is right, PI/2 is down, +-PI is left\r\n * and -PI/2 is up.\r\n *\r\n * If you prefer to work in degrees, see the `angle` property instead.\r\n *\r\n * @name Phaser.GameObjects.Components.Transform#rotation\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Transform.js", "lineno": 238, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The angle of this Game Object in radians.\r\rPhaser uses a right-hand clockwise rotation system, where 0 is right, PI/2 is down, +-PI is left\rand -PI/2 is up.\r\rIf you prefer to work in degrees, see the `angle` property instead.", "name": "rotation", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#rotation", "scope": "instance", "kind": "member", "___id": "T000002R009610", "___s": true }, { "comment": "/**\r\n * Sets the position of this Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#setPosition\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The x position of this Game Object.\r\n * @param {number} [y=x] - The y position of this Game Object. If not set it will use the `x` value.\r\n * @param {number} [z=0] - The z position of this Game Object.\r\n * @param {number} [w=0] - The w position of this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 265, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the position of this Game Object.", "kind": "function", "name": "setPosition", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "z" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "w" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#setPosition", "scope": "instance", "___id": "T000002R009615", "___s": true }, { "comment": "/**\r\n * Copies an object's coordinates to this Game Object's position.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#copyPosition\r\n * @since 3.50.0\r\n *\r\n * @param {(Phaser.Types.Math.Vector2Like|Phaser.Types.Math.Vector3Like|Phaser.Types.Math.Vector4Like)} source - An object with numeric 'x', 'y', 'z', or 'w' properties. Undefined values are not copied.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 293, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Copies an object's coordinates to this Game Object's position.", "kind": "function", "name": "copyPosition", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like", "Phaser.Types.Math.Vector3Like", "Phaser.Types.Math.Vector4Like" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" }, { "type": "NameExpression", "name": "Phaser.Types.Math.Vector3Like" }, { "type": "NameExpression", "name": "Phaser.Types.Math.Vector4Like" } ] } }, "description": "An object with numeric 'x', 'y', 'z', or 'w' properties. Undefined values are not copied.", "name": "source" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#copyPosition", "scope": "instance", "___id": "T000002R009625", "___s": true }, { "comment": "/**\r\n * Sets the position of this Game Object to be a random position within the confines of\r\n * the given area.\r\n *\r\n * If no area is specified a random position between 0 x 0 and the game width x height is used instead.\r\n *\r\n * The position does not factor in the size of this Game Object, meaning that only the origin is\r\n * guaranteed to be within the area.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#setRandomPosition\r\n * @since 3.8.0\r\n *\r\n * @param {number} [x=0] - The x position of the top-left of the random area.\r\n * @param {number} [y=0] - The y position of the top-left of the random area.\r\n * @param {number} [width] - The width of the random area.\r\n * @param {number} [height] - The height of the random area.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 313, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the position of this Game Object to be a random position within the confines of\rthe given area.\r\rIf no area is specified a random position between 0 x 0 and the game width x height is used instead.\r\rThe position does not factor in the size of this Game Object, meaning that only the origin is\rguaranteed to be within the area.", "kind": "function", "name": "setRandomPosition", "since": "3.8.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of the top-left of the random area.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of the top-left of the random area.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the random area.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the random area.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#setRandomPosition", "scope": "instance", "___id": "T000002R009631", "___s": true }, { "comment": "/**\r\n * Sets the rotation of this Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#setRotation\r\n * @since 3.0.0\r\n *\r\n * @param {number} [radians=0] - The rotation of this Game Object, in radians.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 345, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the rotation of this Game Object.", "kind": "function", "name": "setRotation", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in radians.", "name": "radians" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#setRotation", "scope": "instance", "___id": "T000002R009639", "___s": true }, { "comment": "/**\r\n * Sets the angle of this Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#setAngle\r\n * @since 3.0.0\r\n *\r\n * @param {number} [degrees=0] - The rotation of this Game Object, in degrees.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 364, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the angle of this Game Object.", "kind": "function", "name": "setAngle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of this Game Object, in degrees.", "name": "degrees" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#setAngle", "scope": "instance", "___id": "T000002R009643", "___s": true }, { "comment": "/**\r\n * Sets the scale of this Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#setScale\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=1] - The horizontal scale of this Game Object.\r\n * @param {number} [y=x] - The vertical scale of this Game Object. If not set it will use the `x` value.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 383, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the scale of this Game Object.", "kind": "function", "name": "setScale", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The horizontal scale of this Game Object.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#setScale", "scope": "instance", "___id": "T000002R009647", "___s": true }, { "comment": "/**\r\n * Sets the x position of this Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#setX\r\n * @since 3.0.0\r\n *\r\n * @param {number} [value=0] - The x position of this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 405, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the x position of this Game Object.", "kind": "function", "name": "setX", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of this Game Object.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#setX", "scope": "instance", "___id": "T000002R009653", "___s": true }, { "comment": "/**\r\n * Sets the y position of this Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#setY\r\n * @since 3.0.0\r\n *\r\n * @param {number} [value=0] - The y position of this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the y position of this Game Object.", "kind": "function", "name": "setY", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of this Game Object.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#setY", "scope": "instance", "___id": "T000002R009657", "___s": true }, { "comment": "/**\r\n * Sets the z position of this Game Object.\r\n *\r\n * Note: The z position does not control the rendering order of 2D Game Objects. Use\r\n * {@link Phaser.GameObjects.Components.Depth#setDepth} instead.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#setZ\r\n * @since 3.0.0\r\n *\r\n * @param {number} [value=0] - The z position of this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 443, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the z position of this Game Object.\r\rNote: The z position does not control the rendering order of 2D Game Objects. Use\r{@link Phaser.GameObjects.Components.Depth#setDepth} instead.", "kind": "function", "name": "setZ", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The z position of this Game Object.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#setZ", "scope": "instance", "___id": "T000002R009661", "___s": true }, { "comment": "/**\r\n * Sets the w position of this Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#setW\r\n * @since 3.0.0\r\n *\r\n * @param {number} [value=0] - The w position of this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Transform.js", "lineno": 465, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the w position of this Game Object.", "kind": "function", "name": "setW", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The w position of this Game Object.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#setW", "scope": "instance", "___id": "T000002R009665", "___s": true }, { "comment": "/**\r\n * Gets the local transform matrix for this Game Object.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#getLocalTransformMatrix\r\n * @since 3.4.0\r\n *\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [tempMatrix] - The matrix to populate with the values from this Game Object.\r\n *\r\n * @return {Phaser.GameObjects.Components.TransformMatrix} The populated Transform Matrix.\r\n */", "meta": { "filename": "Transform.js", "lineno": 484, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#getLocalTransformMatrix", "scope": "instance", "___id": "T000002R009669", "___s": true }, { "comment": "/**\r\n * Gets the world transform matrix for this Game Object, factoring in any parent Containers.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#getWorldTransformMatrix\r\n * @since 3.4.0\r\n *\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [tempMatrix] - The matrix to populate with the values from this Game Object.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentMatrix] - A temporary matrix to hold parent values during the calculations.\r\n *\r\n * @return {Phaser.GameObjects.Components.TransformMatrix} The populated Transform Matrix.\r\n */", "meta": { "filename": "Transform.js", "lineno": 501, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The populated Transform Matrix." } ], "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#getWorldTransformMatrix", "scope": "instance", "___id": "T000002R009672", "___s": true }, { "comment": "/**\r\n * Takes the given `x` and `y` coordinates and converts them into local space for this\r\n * Game Object, taking into account parent and local transforms, and the Display Origin.\r\n *\r\n * The returned Vector2 contains the translated point in its properties.\r\n *\r\n * A Camera needs to be provided in order to handle modified scroll factors. If no\r\n * camera is specified, it will use the `main` camera from the Scene to which this\r\n * Game Object belongs.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#getLocalPoint\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The x position to translate.\r\n * @param {number} y - The y position to translate.\r\n * @param {Phaser.Math.Vector2} [point] - A Vector2, or point-like object, to store the results in.\r\n * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera which is being tested against. If not given will use the Scene default camera.\r\n *\r\n * @return {Phaser.Math.Vector2} The translated point.\r\n */", "meta": { "filename": "Transform.js", "lineno": 551, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Takes the given `x` and `y` coordinates and converts them into local space for this\rGame Object, taking into account parent and local transforms, and the Display Origin.\r\rThe returned Vector2 contains the translated point in its properties.\r\rA Camera needs to be provided in order to handle modified scroll factors. If no\rcamera is specified, it will use the `main` camera from the Scene to which this\rGame Object belongs.", "kind": "function", "name": "getLocalPoint", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position to translate.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position to translate.", "name": "y" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2, or point-like object, to store the results in.", "name": "point" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "optional": true, "description": "The Camera which is being tested against. If not given will use the Scene default camera.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The translated point." } ], "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#getLocalPoint", "scope": "instance", "___id": "T000002R009680", "___s": true }, { "comment": "/**\r\n * Gets the world position of this Game Object, factoring in any parent Containers.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#getWorldPoint\r\n * @since 3.88.0\r\n *\r\n * @param {Phaser.Math.Vector2} [point] - A Vector2, or point-like object, to store the result in.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [tempMatrix] - A temporary matrix to hold the Game Object's values.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentMatrix] - A temporary matrix to hold parent values.\r\n *\r\n * @return {Phaser.Math.Vector2} The world position of this Game Object.\r\n */", "meta": { "filename": "Transform.js", "lineno": 601, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the world position of this Game Object, factoring in any parent Containers.", "kind": "function", "name": "getWorldPoint", "since": "3.88.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2, or point-like object, to store the result in.", "name": "point" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "A temporary matrix to hold the Game Object's values.", "name": "tempMatrix" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "A temporary matrix to hold parent values.", "name": "parentMatrix" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The world position of this Game Object." } ], "memberof": "Phaser.GameObjects.Components.Transform", "longname": "Phaser.GameObjects.Components.Transform#getWorldPoint", "scope": "instance", "___id": "T000002R009690", "___s": true }, { "comment": "/**\r\n * Gets the sum total rotation of all of this Game Object's parent Containers.\r\n *\r\n * The returned value is in radians and will be zero if this Game Object has no parent container.\r\n *\r\n * @method Phaser.GameObjects.Components.Transform#getParentRotation\r\n * @since 3.18.0\r\n *\r\n * @return {number} The sum total rotation, in radians, of all parent containers of this Game Object.\r\n */", "meta": { "filename": "Transform.js", "lineno": 635, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Gets the sum total rotation of all of this Game Object's parent Containers.\r\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R009699", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A TransformMatrix is a 3x3 affine transformation matrix used to encode\r\n * the position, rotation, scale, and skew of a Game Object for rendering.\r\n *\r\n * It is used internally by Phaser during the render pipeline to accumulate\r\n * parent-child transform chains and apply camera transformations. You will\r\n * typically interact with it when writing custom renderers or working with\r\n * the camera or display list transform pipeline.\r\n *\r\n * It is represented like so:\r\n *\r\n * ```\r\n * | a | c | tx |\r\n * | b | d | ty |\r\n * | 0 | 0 | 1 |\r\n * ```\r\n *\r\n * @class TransformMatrix\r\n * @memberof Phaser.GameObjects.Components\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {number} [a=1] - The Scale X value.\r\n * @param {number} [b=0] - The Skew Y value.\r\n * @param {number} [c=0] - The Skew X value.\r\n * @param {number} [d=1] - The Scale Y value.\r\n * @param {number} [tx=0] - The Translate X value.\r\n * @param {number} [ty=0] - The Translate Y value.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "classdesc": "A TransformMatrix is a 3x3 affine transformation matrix used to encode\rthe position, rotation, scale, and skew of a Game Object for rendering.\r\rIt is used internally by Phaser during the render pipeline to accumulate\rparent-child transform chains and apply camera transformations. You will\rtypically interact with it when writing custom renderers or working with\rthe camera or display list transform pipeline.\r\rIt is represented like so:\r\r```\r| a | c | tx |\r| b | d | ty |\r| 0 | 0 | 1 |\r```", "kind": "class", "name": "TransformMatrix", "memberof": "Phaser.GameObjects.Components", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The Scale X value.", "name": "a" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The Skew Y value.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The Skew X value.", "name": "c" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The Scale Y value.", "name": "d" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The Translate X value.", "name": "tx" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The Translate Y value.", "name": "ty" } ], "scope": "static", "longname": "Phaser.GameObjects.Components.TransformMatrix", "___id": "T000002R009709", "___s": true }, { "comment": "/**\r\n * The matrix values.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#matrix\r\n * @type {Float32Array}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The matrix values.", "name": "matrix", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#matrix", "scope": "instance", "kind": "member", "___id": "T000002R009718", "___s": true }, { "comment": "/**\r\n * The decomposed matrix.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#decomposedMatrix\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The decomposed matrix.", "name": "decomposedMatrix", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#decomposedMatrix", "scope": "instance", "kind": "member", "___id": "T000002R009720", "___s": true }, { "comment": "/**\r\n * The temporary quad value cache.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#quad\r\n * @type {Float32Array}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 78, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The temporary quad value cache.", "name": "quad", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#quad", "scope": "instance", "kind": "member", "___id": "T000002R009727", "___s": true }, { "comment": "/**\r\n * The Scale X value.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#a\r\n * @type {number}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Scale X value.", "name": "a", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#a", "scope": "instance", "kind": "member", "___id": "T000002R009729", "___s": true }, { "comment": "/**\r\n * The Skew Y value.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#b\r\n * @type {number}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 109, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Skew Y value.", "name": "b", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#b", "scope": "instance", "kind": "member", "___id": "T000002R009734", "___s": true }, { "comment": "/**\r\n * The Skew X value.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#c\r\n * @type {number}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Skew X value.", "name": "c", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#c", "scope": "instance", "kind": "member", "___id": "T000002R009739", "___s": true }, { "comment": "/**\r\n * The Scale Y value.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#d\r\n * @type {number}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 151, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Scale Y value.", "name": "d", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#d", "scope": "instance", "kind": "member", "___id": "T000002R009744", "___s": true }, { "comment": "/**\r\n * The Translate X value.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#e\r\n * @type {number}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 172, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Translate X value.", "name": "e", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#e", "scope": "instance", "kind": "member", "___id": "T000002R009749", "___s": true }, { "comment": "/**\r\n * The Translate Y value.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#f\r\n * @type {number}\r\n * @since 3.11.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 193, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Translate Y value.", "name": "f", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.11.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#f", "scope": "instance", "kind": "member", "___id": "T000002R009754", "___s": true }, { "comment": "/**\r\n * The Translate X value.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#tx\r\n * @type {number}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 214, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Translate X value.", "name": "tx", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#tx", "scope": "instance", "kind": "member", "___id": "T000002R009759", "___s": true }, { "comment": "/**\r\n * The Translate Y value.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#ty\r\n * @type {number}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 235, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The Translate Y value.", "name": "ty", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#ty", "scope": "instance", "kind": "member", "___id": "T000002R009764", "___s": true }, { "comment": "/**\r\n * The rotation of the Matrix. Value is in radians.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#rotation\r\n * @type {number}\r\n * @readonly\r\n * @since 3.4.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 256, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The rotation of the Matrix. Value is in radians.", "name": "rotation", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.4.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#rotation", "scope": "instance", "kind": "member", "___id": "T000002R009769", "___s": true }, { "comment": "/**\r\n * The rotation of the Matrix, normalized to be within the Phaser right-handed\r\n * clockwise rotation space. Value is in radians.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#rotationNormalized\r\n * @type {number}\r\n * @readonly\r\n * @since 3.19.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 273, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The rotation of the Matrix, normalized to be within the Phaser right-handed\rclockwise rotation space. Value is in radians.", "name": "rotationNormalized", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.19.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#rotationNormalized", "scope": "instance", "kind": "member", "___id": "T000002R009772", "___s": true }, { "comment": "/**\r\n * The decomposed horizontal scale of the Matrix. This value is always positive.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#scaleX\r\n * @type {number}\r\n * @readonly\r\n * @since 3.4.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 313, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The decomposed horizontal scale of the Matrix. This value is always positive.", "name": "scaleX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.4.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#scaleX", "scope": "instance", "kind": "member", "___id": "T000002R009780", "___s": true }, { "comment": "/**\r\n * The decomposed vertical scale of the Matrix. This value is always positive.\r\n *\r\n * @name Phaser.GameObjects.Components.TransformMatrix#scaleY\r\n * @type {number}\r\n * @readonly\r\n * @since 3.4.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The decomposed vertical scale of the Matrix. This value is always positive.", "name": "scaleY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.4.0", "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#scaleY", "scope": "instance", "kind": "member", "___id": "T000002R009783", "___s": true }, { "comment": "/**\r\n * Reset the Matrix to an identity matrix.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#loadIdentity\r\n * @since 3.0.0\r\n *\r\n * @return {this} This TransformMatrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 347, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Reset the Matrix to an identity matrix.", "kind": "function", "name": "loadIdentity", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TransformMatrix." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#loadIdentity", "scope": "instance", "___id": "T000002R009786", "___s": true }, { "comment": "/**\r\n * Translate the Matrix.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#translate\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal translation value.\r\n * @param {number} y - The vertical translation value.\r\n *\r\n * @return {this} This TransformMatrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 369, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Translate the Matrix.", "kind": "function", "name": "translate", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal translation value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical translation value.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TransformMatrix." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#translate", "scope": "instance", "___id": "T000002R009795", "___s": true }, { "comment": "/**\r\n * Scale the Matrix.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#scale\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal scale value.\r\n * @param {number} y - The vertical scale value.\r\n *\r\n * @return {this} This TransformMatrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 390, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Scale the Matrix.", "kind": "function", "name": "scale", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal scale value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical scale value.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TransformMatrix." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#scale", "scope": "instance", "___id": "T000002R009800", "___s": true }, { "comment": "/**\r\n * Rotate the Matrix.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#rotate\r\n * @since 3.0.0\r\n *\r\n * @param {number} angle - The angle of rotation in radians.\r\n *\r\n * @return {this} This TransformMatrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 413, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Rotate the Matrix.", "kind": "function", "name": "rotate", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of rotation in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TransformMatrix." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#rotate", "scope": "instance", "___id": "T000002R009807", "___s": true }, { "comment": "/**\r\n * Multiply this Matrix by the given Matrix.\r\n *\r\n * If an `out` Matrix is given then the results will be stored in it.\r\n * If it is not given, this matrix will be updated in place instead.\r\n * Use an `out` Matrix if you do not wish to mutate this matrix.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#multiply\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} rhs - The Matrix to multiply by.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [out] - An optional Matrix to store the results in.\r\n *\r\n * @return {(this|Phaser.GameObjects.Components.TransformMatrix)} Either this TransformMatrix, or the `out` Matrix, if given in the arguments.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 443, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Multiply this Matrix by the given Matrix.\r\rIf an `out` Matrix is given then the results will be stored in it.\rIf it is not given, this matrix will be updated in place instead.\rUse 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The Matrix to multiply by.", "name": "rhs" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "An optional Matrix to store the results in.", "name": "out" } ], "returns": [ { "type": { "names": [ "this", "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "this", "reservedWord": true }, { "type": "NameExpression", "name": "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", "___id": "T000002R009820", "___s": true }, { "comment": "/**\r\n * Multiply this Matrix by the matrix given, including the offset.\r\n *\r\n * The offsetX is added to the tx value: `offsetX * a + offsetY * c + tx`.\r\n * The offsetY is added to the ty value: `offsetX * b + offsetY * d + ty`.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#multiplyWithOffset\r\n * @since 3.11.0\r\n *\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} src - The source Matrix to copy from.\r\n * @param {number} offsetX - Horizontal offset to factor in to the multiplication.\r\n * @param {number} offsetY - Vertical offset to factor in to the multiplication.\r\n *\r\n * @return {this} This TransformMatrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 489, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Multiply this Matrix by the matrix given, including the offset.\r\rThe offsetX is added to the tx value: `offsetX * a + offsetY * c + tx`.\rThe offsetY is added to the ty value: `offsetX * b + offsetY * d + ty`.", "kind": "function", "name": "multiplyWithOffset", "since": "3.11.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The source Matrix to copy from.", "name": "src" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal offset to factor in to the multiplication.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical offset to factor in to the multiplication.", "name": "offsetY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TransformMatrix." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#multiplyWithOffset", "scope": "instance", "___id": "T000002R009843", "___s": true }, { "comment": "/**\r\n * Transform the Matrix.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#transform\r\n * @since 3.0.0\r\n *\r\n * @param {number} a - The Scale X value.\r\n * @param {number} b - The Shear Y value.\r\n * @param {number} c - The Shear X value.\r\n * @param {number} d - The Scale Y value.\r\n * @param {number} tx - The Translate X value.\r\n * @param {number} ty - The Translate Y value.\r\n *\r\n * @return {this} This TransformMatrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 536, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Transform the Matrix.", "kind": "function", "name": "transform", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Scale X value.", "name": "a" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Shear Y value.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Shear X value.", "name": "c" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Scale Y value.", "name": "d" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Translate X value.", "name": "tx" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Translate Y value.", "name": "ty" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TransformMatrix." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#transform", "scope": "instance", "___id": "T000002R009867", "___s": true }, { "comment": "/**\r\n * Transform a point in to the local space of this Matrix.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#transformPoint\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate of the point to transform.\r\n * @param {number} y - The y coordinate of the point to transform.\r\n * @param {Phaser.Types.Math.Vector2Like} [point] - Optional Point object to store the transformed coordinates in.\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The Point containing the transformed coordinates.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Transform a point in to the local space of this Matrix.", "kind": "function", "name": "transformPoint", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the point to transform.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the point to transform.", "name": "y" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "Optional Point object to store the transformed coordinates in.", "name": "point" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The Point containing the transformed coordinates." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#transformPoint", "scope": "instance", "___id": "T000002R009882", "___s": true }, { "comment": "/**\r\n * Invert the Matrix.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#invert\r\n * @since 3.0.0\r\n *\r\n * @return {this} This TransformMatrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 603, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Invert the Matrix.", "kind": "function", "name": "invert", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TransformMatrix." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#invert", "scope": "instance", "___id": "T000002R009896", "___s": true }, { "comment": "/**\r\n * Set the values of this Matrix to copy those of the matrix given.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#copyFrom\r\n * @since 3.11.0\r\n *\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} src - The source Matrix to copy from.\r\n *\r\n * @return {this} This TransformMatrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 634, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The source Matrix to copy from.", "name": "src" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TransformMatrix." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#copyFrom", "scope": "instance", "___id": "T000002R009912", "___s": true }, { "comment": "/**\r\n * Set the values of this Matrix to copy those of the array given.\r\n * Where array indexes 0, 1, 2, 3, 4 and 5 are mapped to a, b, c, d, e and f.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#copyFromArray\r\n * @since 3.11.0\r\n *\r\n * @param {array} src - The array of values to set into this matrix.\r\n *\r\n * @return {this} This TransformMatrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 658, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Set the values of this Matrix to copy those of the array given.\rWhere 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" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "The array of values to set into this matrix.", "name": "src" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TransformMatrix." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#copyFromArray", "scope": "instance", "___id": "T000002R009921", "___s": true }, { "comment": "/**\r\n * Set the values of this Matrix to copy those of the matrix given,\r\n * combined with a camera scroll factor.\r\n *\r\n * This is used in many render functions.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#copyWithScrollFactorFrom\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} src - The source Matrix to copy from.\r\n * @param {number} scrollX - The horizontal scroll value to factor in.\r\n * @param {number} scrollY - The vertical scroll value to factor in.\r\n * @param {number} scrollFactorX - The horizontal scroll factor to apply.\r\n * @param {number} scrollFactorY - The vertical scroll factor to apply.\r\n *\r\n * @return {this} This TransformMatrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 683, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Set the values of this Matrix to copy those of the matrix given,\rcombined with a camera scroll factor.\r\rThis is used in many render functions.", "kind": "function", "name": "copyWithScrollFactorFrom", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The source Matrix to copy from.", "name": "src" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal scroll value to factor in.", "name": "scrollX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical scroll value to factor in.", "name": "scrollY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal scroll factor to apply.", "name": "scrollFactorX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical scroll factor to apply.", "name": "scrollFactorY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TransformMatrix." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#copyWithScrollFactorFrom", "scope": "instance", "___id": "T000002R009930", "___s": true }, { "comment": "/**\r\n * Copy the values from this Matrix to the given Canvas Rendering Context.\r\n * This will use the Context.transform method.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#copyToContext\r\n * @since 3.12.0\r\n *\r\n * @param {CanvasRenderingContext2D} ctx - The Canvas Rendering Context to copy the matrix values to.\r\n *\r\n * @return {CanvasRenderingContext2D} The Canvas Rendering Context.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 718, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Copy the values from this Matrix to the given Canvas Rendering Context.\rThis will use the Context.transform method.", "kind": "function", "name": "copyToContext", "since": "3.12.0", "params": [ { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "description": "The Canvas Rendering Context to copy the matrix values to.", "name": "ctx" } ], "returns": [ { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "description": "The Canvas Rendering Context." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#copyToContext", "scope": "instance", "___id": "T000002R009941", "___s": true }, { "comment": "/**\r\n * Copy the values from this Matrix to the given Canvas Rendering Context.\r\n * This will use the Context.setTransform method.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#setToContext\r\n * @since 3.12.0\r\n *\r\n * @param {CanvasRenderingContext2D} ctx - The Canvas Rendering Context to copy the matrix values to.\r\n *\r\n * @return {CanvasRenderingContext2D} The Canvas Rendering Context.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 738, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Copy the values from this Matrix to the given Canvas Rendering Context.\rThis will use the Context.setTransform method.", "kind": "function", "name": "setToContext", "since": "3.12.0", "params": [ { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "description": "The Canvas Rendering Context to copy the matrix values to.", "name": "ctx" } ], "returns": [ { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "description": "The Canvas Rendering Context." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#setToContext", "scope": "instance", "___id": "T000002R009944", "___s": true }, { "comment": "/**\r\n * Copy the values in this Matrix to the array given.\r\n *\r\n * Where array indexes 0, 1, 2, 3, 4 and 5 are mapped to a, b, c, d, e and f.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#copyToArray\r\n * @since 3.12.0\r\n *\r\n * @param {array} [out] - The array to copy the matrix values in to.\r\n *\r\n * @return {array} An array where elements 0 to 5 contain the values from this matrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 757, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Copy the values in this Matrix to the array given.\r\rWhere 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" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "The array to copy the matrix values in to.", "name": "out" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R009946", "___s": true }, { "comment": "/**\r\n * Set the values of this Matrix.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#setTransform\r\n * @since 3.0.0\r\n *\r\n * @param {number} a - The Scale X value.\r\n * @param {number} b - The Shear Y value.\r\n * @param {number} c - The Shear X value.\r\n * @param {number} d - The Scale Y value.\r\n * @param {number} tx - The Translate X value.\r\n * @param {number} ty - The Translate Y value.\r\n *\r\n * @return {this} This TransformMatrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 790, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Set the values of this Matrix.", "kind": "function", "name": "setTransform", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Scale X value.", "name": "a" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Shear Y value.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Shear X value.", "name": "c" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Scale Y value.", "name": "d" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Translate X value.", "name": "tx" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Translate Y value.", "name": "ty" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TransformMatrix." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#setTransform", "scope": "instance", "___id": "T000002R009956", "___s": true }, { "comment": "/**\r\n * Decompose this Matrix into its translation, scale and rotation values using QR decomposition.\r\n *\r\n * The result must be applied in the following order to reproduce the current matrix:\r\n *\r\n * translate -> rotate -> scale\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#decomposeMatrix\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.GameObjects.DecomposeMatrixResults} The decomposed Matrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 819, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Decompose this Matrix into its translation, scale and rotation values using QR decomposition.\r\rThe result must be applied in the following order to reproduce the current matrix:\r\rtranslate -> rotate -> scale", "kind": "function", "name": "decomposeMatrix", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.DecomposeMatrixResults" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.DecomposeMatrixResults" } }, "description": "The decomposed Matrix." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#decomposeMatrix", "scope": "instance", "___id": "T000002R009965", "___s": true }, { "comment": "/**\r\n * Apply the identity, translate, rotate and scale operations on the Matrix.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#applyITRS\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal translation.\r\n * @param {number} y - The vertical translation.\r\n * @param {number} rotation - The angle of rotation in radians.\r\n * @param {number} scaleX - The horizontal scale.\r\n * @param {number} scaleY - The vertical scale.\r\n *\r\n * @return {this} This TransformMatrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 878, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Apply the identity, translate, rotate and scale operations on the Matrix.", "kind": "function", "name": "applyITRS", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal translation.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical translation.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of rotation in radians.", "name": "rotation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal scale.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical scale.", "name": "scaleY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This TransformMatrix." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#applyITRS", "scope": "instance", "___id": "T000002R009987", "___s": true }, { "comment": "/**\r\n * Takes the `x` and `y` values and returns a new position in the `output` vector that is the inverse of\r\n * the current matrix with its transformation applied.\r\n *\r\n * Can be used to translate points from world to local space.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#applyInverse\r\n * @since 3.12.0\r\n *\r\n * @param {number} x - The x position to translate.\r\n * @param {number} y - The y position to translate.\r\n * @param {Phaser.Math.Vector2} [output] - A Vector2, or point-like object, to store the results in.\r\n *\r\n * @return {Phaser.Math.Vector2} The coordinates, inverse-transformed through this matrix.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 912, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Takes the `x` and `y` values and returns a new position in the `output` vector that is the inverse of\rthe current matrix with its transformation applied.\r\rCan be used to translate points from world to local space.", "kind": "function", "name": "applyInverse", "since": "3.12.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position to translate.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position to translate.", "name": "y" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The coordinates, inverse-transformed through this matrix." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#applyInverse", "scope": "instance", "___id": "T000002R009998", "___s": true }, { "comment": "/**\r\n * Performs the 8 calculations required to create the vertices of\r\n * a quad based on this matrix and the given vertex coordinates.\r\n *\r\n * The result is stored in `TransformMatrix.quad`, which is returned\r\n * from this method.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#setQuad\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The x value of the top-left vertex of the quad.\r\n * @param {number} y - The y value of the top-left vertex of the quad.\r\n * @param {number} xw - The x value of the bottom-right vertex of the quad. This is the x + width.\r\n * @param {number} yh - The y value of the bottom-right vertex of the quad. This is the y + height.\r\n * @param {Float32Array} [quad] - Optional Float32Array to store the results in. Otherwise uses the local quad array.\r\n *\r\n * @return {Float32Array} The quad Float32Array.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 948, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Performs the 8 calculations required to create the vertices of\ra quad based on this matrix and the given vertex coordinates.\r\rThe result is stored in `TransformMatrix.quad`, which is returned\rfrom this method.", "kind": "function", "name": "setQuad", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x value of the top-left vertex of the quad.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y value of the top-left vertex of the quad.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x value of the bottom-right vertex of the quad. This is the x + width.", "name": "xw" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y value of the bottom-right vertex of the quad. This is the y + height.", "name": "yh" }, { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "optional": true, "description": "Optional Float32Array to store the results in. Otherwise uses the local quad array.", "name": "quad" } ], "returns": [ { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The quad Float32Array." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#setQuad", "scope": "instance", "___id": "T000002R010011", "___s": true }, { "comment": "/**\r\n * Returns the X component of this matrix multiplied by the given values.\r\n * This is the same as `x * a + y * c + e`.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#getX\r\n * @since 3.12.0\r\n *\r\n * @param {number} x - The x value.\r\n * @param {number} y - The y value.\r\n *\r\n * @return {number} The calculated x value.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Returns the X component of this matrix multiplied by the given values.\rThis is the same as `x * a + y * c + e`.", "kind": "function", "name": "getX", "since": "3.12.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y value.", "name": "y" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The calculated x value." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#getX", "scope": "instance", "___id": "T000002R010029", "___s": true }, { "comment": "/**\r\n * Returns the Y component of this matrix multiplied by the given values.\r\n * This is the same as `x * b + y * d + f`.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#getY\r\n * @since 3.12.0\r\n *\r\n * @param {number} x - The x value.\r\n * @param {number} y - The y value.\r\n *\r\n * @return {number} The calculated y value.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 1011, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Returns the Y component of this matrix multiplied by the given values.\rThis is the same as `x * b + y * d + f`.", "kind": "function", "name": "getY", "since": "3.12.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y value.", "name": "y" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The calculated y value." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#getY", "scope": "instance", "___id": "T000002R010031", "___s": true }, { "comment": "/**\r\n * Returns the X component of this matrix multiplied by the given values.\r\n *\r\n * This is the same as `x * a + y * c + e`, optionally passing via `Math.round`.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#getXRound\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The x value.\r\n * @param {number} y - The y value.\r\n * @param {boolean} [round=false] - Math.round the resulting value?\r\n *\r\n * @return {number} The calculated x value.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 1028, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Returns the X component of this matrix multiplied by the given values.\r\rThis is the same as `x * a + y * c + e`, optionally passing via `Math.round`.", "kind": "function", "name": "getXRound", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y value.", "name": "y" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Math.round the resulting value?", "name": "round" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The calculated x value." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#getXRound", "scope": "instance", "___id": "T000002R010033", "___s": true }, { "comment": "/**\r\n * Returns the Y component of this matrix multiplied by the given values.\r\n *\r\n * This is the same as `x * b + y * d + f`, optionally passing via `Math.round`.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#getYRound\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The x value.\r\n * @param {number} y - The y value.\r\n * @param {boolean} [round=false] - Math.round the resulting value?\r\n *\r\n * @return {number} The calculated y value.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 1054, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Returns the Y component of this matrix multiplied by the given values.\r\rThis is the same as `x * b + y * d + f`, optionally passing via `Math.round`.", "kind": "function", "name": "getYRound", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y value.", "name": "y" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Math.round the resulting value?", "name": "round" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The calculated y value." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#getYRound", "scope": "instance", "___id": "T000002R010037", "___s": true }, { "comment": "/**\r\n * Returns a string that can be used in a CSS Transform call as a `matrix` property.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#getCSSMatrix\r\n * @since 3.12.0\r\n *\r\n * @return {string} A string containing the CSS Transform matrix values.\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 1080, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A string containing the CSS Transform matrix values." } ], "memberof": "Phaser.GameObjects.Components.TransformMatrix", "longname": "Phaser.GameObjects.Components.TransformMatrix#getCSSMatrix", "scope": "instance", "___id": "T000002R010041", "___s": true }, { "comment": "/**\r\n * Destroys this Transform Matrix.\r\n *\r\n * @method Phaser.GameObjects.Components.TransformMatrix#destroy\r\n * @since 3.4.0\r\n */", "meta": { "filename": "TransformMatrix.js", "lineno": 1095, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "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", "___id": "T000002R010044", "___s": true }, { "comment": "/**\r\n * Provides methods used for setting the visibility of a Game Object.\r\n * The Visible component is mixed into Game Objects to give them a `visible` boolean property\r\n * and a `setVisible` method. Visibility is tracked via a bitmask flag on `renderFlags`, so\r\n * toggling it is a fast bitwise operation. An invisible Game Object is excluded from the\r\n * render pass entirely, but its `update` logic continues to run normally each frame.\r\n * Should be applied as a mixin and not used directly.\r\n *\r\n * @namespace Phaser.GameObjects.Components.Visible\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Visible.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Provides methods used for setting the visibility of a Game Object.\rThe Visible component is mixed into Game Objects to give them a `visible` boolean property\rand a `setVisible` method. Visibility is tracked via a bitmask flag on `renderFlags`, so\rtoggling it is a fast bitwise operation. An invisible Game Object is excluded from the\rrender pass entirely, but its `update` logic continues to run normally each frame.\rShould 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", "___id": "T000002R010051", "___s": true }, { "comment": "/**\r\n * The visible state of the Game Object.\r\n *\r\n * An invisible Game Object will skip rendering, but will still process update logic.\r\n *\r\n * @name Phaser.GameObjects.Components.Visible#visible\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Visible.js", "lineno": 35, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "The visible state of the Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "name": "visible", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Components.Visible", "longname": "Phaser.GameObjects.Components.Visible#visible", "scope": "instance", "kind": "member", "___id": "T000002R010055", "___s": true }, { "comment": "/**\r\n * Sets the visibility of this Game Object.\r\n *\r\n * An invisible Game Object will skip rendering, but will still process update logic.\r\n *\r\n * @method Phaser.GameObjects.Components.Visible#setVisible\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - The visible state of the Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Visible.js", "lineno": 67, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\components", "code": {} }, "description": "Sets the visibility of this Game Object.\r\rAn invisible Game Object will skip rendering, but will still process update logic.", "kind": "function", "name": "setVisible", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Components.Visible", "longname": "Phaser.GameObjects.Components.Visible#setVisible", "scope": "instance", "___id": "T000002R010063", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Container Game Object.\r\n *\r\n * A Container, as the name implies, can 'contain' other types of Game Object.\r\n * When a Game Object is added to a Container, the Container becomes responsible for the rendering of it.\r\n * By default it will be removed from the Display List and instead added to the Containers own internal list.\r\n *\r\n * The position of the Game Object automatically becomes relative to the position of the Container.\r\n *\r\n * The transform point of a Container is 0x0 (in local space) and that cannot be changed. The children you add to the\r\n * Container should be positioned with this value in mind. I.e. you should treat 0x0 as being the center of\r\n * the Container, and position children positively and negative around it as required.\r\n *\r\n * When the Container is rendered, all of its children are rendered as well, in the order in which they exist\r\n * within the Container. Container children can be repositioned using methods such as `MoveUp`, `MoveDown` and `SendToBack`.\r\n *\r\n * If you modify a transform property of the Container, such as `Container.x` or `Container.rotation` then it will\r\n * automatically influence all children as well.\r\n *\r\n * Containers can include other Containers for deeply nested transforms.\r\n *\r\n * Containers can have masks set on them and can be used as a mask too.\r\n * Because masks are filters, the container's children can also have masks,\r\n * and the Container's mask will be applied over the top.\r\n * In Canvas rendering, only the Container's mask will be applied.\r\n *\r\n * Containers can be enabled for input. Because they do not have a texture you need to provide a shape for them\r\n * to use as their hit area. Container children can also be enabled for input, independent of the Container.\r\n *\r\n * If input enabling a _child_ you should not set both the `origin` and a **negative** scale factor on the child,\r\n * or the input area will become misaligned.\r\n *\r\n * Containers can be given a physics body for either Arcade Physics, Impact Physics or Matter Physics. However,\r\n * if Container _children_ are enabled for physics you may get unexpected results, such as offset bodies,\r\n * if the Container itself, or any of its ancestors, is positioned anywhere other than at 0 x 0. Container children\r\n * with physics do not factor in the Container due to the excessive extra calculations needed. Please structure\r\n * your game to work around this.\r\n *\r\n * It's important to understand the impact of using Containers. They add additional processing overhead into\r\n * every one of their children. The deeper you nest them, the more the cost escalates. This is especially true\r\n * for input events. You also lose the ability to set the display depth of Container children in the same\r\n * flexible manner as those not within them. In short, don't use them for the sake of it. You pay a small cost\r\n * every time you create one, try to structure your game around avoiding that where possible.\r\n *\r\n * @class Container\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.4.0\r\n *\r\n * @extends Phaser.GameObjects.Components.AlphaSingle\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.ComputedSize\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {Phaser.GameObjects.GameObject[]} [children] - An optional array of Game Objects to add to this Container.\r\n */", "meta": { "filename": "Container.js", "lineno": 22, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "classdesc": "A Container Game Object.\r\rA Container, as the name implies, can 'contain' other types of Game Object.\rWhen a Game Object is added to a Container, the Container becomes responsible for the rendering of it.\rBy default it will be removed from the Display List and instead added to the Containers own internal list.\r\rThe position of the Game Object automatically becomes relative to the position of the Container.\r\rThe transform point of a Container is 0x0 (in local space) and that cannot be changed. The children you add to the\rContainer should be positioned with this value in mind. I.e. you should treat 0x0 as being the center of\rthe Container, and position children positively and negative around it as required.\r\rWhen the Container is rendered, all of its children are rendered as well, in the order in which they exist\rwithin the Container. Container children can be repositioned using methods such as `MoveUp`, `MoveDown` and `SendToBack`.\r\rIf you modify a transform property of the Container, such as `Container.x` or `Container.rotation` then it will\rautomatically influence all children as well.\r\rContainers can include other Containers for deeply nested transforms.\r\rContainers can have masks set on them and can be used as a mask too.\rBecause masks are filters, the container's children can also have masks,\rand the Container's mask will be applied over the top.\rIn Canvas rendering, only the Container's mask will be applied.\r\rContainers can be enabled for input. Because they do not have a texture you need to provide a shape for them\rto use as their hit area. Container children can also be enabled for input, independent of the Container.\r\rIf input enabling a _child_ you should not set both the `origin` and a **negative** scale factor on the child,\ror the input area will become misaligned.\r\rContainers can be given a physics body for either Arcade Physics, Impact Physics or Matter Physics. However,\rif Container _children_ are enabled for physics you may get unexpected results, such as offset bodies,\rif the Container itself, or any of its ancestors, is positioned anywhere other than at 0 x 0. Container children\rwith physics do not factor in the Container due to the excessive extra calculations needed. Please structure\ryour game to work around this.\r\rIt's important to understand the impact of using Containers. They add additional processing overhead into\revery one of their children. The deeper you nest them, the more the cost escalates. This is especially true\rfor input events. You also lose the ability to set the display depth of Container children in the same\rflexible manner as those not within them. In short, don't use them for the sake of it. You pay a small cost\revery 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of Game Objects to add to this Container.", "name": "children" } ], "scope": "static", "longname": "Phaser.GameObjects.Container", "___id": "T000002R010079", "___s": true }, { "comment": "/**\r\n * An array holding the children of this Container.\r\n *\r\n * @name Phaser.GameObjects.Container#list\r\n * @type {Phaser.GameObjects.GameObject[]}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "An array holding the children of this Container.", "name": "list", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#list", "scope": "instance", "kind": "member", "___id": "T000002R010084", "___s": true }, { "comment": "/**\r\n * Does this Container exclusively manage its children?\r\n *\r\n * The default is `true` which means a child added to this Container cannot\r\n * belong in another Container, which includes the Scene display list.\r\n *\r\n * If you disable this then this Container will no longer exclusively manage its children.\r\n * This allows you to create all kinds of interesting graphical effects, such as replicating\r\n * Game Objects without reparenting them all over the Scene.\r\n * However, doing so will prevent children from receiving any kind of input event or have\r\n * their physics bodies work by default, as they're no longer a single entity on the\r\n * display list, but are being replicated where-ever this Container is.\r\n *\r\n * @name Phaser.GameObjects.Container#exclusive\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Does this Container exclusively manage its children?\r\rThe default is `true` which means a child added to this Container cannot\rbelong in another Container, which includes the Scene display list.\r\rIf you disable this then this Container will no longer exclusively manage its children.\rThis allows you to create all kinds of interesting graphical effects, such as replicating\rGame Objects without reparenting them all over the Scene.\rHowever, doing so will prevent children from receiving any kind of input event or have\rtheir physics bodies work by default, as they're no longer a single entity on the\rdisplay list, but are being replicated where-ever this Container is.", "name": "exclusive", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#exclusive", "scope": "instance", "kind": "member", "___id": "T000002R010086", "___s": true }, { "comment": "/**\r\n * Containers can have an optional maximum size. If set to anything above 0 it\r\n * will constrict the addition of new Game Objects into the Container, capping off\r\n * the maximum limit the Container can grow in size to.\r\n *\r\n * @name Phaser.GameObjects.Container#maxSize\r\n * @type {number}\r\n * @default -1\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Containers can have an optional maximum size. If set to anything above 0 it\rwill constrict the addition of new Game Objects into the Container, capping off\rthe maximum limit the Container can grow in size to.", "name": "maxSize", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#maxSize", "scope": "instance", "kind": "member", "___id": "T000002R010088", "___s": true }, { "comment": "/**\r\n * An internal cursor position used for iterating through the Container's children\r\n * via methods such as `first`, `next`, `previous` and `last`.\r\n *\r\n * @name Phaser.GameObjects.Container#position\r\n * @type {number}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "An internal cursor position used for iterating through the Container's children\rvia methods such as `first`, `next`, `previous` and `last`.", "name": "position", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#position", "scope": "instance", "kind": "member", "___id": "T000002R010090", "___s": true }, { "comment": "/**\r\n * Internal Transform Matrix used for local space conversion.\r\n *\r\n * @name Phaser.GameObjects.Container#localTransform\r\n * @type {Phaser.GameObjects.Components.TransformMatrix}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 158, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Internal Transform Matrix used for local space conversion.", "name": "localTransform", "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#localTransform", "scope": "instance", "kind": "member", "___id": "T000002R010092", "___s": true }, { "comment": "/**\r\n * The horizontal scroll factor of this Container.\r\n *\r\n * The scroll factor controls the influence of the movement of a Camera upon this Container.\r\n *\r\n * When a camera scrolls it will change the location at which this Container is rendered on-screen.\r\n * It does not change the Containers actual position values.\r\n *\r\n * For a Container, setting this value will only update the Container itself, not its children.\r\n * If you wish to change the scrollFactor of the children as well, use the `setScrollFactor` method.\r\n *\r\n * A value of 1 means it will move exactly in sync with a camera.\r\n * A value of 0 means it will not move at all, even if the camera moves.\r\n * Other values control the degree to which the camera movement is mapped to this Container.\r\n *\r\n * Please be aware that scroll factor values other than 1 are not taken in to consideration when\r\n * calculating physics collisions. Bodies always collide based on their world position, but changing\r\n * the scroll factor is a visual adjustment to where the textures are rendered, which can offset\r\n * them from physics bodies if not accounted for in your code.\r\n *\r\n * @name Phaser.GameObjects.Container#scrollFactorX\r\n * @type {number}\r\n * @default 1\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "The horizontal scroll factor of this Container.\r\rThe scroll factor controls the influence of the movement of a Camera upon this Container.\r\rWhen a camera scrolls it will change the location at which this Container is rendered on-screen.\rIt does not change the Containers actual position values.\r\rFor a Container, setting this value will only update the Container itself, not its children.\rIf you wish to change the scrollFactor of the children as well, use the `setScrollFactor` method.\r\rA value of 1 means it will move exactly in sync with a camera.\rA value of 0 means it will not move at all, even if the camera moves.\rOther values control the degree to which the camera movement is mapped to this Container.\r\rPlease be aware that scroll factor values other than 1 are not taken in to consideration when\rcalculating physics collisions. Bodies always collide based on their world position, but changing\rthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\rthem from physics bodies if not accounted for in your code.", "name": "scrollFactorX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#scrollFactorX", "scope": "instance", "kind": "member", "___id": "T000002R010098", "___s": true }, { "comment": "/**\r\n * The vertical scroll factor of this Container.\r\n *\r\n * The scroll factor controls the influence of the movement of a Camera upon this Container.\r\n *\r\n * When a camera scrolls it will change the location at which this Container is rendered on-screen.\r\n * It does not change the Containers actual position values.\r\n *\r\n * For a Container, setting this value will only update the Container itself, not its children.\r\n * If you wish to change the scrollFactor of the children as well, use the `setScrollFactor` method.\r\n *\r\n * A value of 1 means it will move exactly in sync with a camera.\r\n * A value of 0 means it will not move at all, even if the camera moves.\r\n * Other values control the degree to which the camera movement is mapped to this Container.\r\n *\r\n * Please be aware that scroll factor values other than 1 are not taken in to consideration when\r\n * calculating physics collisions. Bodies always collide based on their world position, but changing\r\n * the scroll factor is a visual adjustment to where the textures are rendered, which can offset\r\n * them from physics bodies if not accounted for in your code.\r\n *\r\n * @name Phaser.GameObjects.Container#scrollFactorY\r\n * @type {number}\r\n * @default 1\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 214, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "The vertical scroll factor of this Container.\r\rThe scroll factor controls the influence of the movement of a Camera upon this Container.\r\rWhen a camera scrolls it will change the location at which this Container is rendered on-screen.\rIt does not change the Containers actual position values.\r\rFor a Container, setting this value will only update the Container itself, not its children.\rIf you wish to change the scrollFactor of the children as well, use the `setScrollFactor` method.\r\rA value of 1 means it will move exactly in sync with a camera.\rA value of 0 means it will not move at all, even if the camera moves.\rOther values control the degree to which the camera movement is mapped to this Container.\r\rPlease be aware that scroll factor values other than 1 are not taken in to consideration when\rcalculating physics collisions. Bodies always collide based on their world position, but changing\rthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\rthem from physics bodies if not accounted for in your code.", "name": "scrollFactorY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#scrollFactorY", "scope": "instance", "kind": "member", "___id": "T000002R010100", "___s": true }, { "comment": "/**\r\n * Internal value to allow Containers to be used for input and physics.\r\n * Do not change this value. It has no effect other than to break things.\r\n *\r\n * @name Phaser.GameObjects.Container#originX\r\n * @type {number}\r\n * @readonly\r\n * @override\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Internal value to allow Containers to be used for input and physics.\rDo not change this value. It has no effect other than to break things.", "name": "originX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "override": true, "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#originX", "scope": "instance", "kind": "member", "___id": "T000002R010102", "___s": true }, { "comment": "/**\r\n * Internal value to allow Containers to be used for input and physics.\r\n * Do not change this value. It has no effect other than to break things.\r\n *\r\n * @name Phaser.GameObjects.Container#originY\r\n * @type {number}\r\n * @readonly\r\n * @override\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 270, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Internal value to allow Containers to be used for input and physics.\rDo not change this value. It has no effect other than to break things.", "name": "originY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "override": true, "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#originY", "scope": "instance", "kind": "member", "___id": "T000002R010105", "___s": true }, { "comment": "/**\r\n * Internal value to allow Containers to be used for input and physics.\r\n * Do not change this value. It has no effect other than to break things.\r\n *\r\n * @name Phaser.GameObjects.Container#displayOriginX\r\n * @type {number}\r\n * @readonly\r\n * @override\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Internal value to allow Containers to be used for input and physics.\rDo not change this value. It has no effect other than to break things.", "name": "displayOriginX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "override": true, "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#displayOriginX", "scope": "instance", "kind": "member", "___id": "T000002R010108", "___s": true }, { "comment": "/**\r\n * Internal value to allow Containers to be used for input and physics.\r\n * Do not change this value. It has no effect other than to break things.\r\n *\r\n * @name Phaser.GameObjects.Container#displayOriginY\r\n * @type {number}\r\n * @readonly\r\n * @override\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 308, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Internal value to allow Containers to be used for input and physics.\rDo not change this value. It has no effect other than to break things.", "name": "displayOriginY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "override": true, "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#displayOriginY", "scope": "instance", "kind": "member", "___id": "T000002R010111", "___s": true }, { "comment": "/**\r\n * Does this Container exclusively manage its children?\r\n *\r\n * The default is `true` which means a child added to this Container cannot\r\n * belong in another Container, which includes the Scene display list.\r\n *\r\n * If you disable this then this Container will no longer exclusively manage its children.\r\n * This allows you to create all kinds of interesting graphical effects, such as replicating\r\n * Game Objects without reparenting them all over the Scene.\r\n * However, doing so will prevent children from receiving any kind of input event or have\r\n * their physics bodies work by default, as they're no longer a single entity on the\r\n * display list, but are being replicated where-ever this Container is.\r\n *\r\n * @method Phaser.GameObjects.Container#setExclusive\r\n * @since 3.4.0\r\n *\r\n * @param {boolean} [value=true] - The exclusive state of this Container.\r\n *\r\n * @return {this} This Container.\r\n */", "meta": { "filename": "Container.js", "lineno": 327, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Does this Container exclusively manage its children?\r\rThe default is `true` which means a child added to this Container cannot\rbelong in another Container, which includes the Scene display list.\r\rIf you disable this then this Container will no longer exclusively manage its children.\rThis allows you to create all kinds of interesting graphical effects, such as replicating\rGame Objects without reparenting them all over the Scene.\rHowever, doing so will prevent children from receiving any kind of input event or have\rtheir physics bodies work by default, as they're no longer a single entity on the\rdisplay list, but are being replicated where-ever this Container is.", "kind": "function", "name": "setExclusive", "since": "3.4.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "The exclusive state of this Container.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#setExclusive", "scope": "instance", "___id": "T000002R010114", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this Container. It works by iterating all children of the Container,\r\n * getting their respective bounds, and then working out a min-max rectangle from that.\r\n * It does not factor in if the children render or not, all are included.\r\n *\r\n * Some children are unable to return their bounds, such as Graphics objects, in which case\r\n * they are skipped.\r\n *\r\n * Depending on the quantity of children in this Container it could be a really expensive call,\r\n * so cache it and only poll it as needed.\r\n *\r\n * The values are stored and returned in a Rectangle object.\r\n *\r\n * @method Phaser.GameObjects.Container#getBounds\r\n * @since 3.4.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} [output] - A Geom.Rectangle object to store the values in. If not provided a new Rectangle will be created.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The values stored in the output object.\r\n */", "meta": { "filename": "Container.js", "lineno": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Gets the bounds of this Container. It works by iterating all children of the Container,\rgetting their respective bounds, and then working out a min-max rectangle from that.\rIt does not factor in if the children render or not, all are included.\r\rSome children are unable to return their bounds, such as Graphics objects, in which case\rthey are skipped.\r\rDepending on the quantity of children in this Container it could be a really expensive call,\rso cache it and only poll it as needed.\r\rThe values are stored and returned in a Rectangle object.", "kind": "function", "name": "getBounds", "since": "3.4.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The values stored in the output object." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#getBounds", "scope": "instance", "___id": "T000002R010118", "___s": true }, { "comment": "/**\r\n * Takes a Point-like object, such as a Vector2, or object with public x and y properties,\r\n * and transforms it into the space of this Container, then returns it in the output object.\r\n *\r\n * @method Phaser.GameObjects.Container#pointToContainer\r\n * @since 3.4.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} source - The Source Point to be transformed.\r\n * @param {Phaser.Types.Math.Vector2Like} [output] - A destination object to store the transformed point in. If none given a Vector2 will be created and returned.\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like} The transformed point.\r\n */", "meta": { "filename": "Container.js", "lineno": 473, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Takes a Point-like object, such as a Vector2, or object with public x and y properties,\rand 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": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The Source Point to be transformed.", "name": "source" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "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": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The transformed point." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#pointToContainer", "scope": "instance", "___id": "T000002R010135", "___s": true }, { "comment": "/**\r\n * Returns the world transform matrix as used for Bounds checks.\r\n *\r\n * The returned matrix is temporary and shouldn't be stored.\r\n *\r\n * @method Phaser.GameObjects.Container#getBoundsTransformMatrix\r\n * @since 3.4.0\r\n *\r\n * @return {Phaser.GameObjects.Components.TransformMatrix} The world transform matrix.\r\n */", "meta": { "filename": "Container.js", "lineno": 511, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Returns the world transform matrix as used for Bounds checks.\r\rThe returned matrix is temporary and shouldn't be stored.", "kind": "function", "name": "getBoundsTransformMatrix", "since": "3.4.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The world transform matrix." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#getBoundsTransformMatrix", "scope": "instance", "___id": "T000002R010141", "___s": true }, { "comment": "/**\r\n * Adds the given Game Object, or array of Game Objects, to this Container.\r\n *\r\n * Each Game Object must be unique within the Container.\r\n *\r\n * If you try to add a Layer, it will throw an error.\r\n *\r\n * @method Phaser.GameObjects.Container#add\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {(T|T[])} - [child]\r\n *\r\n * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} child - The Game Object, or array of Game Objects, to add to the Container.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 526, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Adds the given Game Object, or array of Game Objects, to this Container.\r\rEach Game Object must be unique within the Container.\r\rIf you try to add a Layer, it will throw an error.", "kind": "function", "name": "add", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|T[])} - [child]", "value": "{(T|T[])} - [child]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The Game Object, or array of Game Objects, to add to the Container.", "name": "child" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#add", "scope": "instance", "___id": "T000002R010143", "___s": true }, { "comment": "/**\r\n * Adds the given Game Object, or array of Game Objects, to this Container at the specified position.\r\n *\r\n * Existing Game Objects in the Container are shifted up.\r\n *\r\n * Each Game Object must be unique within the Container.\r\n *\r\n * @method Phaser.GameObjects.Container#addAt\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {(T|T[])} - [child]\r\n *\r\n * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} child - The Game Object, or array of Game Objects, to add to the Container.\r\n * @param {number} [index=0] - The position to insert the Game Object/s at.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 565, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Adds the given Game Object, or array of Game Objects, to this Container at the specified position.\r\rExisting Game Objects in the Container are shifted up.\r\rEach Game Object must be unique within the Container.", "kind": "function", "name": "addAt", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|T[])} - [child]", "value": "{(T|T[])} - [child]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The Game Object, or array of Game Objects, to add to the Container.", "name": "child" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The position to insert the Game Object/s at.", "name": "index" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#addAt", "scope": "instance", "___id": "T000002R010145", "___s": true }, { "comment": "/**\r\n * Returns the Game Object at the given position in this Container.\r\n *\r\n * @method Phaser.GameObjects.Container#getAt\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [$return]\r\n *\r\n * @param {number} index - The position to get the Game Object from.\r\n *\r\n * @return {?Phaser.GameObjects.GameObject} The Game Object at the specified index, or `null` if none found.\r\n */", "meta": { "filename": "Container.js", "lineno": 590, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Returns the Game Object at the given position in this Container.", "kind": "function", "name": "getAt", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The position to get the Game Object from.", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "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", "___id": "T000002R010147", "___s": true }, { "comment": "/**\r\n * Returns the index of the given Game Object in this Container.\r\n *\r\n * @method Phaser.GameObjects.Container#getIndex\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [child]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The Game Object to search for in this Container.\r\n *\r\n * @return {number} The index of the Game Object in this Container, or -1 if not found.\r\n */", "meta": { "filename": "Container.js", "lineno": 608, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Returns the index of the given Game Object in this Container.", "kind": "function", "name": "getIndex", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child]", "value": "{T} - [child]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to search for in this Container.", "name": "child" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R010149", "___s": true }, { "comment": "/**\r\n * Sort the contents of this Container so the items are in order based on the given property.\r\n * For example: `sort('alpha')` would sort the elements based on the value of their `alpha` property.\r\n *\r\n * @method Phaser.GameObjects.Container#sort\r\n * @since 3.4.0\r\n *\r\n * @param {string} property - The property to lexically sort by.\r\n * @param {function} [handler] - Provide your own custom handler function. Will receive 2 children which it should compare and return a negative, zero, or positive number.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 626, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Sort the contents of this Container so the items are in order based on the given property.\rFor 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to lexically sort by.", "name": "property" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "Provide your own custom handler function. Will receive 2 children which it should compare and return a negative, zero, or positive number.", "name": "handler" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#sort", "scope": "instance", "___id": "T000002R010151", "___s": true }, { "comment": "/**\r\n * Searches for the first instance of a child with its `name` property matching the given argument.\r\n * Should more than one child have the same name only the first is returned.\r\n *\r\n * @method Phaser.GameObjects.Container#getByName\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [$return]\r\n *\r\n * @param {string} name - The name to search for.\r\n *\r\n * @return {?Phaser.GameObjects.GameObject} The first child with a matching name, or `null` if none were found.\r\n */", "meta": { "filename": "Container.js", "lineno": 658, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Searches for the first instance of a child with its `name` property matching the given argument.\rShould more than one child have the same name only the first is returned.", "kind": "function", "name": "getByName", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to search for.", "name": "name" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "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", "___id": "T000002R010154", "___s": true }, { "comment": "/**\r\n * Returns a random Game Object from this Container.\r\n *\r\n * @method Phaser.GameObjects.Container#getRandom\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [$return]\r\n *\r\n * @param {number} [startIndex=0] - An optional start index.\r\n * @param {number} [length] - An optional length, the total number of elements (from the startIndex) to choose from.\r\n *\r\n * @return {?Phaser.GameObjects.GameObject} A random child from the Container, or `null` if the Container is empty.\r\n */", "meta": { "filename": "Container.js", "lineno": 677, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Returns a random Game Object from this Container.", "kind": "function", "name": "getRandom", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional start index.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "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", "___id": "T000002R010156", "___s": true }, { "comment": "/**\r\n * Gets the first Game Object in this Container.\r\n *\r\n * You can also specify a property and value to search for, in which case it will return the first\r\n * Game Object in this Container with a matching property and / or value.\r\n *\r\n * For example: `getFirst('visible', true)` would return the first Game Object that had its `visible` property set.\r\n *\r\n * You can limit the search to the `startIndex` - `endIndex` range.\r\n *\r\n * @method Phaser.GameObjects.Container#getFirst\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [$return]\r\n *\r\n * @param {string} property - The property to test on each Game Object in the Container.\r\n * @param {*} value - The value to test the property against. Must pass a strict (`===`) comparison check.\r\n * @param {number} [startIndex=0] - An optional start index to search from.\r\n * @param {number} [endIndex=Container.length] - An optional end index to search up to (but not included)\r\n *\r\n * @return {?Phaser.GameObjects.GameObject} The first matching Game Object, or `null` if none was found.\r\n */", "meta": { "filename": "Container.js", "lineno": 696, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Gets the first Game Object in this Container.\r\rYou can also specify a property and value to search for, in which case it will return the first\rGame Object in this Container with a matching property and / or value.\r\rFor example: `getFirst('visible', true)` would return the first Game Object that had its `visible` property set.\r\rYou can limit the search to the `startIndex` - `endIndex` range.", "kind": "function", "name": "getFirst", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [$return]", "value": "{T} - [$return]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to test on each Game Object in the Container.", "name": "property" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The value to test the property against. Must pass a strict (`===`) comparison check.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional start index to search from.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "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", "___id": "T000002R010158", "___s": true }, { "comment": "/**\r\n * Returns all Game Objects in this Container.\r\n *\r\n * You can optionally specify a matching criteria using the `property` and `value` arguments.\r\n *\r\n * For example: `getAll('body')` would return only Game Objects that have a body property.\r\n *\r\n * You can also specify a value to compare the property to:\r\n *\r\n * `getAll('visible', true)` would return only Game Objects that have their visible property set to `true`.\r\n *\r\n * Optionally you can specify a start and end index. For example if this Container had 100 Game Objects,\r\n * and you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\r\n * the first 50 Game Objects.\r\n *\r\n * @method Phaser.GameObjects.Container#getAll\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T[]} - [$return]\r\n *\r\n * @param {string} [property] - The property to test on each Game Object in the Container.\r\n * @param {any} [value] - If property is set then the `property` must strictly equal this value to be included in the results.\r\n * @param {number} [startIndex=0] - An optional start index to search from.\r\n * @param {number} [endIndex=Container.length] - An optional end index to search up to (but not included)\r\n *\r\n * @return {Phaser.GameObjects.GameObject[]} An array of matching Game Objects from this Container.\r\n */", "meta": { "filename": "Container.js", "lineno": 724, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Returns all Game Objects in this Container.\r\rYou can optionally specify a matching criteria using the `property` and `value` arguments.\r\rFor example: `getAll('body')` would return only Game Objects that have a body property.\r\rYou can also specify a value to compare the property to:\r\r`getAll('visible', true)` would return only Game Objects that have their visible property set to `true`.\r\rOptionally you can specify a start and end index. For example if this Container had 100 Game Objects,\rand you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\rthe first 50 Game Objects.", "kind": "function", "name": "getAll", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T[]} - [$return]", "value": "{T[]} - [$return]" } ], "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The property to test on each Game Object in the Container.", "name": "property" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional start index to search from.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "Container.length", "description": "An optional end index to search up to (but not included)", "name": "endIndex" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "An array of matching Game Objects from this Container." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#getAll", "scope": "instance", "___id": "T000002R010160", "___s": true }, { "comment": "/**\r\n * Returns the total number of Game Objects in this Container that have a property\r\n * matching the given value.\r\n *\r\n * For example: `count('visible', true)` would count all the elements that have their visible property set.\r\n *\r\n * You can optionally limit the operation to the `startIndex` - `endIndex` range.\r\n *\r\n * @method Phaser.GameObjects.Container#count\r\n * @since 3.4.0\r\n *\r\n * @param {string} property - The property to check.\r\n * @param {any} value - The value to check.\r\n * @param {number} [startIndex=0] - An optional start index to search from.\r\n * @param {number} [endIndex=Container.length] - An optional end index to search up to (but not included)\r\n *\r\n * @return {number} The total number of Game Objects in this Container with a property matching the given value.\r\n */", "meta": { "filename": "Container.js", "lineno": 757, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Returns the total number of Game Objects in this Container that have a property\rmatching the given value.\r\rFor example: `count('visible', true)` would count all the elements that have their visible property set.\r\rYou can optionally limit the operation to the `startIndex` - `endIndex` range.", "kind": "function", "name": "count", "since": "3.4.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to check.", "name": "property" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The value to check.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional start index to search from.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "Container.length", "description": "An optional end index to search up to (but not included)", "name": "endIndex" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R010162", "___s": true }, { "comment": "/**\r\n * Swaps the position of two Game Objects in this Container.\r\n * Both Game Objects must belong to this Container.\r\n *\r\n * @method Phaser.GameObjects.Container#swap\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [child1,child2]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child1 - The first Game Object to swap.\r\n * @param {Phaser.GameObjects.GameObject} child2 - The second Game Object to swap.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 780, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Swaps the position of two Game Objects in this Container.\rBoth Game Objects must belong to this Container.", "kind": "function", "name": "swap", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child1,child2]", "value": "{T} - [child1,child2]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The first Game Object to swap.", "name": "child1" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The second Game Object to swap.", "name": "child2" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#swap", "scope": "instance", "___id": "T000002R010164", "___s": true }, { "comment": "/**\r\n * Moves a Game Object to a new position within this Container.\r\n *\r\n * The Game Object must already be a child of this Container.\r\n *\r\n * The Game Object is removed from its old position and inserted into the new one.\r\n * Therefore the Container size does not change. Other children will change position accordingly.\r\n *\r\n * @method Phaser.GameObjects.Container#moveTo\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [child]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The Game Object to move.\r\n * @param {number} index - The new position of the Game Object in this Container.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 802, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Moves a Game Object to a new position within this Container.\r\rThe Game Object must already be a child of this Container.\r\rThe Game Object is removed from its old position and inserted into the new one.\rTherefore the Container size does not change. Other children will change position accordingly.", "kind": "function", "name": "moveTo", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child]", "value": "{T} - [child]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to move.", "name": "child" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new position of the Game Object in this Container.", "name": "index" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#moveTo", "scope": "instance", "___id": "T000002R010166", "___s": true }, { "comment": "/**\r\n * Moves a Game Object above another one within this Container.\r\n * If the Game Object is already above the other, it isn't moved.\r\n *\r\n * These 2 Game Objects must already be children of this Container.\r\n *\r\n * @method Phaser.GameObjects.Container#moveAbove\r\n * @since 3.55.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [child1,child2]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child1 - The Game Object to move above base Game Object.\r\n * @param {Phaser.GameObjects.GameObject} child2 - The base Game Object.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 828, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Moves a Game Object above another one within this Container.\rIf the Game Object is already above the other, it isn't moved.\r\rThese 2 Game Objects must already be children of this Container.", "kind": "function", "name": "moveAbove", "since": "3.55.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child1,child2]", "value": "{T} - [child1,child2]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to move above base Game Object.", "name": "child1" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The base Game Object.", "name": "child2" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#moveAbove", "scope": "instance", "___id": "T000002R010168", "___s": true }, { "comment": "/**\r\n * Moves a Game Object below another one within this Container.\r\n * If the Game Object is already below the other, it isn't moved.\r\n *\r\n * These 2 Game Objects must already be children of this Container.\r\n *\r\n * @method Phaser.GameObjects.Container#moveBelow\r\n * @since 3.55.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [child1,child2]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child1 - The Game Object to move below base Game Object.\r\n * @param {Phaser.GameObjects.GameObject} child2 - The base Game Object.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 852, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Moves a Game Object below another one within this Container.\rIf the Game Object is already below the other, it isn't moved.\r\rThese 2 Game Objects must already be children of this Container.", "kind": "function", "name": "moveBelow", "since": "3.55.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child1,child2]", "value": "{T} - [child1,child2]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to move below base Game Object.", "name": "child1" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The base Game Object.", "name": "child2" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#moveBelow", "scope": "instance", "___id": "T000002R010170", "___s": true }, { "comment": "/**\r\n * Removes the given Game Object, or array of Game Objects, from this Container.\r\n *\r\n * The Game Objects must already be children of this Container.\r\n *\r\n * You can also optionally call `destroy` on each Game Object that is removed from the Container.\r\n *\r\n * @method Phaser.GameObjects.Container#remove\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {(T|T[])} - [child]\r\n *\r\n * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} child - The Game Object, or array of Game Objects, to be removed from the Container.\r\n * @param {boolean} [destroyChild=false] - Optionally call `destroy` on each child successfully removed from this Container.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 876, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Removes the given Game Object, or array of Game Objects, from this Container.\r\rThe Game Objects must already be children of this Container.\r\rYou can also optionally call `destroy` on each Game Object that is removed from the Container.", "kind": "function", "name": "remove", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(T|T[])} - [child]", "value": "{(T|T[])} - [child]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "The Game Object, or array of Game Objects, to be removed from the Container.", "name": "child" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optionally call `destroy` on each child successfully removed from this Container.", "name": "destroyChild" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#remove", "scope": "instance", "___id": "T000002R010172", "___s": true }, { "comment": "/**\r\n * Removes the Game Object at the given position in this Container.\r\n *\r\n * You can also optionally call `destroy` on the Game Object, if one is found.\r\n *\r\n * @method Phaser.GameObjects.Container#removeAt\r\n * @since 3.4.0\r\n *\r\n * @param {number} index - The index of the Game Object to be removed.\r\n * @param {boolean} [destroyChild=false] - Optionally call `destroy` on the Game Object if successfully removed from this Container.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 914, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Removes the Game Object at the given position in this Container.\r\rYou can also optionally call `destroy` on the Game Object, if one is found.", "kind": "function", "name": "removeAt", "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the Game Object to be removed.", "name": "index" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optionally call `destroy` on the Game Object if successfully removed from this Container.", "name": "destroyChild" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#removeAt", "scope": "instance", "___id": "T000002R010177", "___s": true }, { "comment": "/**\r\n * Removes the Game Objects between the given positions in this Container.\r\n *\r\n * You can also optionally call `destroy` on each Game Object that is removed from the Container.\r\n *\r\n * @method Phaser.GameObjects.Container#removeBetween\r\n * @since 3.4.0\r\n *\r\n * @param {number} [startIndex=0] - An optional start index to search from.\r\n * @param {number} [endIndex=Container.length] - An optional end index to search up to (but not included)\r\n * @param {boolean} [destroyChild=false] - Optionally call `destroy` on each Game Object successfully removed from this Container.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 939, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Removes the Game Objects between the given positions in this Container.\r\rYou 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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional start index to search from.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "Container.length", "description": "An optional end index to search up to (but not included)", "name": "endIndex" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optionally call `destroy` on each Game Object successfully removed from this Container.", "name": "destroyChild" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#removeBetween", "scope": "instance", "___id": "T000002R010180", "___s": true }, { "comment": "/**\r\n * Removes all Game Objects from this Container.\r\n *\r\n * You can also optionally call `destroy` on each Game Object that is removed from the Container.\r\n *\r\n * @method Phaser.GameObjects.Container#removeAll\r\n * @since 3.4.0\r\n *\r\n * @param {boolean} [destroyChild=false] - Optionally call `destroy` on each Game Object successfully removed from this Container.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 968, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Removes all Game Objects from this Container.\r\rYou 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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optionally call `destroy` on each Game Object successfully removed from this Container.", "name": "destroyChild" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#removeAll", "scope": "instance", "___id": "T000002R010184", "___s": true }, { "comment": "/**\r\n * Brings the given Game Object to the top of this Container.\r\n * This will cause it to render on-top of any other objects in the Container.\r\n *\r\n * @method Phaser.GameObjects.Container#bringToTop\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [child]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The Game Object to bring to the top of the Container.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 1006, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Brings the given Game Object to the top of this Container.\rThis will cause it to render on-top of any other objects in the Container.", "kind": "function", "name": "bringToTop", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child]", "value": "{T} - [child]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to bring to the top of the Container.", "name": "child" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#bringToTop", "scope": "instance", "___id": "T000002R010189", "___s": true }, { "comment": "/**\r\n * Sends the given Game Object to the bottom of this Container.\r\n * This will cause it to render below any other objects in the Container.\r\n *\r\n * @method Phaser.GameObjects.Container#sendToBack\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [child]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The Game Object to send to the bottom of the Container.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 1027, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Sends the given Game Object to the bottom of this Container.\rThis will cause it to render below any other objects in the Container.", "kind": "function", "name": "sendToBack", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child]", "value": "{T} - [child]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to send to the bottom of the Container.", "name": "child" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#sendToBack", "scope": "instance", "___id": "T000002R010191", "___s": true }, { "comment": "/**\r\n * Moves the given Game Object up one place in this Container, unless it's already at the top.\r\n *\r\n * @method Phaser.GameObjects.Container#moveUp\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [child]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The Game Object to be moved in the Container.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 1048, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child]", "value": "{T} - [child]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to be moved in the Container.", "name": "child" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#moveUp", "scope": "instance", "___id": "T000002R010193", "___s": true }, { "comment": "/**\r\n * Moves the given Game Object down one place in this Container, unless it's already at the bottom.\r\n *\r\n * @method Phaser.GameObjects.Container#moveDown\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [child]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The Game Object to be moved in the Container.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 1068, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child]", "value": "{T} - [child]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to be moved in the Container.", "name": "child" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#moveDown", "scope": "instance", "___id": "T000002R010195", "___s": true }, { "comment": "/**\r\n * Reverses the order of all Game Objects in this Container.\r\n *\r\n * @method Phaser.GameObjects.Container#reverse\r\n * @since 3.4.0\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 1088, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Reverses the order of all Game Objects in this Container.", "kind": "function", "name": "reverse", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#reverse", "scope": "instance", "___id": "T000002R010197", "___s": true }, { "comment": "/**\r\n * Shuffles all Game Objects in this Container using the Fisher-Yates implementation.\r\n *\r\n * @method Phaser.GameObjects.Container#shuffle\r\n * @since 3.4.0\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 1103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Shuffles all Game Objects in this Container using the Fisher-Yates implementation.", "kind": "function", "name": "shuffle", "since": "3.4.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#shuffle", "scope": "instance", "___id": "T000002R010199", "___s": true }, { "comment": "/**\r\n * Replaces a Game Object in this Container with the new Game Object.\r\n * The new Game Object cannot already be a child of this Container.\r\n *\r\n * @method Phaser.GameObjects.Container#replace\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [oldChild,newChild]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} oldChild - The Game Object in this Container that will be replaced.\r\n * @param {Phaser.GameObjects.GameObject} newChild - The Game Object to be added to this Container.\r\n * @param {boolean} [destroyChild=false] - Optionally call `destroy` on the Game Object if successfully removed from this Container.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 1118, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Replaces a Game Object in this Container with the new Game Object.\rThe new Game Object cannot already be a child of this Container.", "kind": "function", "name": "replace", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [oldChild,newChild]", "value": "{T} - [oldChild,newChild]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object in this Container that will be replaced.", "name": "oldChild" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to be added to this Container.", "name": "newChild" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optionally call `destroy` on the Game Object if successfully removed from this Container.", "name": "destroyChild" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#replace", "scope": "instance", "___id": "T000002R010201", "___s": true }, { "comment": "/**\r\n * Returns `true` if the given Game Object is a direct child of this Container.\r\n *\r\n * This check does not scan nested Containers.\r\n *\r\n * @method Phaser.GameObjects.Container#exists\r\n * @since 3.4.0\r\n *\r\n * @generic {Phaser.GameObjects.GameObject} T\r\n * @genericUse {T} - [child]\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The Game Object to check for within this Container.\r\n *\r\n * @return {boolean} True if the Game Object is an immediate child of this Container, otherwise false.\r\n */", "meta": { "filename": "Container.js", "lineno": 1152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Returns `true` if the given Game Object is a direct child of this Container.\r\rThis check does not scan nested Containers.", "kind": "function", "name": "exists", "since": "3.4.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.GameObject} T", "value": "{Phaser.GameObjects.GameObject} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{T} - [child]", "value": "{T} - [child]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to check for within this Container.", "name": "child" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R010204", "___s": true }, { "comment": "/**\r\n * Sets the property to the given value on all Game Objects in this Container.\r\n *\r\n * Optionally you can specify a start and end index. For example if this Container had 100 Game Objects,\r\n * and you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\r\n * the first 50 Game Objects.\r\n *\r\n * @method Phaser.GameObjects.Container#setAll\r\n * @since 3.4.0\r\n *\r\n * @param {string} property - The property that must exist on the Game Object.\r\n * @param {any} value - The value to set the property to.\r\n * @param {number} [startIndex=0] - An optional start index to search from.\r\n * @param {number} [endIndex=Container.length] - An optional end index to search up to (but not included)\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 1172, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Sets the property to the given value on all Game Objects in this Container.\r\rOptionally you can specify a start and end index. For example if this Container had 100 Game Objects,\rand you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\rthe first 50 Game Objects.", "kind": "function", "name": "setAll", "since": "3.4.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property that must exist on the Game Object.", "name": "property" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The value to set the property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional start index to search from.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "Container.length", "description": "An optional end index to search up to (but not included)", "name": "endIndex" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#setAll", "scope": "instance", "___id": "T000002R010206", "___s": true }, { "comment": "/**\r\n * @callback EachContainerCallback\r\n * @generic I - [item]\r\n *\r\n * @param {*} item - The child Game Object of the Container.\r\n * @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.\r\n */", "meta": { "filename": "Container.js", "lineno": 1196, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "kind": "typedef", "name": "EachContainerCallback", "type": { "names": [ "function" ] }, "tags": [ { "originalTitle": "generic", "title": "generic", "text": "I - [item]", "value": "I - [item]" } ], "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The child Game Object of the Container.", "name": "item" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "Additional arguments that will be passed to the callback, after the child.", "name": "args" } ], "longname": "EachContainerCallback", "scope": "global", "___id": "T000002R010208", "___s": true }, { "comment": "/**\r\n * Passes all Game Objects in this Container to the given callback.\r\n *\r\n * A copy of the Container is made before passing each entry to your callback.\r\n * This protects against the callback itself modifying the Container.\r\n *\r\n * If you know for sure that the callback will not change the size of this Container\r\n * then you can use the more performant `Container.iterate` method instead.\r\n *\r\n * @method Phaser.GameObjects.Container#each\r\n * @since 3.4.0\r\n *\r\n * @param {function} callback - The function to call.\r\n * @param {object} [context] - Value to use as `this` when executing callback.\r\n * @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 1204, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Passes all Game Objects in this Container to the given callback.\r\rA copy of the Container is made before passing each entry to your callback.\rThis protects against the callback itself modifying the Container.\r\rIf you know for sure that the callback will not change the size of this Container\rthen you can use the more performant `Container.iterate` method instead.", "kind": "function", "name": "each", "since": "3.4.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The function to call.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Value to use as `this` when executing callback.", "name": "context" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "Additional arguments that will be passed to the callback, after the child.", "name": "args" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#each", "scope": "instance", "___id": "T000002R010209", "___s": true }, { "comment": "/**\r\n * Passes all Game Objects in this Container to the given callback.\r\n *\r\n * Only use this method when you absolutely know that the Container will not be modified during\r\n * the iteration, i.e. by removing or adding to its contents.\r\n *\r\n * @method Phaser.GameObjects.Container#iterate\r\n * @since 3.4.0\r\n *\r\n * @param {function} callback - The function to call.\r\n * @param {object} [context] - Value to use as `this` when executing callback.\r\n * @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.\r\n *\r\n * @return {this} This Container instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 1244, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Passes all Game Objects in this Container to the given callback.\r\rOnly use this method when you absolutely know that the Container will not be modified during\rthe iteration, i.e. by removing or adding to its contents.", "kind": "function", "name": "iterate", "since": "3.4.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The function to call.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "Value to use as `this` when executing callback.", "name": "context" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "Additional arguments that will be passed to the callback, after the child.", "name": "args" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Container instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#iterate", "scope": "instance", "___id": "T000002R010218", "___s": true }, { "comment": "/**\r\n * Sets the scroll factor of this Container and optionally all of its children.\r\n *\r\n * The scroll factor controls the influence of the movement of a Camera upon this Game Object.\r\n *\r\n * When a camera scrolls it will change the location at which this Game Object is rendered on-screen.\r\n * It does not change the Game Objects actual position values.\r\n *\r\n * A value of 1 means it will move exactly in sync with a camera.\r\n * A value of 0 means it will not move at all, even if the camera moves.\r\n * Other values control the degree to which the camera movement is mapped to this Game Object.\r\n *\r\n * Please be aware that scroll factor values other than 1 are not taken in to consideration when\r\n * calculating physics collisions. Bodies always collide based on their world position, but changing\r\n * the scroll factor is a visual adjustment to where the textures are rendered, which can offset\r\n * them from physics bodies if not accounted for in your code.\r\n *\r\n * @method Phaser.GameObjects.Container#setScrollFactor\r\n * @since 3.4.0\r\n *\r\n * @param {number} x - The horizontal scroll factor of this Game Object.\r\n * @param {number} [y=x] - The vertical scroll factor of this Game Object. If not set it will use the `x` value.\r\n * @param {boolean} [updateChildren=false] - Apply this scrollFactor to all Container children as well?\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Container.js", "lineno": 1279, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Sets the scroll factor of this Container and optionally all of its children.\r\rThe scroll factor controls the influence of the movement of a Camera upon this Game Object.\r\rWhen a camera scrolls it will change the location at which this Game Object is rendered on-screen.\rIt does not change the Game Objects actual position values.\r\rA value of 1 means it will move exactly in sync with a camera.\rA value of 0 means it will not move at all, even if the camera moves.\rOther values control the degree to which the camera movement is mapped to this Game Object.\r\rPlease be aware that scroll factor values other than 1 are not taken in to consideration when\rcalculating physics collisions. Bodies always collide based on their world position, but changing\rthe scroll factor is a visual adjustment to where the textures are rendered, which can offset\rthem from physics bodies if not accounted for in your code.", "kind": "function", "name": "setScrollFactor", "since": "3.4.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal scroll factor of this Game Object.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Apply this scrollFactor to all Container children as well?", "name": "updateChildren" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#setScrollFactor", "scope": "instance", "___id": "T000002R010225", "___s": true }, { "comment": "/**\r\n * The number of Game Objects inside this Container.\r\n *\r\n * @name Phaser.GameObjects.Container#length\r\n * @type {number}\r\n * @readonly\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 1322, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "The number of Game Objects inside this Container.", "name": "length", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#length", "scope": "instance", "kind": "member", "___id": "T000002R010231", "___s": true }, { "comment": "/**\r\n * Returns the first Game Object within the Container, or `null` if it is empty.\r\n *\r\n * You can move the cursor by calling `Container.next` and `Container.previous`.\r\n *\r\n * @name Phaser.GameObjects.Container#first\r\n * @type {?Phaser.GameObjects.GameObject}\r\n * @readonly\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 1339, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Returns the first Game Object within the Container, or `null` if it is empty.\r\rYou can move the cursor by calling `Container.next` and `Container.previous`.", "name": "first", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "nullable": true, "readonly": true, "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#first", "scope": "instance", "kind": "member", "___id": "T000002R010234", "___s": true }, { "comment": "/**\r\n * Returns the last Game Object within the Container, or `null` if it is empty.\r\n *\r\n * You can move the cursor by calling `Container.next` and `Container.previous`.\r\n *\r\n * @name Phaser.GameObjects.Container#last\r\n * @type {?Phaser.GameObjects.GameObject}\r\n * @readonly\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 1367, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Returns the last Game Object within the Container, or `null` if it is empty.\r\rYou can move the cursor by calling `Container.next` and `Container.previous`.", "name": "last", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "nullable": true, "readonly": true, "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#last", "scope": "instance", "kind": "member", "___id": "T000002R010238", "___s": true }, { "comment": "/**\r\n * Returns the next Game Object within the Container, or `null` if it is empty.\r\n *\r\n * You can move the cursor by calling `Container.next` and `Container.previous`.\r\n *\r\n * @name Phaser.GameObjects.Container#next\r\n * @type {?Phaser.GameObjects.GameObject}\r\n * @readonly\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 1395, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Returns the next Game Object within the Container, or `null` if it is empty.\r\rYou can move the cursor by calling `Container.next` and `Container.previous`.", "name": "next", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "nullable": true, "readonly": true, "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#next", "scope": "instance", "kind": "member", "___id": "T000002R010242", "___s": true }, { "comment": "/**\r\n * Returns the previous Game Object within the Container, or `null` if it is empty.\r\n *\r\n * You can move the cursor by calling `Container.next` and `Container.previous`.\r\n *\r\n * @name Phaser.GameObjects.Container#previous\r\n * @type {?Phaser.GameObjects.GameObject}\r\n * @readonly\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Container.js", "lineno": 1423, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Returns the previous Game Object within the Container, or `null` if it is empty.\r\rYou can move the cursor by calling `Container.next` and `Container.previous`.", "name": "previous", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "nullable": true, "readonly": true, "since": "3.4.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#previous", "scope": "instance", "kind": "member", "___id": "T000002R010245", "___s": true }, { "comment": "/**\r\n * Internal destroy handler, called as part of the destroy process.\r\n *\r\n * @method Phaser.GameObjects.Container#preDestroy\r\n * @protected\r\n * @since 3.9.0\r\n */", "meta": { "filename": "Container.js", "lineno": 1451, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Internal destroy handler, called as part of the destroy process.", "kind": "function", "name": "preDestroy", "access": "protected", "since": "3.9.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#preDestroy", "scope": "instance", "___id": "T000002R010248", "___s": true }, { "comment": "/**\r\n * Internal handler, called when a child is destroyed.\r\n *\r\n * @method Phaser.GameObjects.Container#onChildDestroyed\r\n * @protected\r\n * @since 3.80.0\r\n */", "meta": { "filename": "Container.js", "lineno": 1467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Internal handler, called when a child is destroyed.", "kind": "function", "name": "onChildDestroyed", "access": "protected", "since": "3.80.0", "memberof": "Phaser.GameObjects.Container", "longname": "Phaser.GameObjects.Container#onChildDestroyed", "scope": "instance", "___id": "T000002R010251", "___s": true }, { "comment": "/**\r\n * Creates a new Container Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Container Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#container\r\n * @since 3.4.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Container.ContainerConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Container} The Game Object that was created.\r\n */", "meta": { "filename": "ContainerCreator.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Creates a new Container Game Object and returns it.\r\rNote: 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": [ "Phaser.Types.GameObjects.Container.ContainerConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Container.ContainerConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#container", "scope": "instance", "___id": "T000002R010274", "___s": true }, { "comment": "/**\r\n * Creates a new Container Game Object and adds it to the Scene.\r\n *\r\n * A Container is a special type of Game Object that can hold other Game Objects as children.\r\n * You can use a Container to group related Game Objects together, then move, rotate, scale,\r\n * or set the alpha of the Container to affect all of its children at once. Children are\r\n * rendered relative to the Container's position and transform, making Containers useful for\r\n * building composite objects, UI panels, or any group of Game Objects that should move together.\r\n *\r\n * Note: This method will only be available if the Container Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#container\r\n * @since 3.4.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} [children] - An optional Game Object, or array of Game Objects, to add to this Container.\r\n *\r\n * @return {Phaser.GameObjects.Container} The Game Object that was created.\r\n */", "meta": { "filename": "ContainerFactory.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container", "code": {} }, "description": "Creates a new Container Game Object and adds it to the Scene.\r\rA Container is a special type of Game Object that can hold other Game Objects as children.\rYou can use a Container to group related Game Objects together, then move, rotate, scale,\ror set the alpha of the Container to affect all of its children at once. Children are\rrendered relative to the Container's position and transform, making Containers useful for\rbuilding composite objects, UI panels, or any group of Game Objects that should move together.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An optional Game Object, or array of Game Objects, to add to this Container.", "name": "children" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#container", "scope": "instance", "___id": "T000002R010283", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Container.ContainerConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 3.50.0\r\n *\r\n * @property {Phaser.GameObjects.GameObject[]} [children] - An optional array of Game Objects to add to the Container.\r\n */", "meta": { "filename": "ContainerConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container\\typedefs", "code": {} }, "kind": "typedef", "name": "ContainerConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "3.50.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of Game Objects to add to the Container.", "name": "children" } ], "memberof": "Phaser.Types.GameObjects.Container", "longname": "Phaser.Types.GameObjects.Container.ContainerConfig", "scope": "static", "___id": "T000002R010325", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Container\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\container\\typedefs", "code": {} }, "kind": "namespace", "name": "Container", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Container", "scope": "static", "___id": "T000002R010326", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Custom Context is a game object that allows you to modify the drawing context before it is used.\r\n *\r\n * The Custom Context is an extended Container Game Object.\r\n * Before game objects are rendered,\r\n * it clones the current DrawingContext and passes it to a callback.\r\n * You can configure this callback to set options on the DrawingContext.\r\n *\r\n * See the {@link Phaser.Renderer.WebGL.DrawingContext} documentation for more details\r\n * on DrawingContext settings.\r\n * This is an advanced rendering system and should be used carefully.\r\n * You should mostly only use the setter methods on the DrawingContext object.\r\n * Methods that don't begin with `set` are typically for internal use.\r\n *\r\n * If you modify the DrawingContext to create a new framebuffer,\r\n * it will not render to the canvas.\r\n * It is your responsibility to use the texture from the DrawingContext.\r\n * It is very inefficient to create a new framebuffer every frame,\r\n * though, so you should use a `DynamicTexture` with a retained framebuffer instead.\r\n *\r\n * @class CustomContext\r\n * @extends Phaser.GameObjects.Container\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 4.2.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {Phaser.GameObjects.GameObject[]} [children] - An optional array of Game Objects to add to the Custom Context.\r\n * @param {Phaser.Types.GameObjects.CustomContext.CustomContextCallback} [customContextCallback] - A function to be called before the custom DrawingContext is activated. If undefined, no callback will be called.\r\n */", "meta": { "filename": "CustomContext.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\customcontext", "code": {} }, "classdesc": "The Custom Context is a game object that allows you to modify the drawing context before it is used.\r\rThe Custom Context is an extended Container Game Object.\rBefore game objects are rendered,\rit clones the current DrawingContext and passes it to a callback.\rYou can configure this callback to set options on the DrawingContext.\r\rSee the {@link Phaser.Renderer.WebGL.DrawingContext} documentation for more details\ron DrawingContext settings.\rThis is an advanced rendering system and should be used carefully.\rYou should mostly only use the setter methods on the DrawingContext object.\rMethods that don't begin with `set` are typically for internal use.\r\rIf you modify the DrawingContext to create a new framebuffer,\rit will not render to the canvas.\rIt is your responsibility to use the texture from the DrawingContext.\rIt is very inefficient to create a new framebuffer every frame,\rthough, so you should use a `DynamicTexture` with a retained framebuffer instead.", "kind": "class", "name": "CustomContext", "augments": [ "Phaser.GameObjects.Container" ], "memberof": "Phaser.GameObjects", "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of Game Objects to add to the Custom Context.", "name": "children" }, { "type": { "names": [ "Phaser.Types.GameObjects.CustomContext.CustomContextCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.CustomContext.CustomContextCallback" } }, "optional": true, "description": "A function to be called before the custom DrawingContext is activated. If undefined, no callback will be called.", "name": "customContextCallback" } ], "scope": "static", "longname": "Phaser.GameObjects.CustomContext", "___id": "T000002R010329", "___s": true }, { "comment": "/**\r\n * A function to be called before the custom DrawingContext is activated.\r\n * Set this function to modify the drawing context before it is used,\r\n * or set it to `null` to leave it as is.\r\n * If defined, the callback runs during the `customContextRenderStep` method.\r\n *\r\n * The callback is called with one parameter:\r\n * a copy of the current drawing context.\r\n *\r\n * @example\r\n * // Copy the source context and disable the stencil test.\r\n * this.customContextCallback = (drawingContext) => {\r\n * drawingContext.state.stencil.enabled = false;\r\n * };\r\n *\r\n * @name Phaser.GameObjects.CustomContext#customContextCallback\r\n * @type {Phaser.Types.GameObjects.CustomContext.CustomContextCallback | null}\r\n * @since 4.2.0\r\n */", "meta": { "filename": "CustomContext.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\customcontext", "code": {} }, "description": "A function to be called before the custom DrawingContext is activated.\rSet this function to modify the drawing context before it is used,\ror set it to `null` to leave it as is.\rIf defined, the callback runs during the `customContextRenderStep` method.\r\rThe callback is called with one parameter:\ra copy of the current drawing context.", "examples": [ "// Copy the source context and disable the stencil test.\rthis.customContextCallback = (drawingContext) => {\r drawingContext.state.stencil.enabled = false;\r};" ], "name": "customContextCallback", "type": { "names": [ "Phaser.Types.GameObjects.CustomContext.CustomContextCallback", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.CustomContext.CustomContextCallback" }, { "type": "NullLiteral" } ] } }, "since": "4.2.0", "memberof": "Phaser.GameObjects.CustomContext", "longname": "Phaser.GameObjects.CustomContext#customContextCallback", "scope": "instance", "kind": "member", "___id": "T000002R010333", "___s": true }, { "comment": "/**\r\n * The custom render step for the Custom Context.\r\n * This runs before rendering the game object,\r\n * allowing you to modify the drawing context before it is used.\r\n *\r\n * @method Phaser.GameObjects.CustomContext#customContextRenderStep\r\n * @since 4.2.0\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - A reference to the current active WebGL renderer.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered in this call.\r\n * @param {Phaser.Renderer.WebGL.DrawingContext} drawingContext - The current drawing context.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentMatrix] - This transform matrix is defined if the game object is nested\r\n * @param {number} [renderStep] - The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions.\r\n * @param {Phaser.GameObjects.GameObject[]} [displayList] - The display list which is currently being rendered.\r\n * @param {number} [displayListIndex] - The index of the Game Object within the display list.\r\n */", "meta": { "filename": "CustomContext.js", "lineno": 73, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\customcontext", "code": {} }, "description": "The custom render step for the Custom Context.\rThis runs before rendering the game object,\rallowing you to modify the drawing context before it is used.", "kind": "function", "name": "customContextRenderStep", "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "A reference to the current active WebGL renderer.", "name": "renderer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered in this call.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Renderer.WebGL.DrawingContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.DrawingContext" } }, "description": "The current drawing context.", "name": "drawingContext" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "This transform matrix is defined if the game object is nested", "name": "parentMatrix" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions.", "name": "renderStep" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "optional": true, "description": "The display list which is currently being rendered.", "name": "displayList" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The index of the Game Object within the display list.", "name": "displayListIndex" } ], "memberof": "Phaser.GameObjects.CustomContext", "longname": "Phaser.GameObjects.CustomContext#customContextRenderStep", "scope": "instance", "___id": "T000002R010335", "___s": true }, { "comment": "/**\r\n * Creates a new CustomContext Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the CustomContext Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#customContext\r\n * @since 4.2.0\r\n *\r\n * @param {Phaser.Types.GameObjects.CustomContext.CustomContextConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.CustomContext} The Game Object that was created.\r\n */", "meta": { "filename": "CustomContextCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\customcontext", "code": {} }, "description": "Creates a new CustomContext Game Object and returns it.\r\rNote: This method will only be available if the CustomContext Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "customContext", "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.CustomContext.CustomContextConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.CustomContext.CustomContextConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.CustomContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.CustomContext" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#customContext", "scope": "instance", "___id": "T000002R010344", "___s": true }, { "comment": "/**\r\n * Creates a new CustomContext Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the CustomContext Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#customContext\r\n * @webglOnly\r\n * @since 4.2.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {Phaser.GameObjects.GameObject[]} [children] - An optional array of Game Objects to add to the Custom Context.\r\n * @param {Phaser.Types.GameObjects.CustomContext.CustomContextCallback} [customContextCallback] - A function to be called before the custom DrawingContext is activated. If undefined, no callback will be called.\r\n *\r\n * @return {Phaser.GameObjects.CustomContext} The Game Object that was created.\r\n */", "meta": { "filename": "CustomContextFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\customcontext", "code": {} }, "description": "Creates a new CustomContext Game Object and adds it to the Scene.\r\rNote: This method will only be available if the CustomContext Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "customContext", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of Game Objects to add to the Custom Context.", "name": "children" }, { "type": { "names": [ "Phaser.Types.GameObjects.CustomContext.CustomContextCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.CustomContext.CustomContextCallback" } }, "optional": true, "description": "A function to be called before the custom DrawingContext is activated. If undefined, no callback will be called.", "name": "customContextCallback" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.CustomContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.CustomContext" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#customContext", "scope": "instance", "___id": "T000002R010354", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.GameObjects.CustomContext.CustomContextCallback\r\n * @since 4.2.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.DrawingContext} drawingContext - The drawing context which will be passed on for rendering, and can be modified.\r\n */", "meta": { "filename": "CustomContextCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\customcontext\\typedefs", "code": {} }, "kind": "typedef", "name": "CustomContextCallback", "type": { "names": [ "function" ] }, "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.DrawingContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.DrawingContext" } }, "description": "The drawing context which will be passed on for rendering, and can be modified.", "name": "drawingContext" } ], "memberof": "Phaser.Types.GameObjects.CustomContext", "longname": "Phaser.Types.GameObjects.CustomContext.CustomContextCallback", "scope": "static", "___id": "T000002R010355", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.CustomContext.CustomContextConfig\r\n * @extends Phaser.Types.GameObjects.Container.ContainerConfig\r\n * @since 4.2.0\r\n *\r\n * @property {Phaser.Types.GameObjects.CustomContext.CustomContextCallback} [customContextCallback] - A function to be called before the custom DrawingContext is activated. If undefined, no callback will be called.\r\n */", "meta": { "filename": "CustomContextConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\customcontext\\typedefs", "code": {} }, "kind": "typedef", "name": "CustomContextConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.Container.ContainerConfig" ], "since": "4.2.0", "properties": [ { "type": { "names": [ "Phaser.Types.GameObjects.CustomContext.CustomContextCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.CustomContext.CustomContextCallback" } }, "optional": true, "description": "A function to be called before the custom DrawingContext is activated. If undefined, no callback will be called.", "name": "customContextCallback" } ], "memberof": "Phaser.Types.GameObjects.CustomContext", "longname": "Phaser.Types.GameObjects.CustomContext.CustomContextConfig", "scope": "static", "___id": "T000002R010356", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.CustomContext\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\customcontext\\typedefs", "code": {} }, "kind": "namespace", "name": "CustomContext", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.CustomContext", "scope": "static", "___id": "T000002R010357", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Display List is a Scene plugin that maintains the ordered list of Game Objects\r\n * to be rendered each frame. Game Objects are automatically sorted by depth before\r\n * rendering. You do not normally interact with the Display List directly; instead use\r\n * `addToDisplayList` and `removeFromDisplayList` on individual Game Objects.\r\n *\r\n * @class DisplayList\r\n * @extends Phaser.Structs.List.\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene that this Display List belongs to.\r\n */", "meta": { "filename": "DisplayList.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "classdesc": "The Display List is a Scene plugin that maintains the ordered list of Game Objects\rto be rendered each frame. Game Objects are automatically sorted by depth before\rrendering. You do not normally interact with the Display List directly; instead use\r`addToDisplayList` and `removeFromDisplayList` on individual Game Objects.", "kind": "class", "name": "DisplayList", "augments": [ "Phaser.Structs.List." ], "memberof": "Phaser.GameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene that this Display List belongs to.", "name": "scene" } ], "scope": "static", "longname": "Phaser.GameObjects.DisplayList", "___id": "T000002R010364", "___s": true }, { "comment": "/**\r\n * The flag that determines whether Game Objects should be sorted when `depthSort()` is called.\r\n *\r\n * @name Phaser.GameObjects.DisplayList#sortChildrenFlag\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DisplayList.js", "lineno": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The flag that determines whether Game Objects should be sorted when `depthSort()` is called.", "name": "sortChildrenFlag", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.DisplayList", "longname": "Phaser.GameObjects.DisplayList#sortChildrenFlag", "scope": "instance", "kind": "member", "___id": "T000002R010368", "___s": true }, { "comment": "/**\r\n * The Scene that this Display List belongs to.\r\n *\r\n * @name Phaser.GameObjects.DisplayList#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DisplayList.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The Scene that this Display List belongs to.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DisplayList", "longname": "Phaser.GameObjects.DisplayList#scene", "scope": "instance", "kind": "member", "___id": "T000002R010370", "___s": true }, { "comment": "/**\r\n * The Scene's Systems.\r\n *\r\n * @name Phaser.GameObjects.DisplayList#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DisplayList.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The Scene's Systems.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.DisplayList", "longname": "Phaser.GameObjects.DisplayList#systems", "scope": "instance", "kind": "member", "___id": "T000002R010372", "___s": true }, { "comment": "/**\r\n * The Scene's Event Emitter.\r\n *\r\n * @name Phaser.GameObjects.DisplayList#events\r\n * @type {Phaser.Events.EventEmitter}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "DisplayList.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The Scene's Event Emitter.", "name": "events", "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.DisplayList", "longname": "Phaser.GameObjects.DisplayList#events", "scope": "instance", "kind": "member", "___id": "T000002R010374", "___s": true }, { "comment": "/**\r\n * Force a sort of the display list on the next call to depthSort.\r\n *\r\n * @method Phaser.GameObjects.DisplayList#queueDepthSort\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DisplayList.js", "lineno": 168, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "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", "___id": "T000002R010388", "___s": true }, { "comment": "/**\r\n * Immediately sorts the display list if the flag is set.\r\n *\r\n * @method Phaser.GameObjects.DisplayList#depthSort\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DisplayList.js", "lineno": 179, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "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", "___id": "T000002R010391", "___s": true }, { "comment": "/**\r\n * Compare the depth of two Game Objects.\r\n *\r\n * @method Phaser.GameObjects.DisplayList#sortByDepth\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} childA - The first Game Object.\r\n * @param {Phaser.GameObjects.GameObject} childB - The second Game Object.\r\n *\r\n * @return {number} The difference between the depths of each Game Object.\r\n */", "meta": { "filename": "DisplayList.js", "lineno": 195, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Compare the depth of two Game Objects.", "kind": "function", "name": "sortByDepth", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The first Game Object.", "name": "childA" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The second Game Object.", "name": "childB" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The difference between the depths of each Game Object." } ], "memberof": "Phaser.GameObjects.DisplayList", "longname": "Phaser.GameObjects.DisplayList#sortByDepth", "scope": "instance", "___id": "T000002R010394", "___s": true }, { "comment": "/**\r\n * Returns an array which contains all objects currently on the Display List.\r\n * This is a reference to the main list array, not a copy of it, so be careful not to modify it.\r\n *\r\n * @method Phaser.GameObjects.DisplayList#getChildren\r\n * @since 3.12.0\r\n *\r\n * @return {Phaser.GameObjects.GameObject[]} The group members.\r\n */", "meta": { "filename": "DisplayList.js", "lineno": 211, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Returns an array which contains all objects currently on the Display List.\rThis 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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "The group members." } ], "memberof": "Phaser.GameObjects.DisplayList", "longname": "Phaser.GameObjects.DisplayList#getChildren", "scope": "instance", "___id": "T000002R010396", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * DOM Element Game Objects are a way to control and manipulate HTML Elements over the top of your game.\r\n *\r\n * In order for DOM Elements to display you have to enable them by adding the following to your game\r\n * configuration object:\r\n *\r\n * ```javascript\r\n * dom {\r\n * createContainer: true\r\n * }\r\n * ```\r\n *\r\n * You must also have a parent container for Phaser. This is specified by the `parent` property in the\r\n * game config.\r\n *\r\n * When these two things are added, Phaser will automatically create a DOM Container div that is positioned\r\n * over the top of the game canvas. This div is sized to match the canvas, and if the canvas size changes,\r\n * as a result of settings within the Scale Manager, the dom container is resized accordingly.\r\n *\r\n * If you have not already done so, you have to provide a `parent` in the Game Configuration, or the DOM\r\n * Container will fail to be created.\r\n *\r\n * You can create a DOM Element by either passing in DOMStrings, or by passing in a reference to an existing\r\n * Element that you wish to be placed under the control of Phaser. For example:\r\n *\r\n * ```javascript\r\n * this.add.dom(x, y, 'div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\r\n * ```\r\n *\r\n * The above code will insert a div element into the DOM Container at the given x/y coordinate. The DOMString in\r\n * the 4th argument sets the initial CSS style of the div and the final argument is the inner text. In this case,\r\n * it will create a lime colored div that is 220px by 100px in size with the text Phaser in it, in an Arial font.\r\n *\r\n * You should nearly always, without exception, use explicitly sized HTML Elements, in order to fully control\r\n * alignment and positioning of the elements next to regular game content.\r\n *\r\n * Rather than specify the CSS and HTML directly you can use the `load.html` File Loader to load it into the\r\n * cache and then use the `createFromCache` method instead. You can also use `createFromHTML` and various other\r\n * methods available in this class to help construct your elements.\r\n *\r\n * Once the element has been created you can then control it like you would any other Game Object. You can set its\r\n * position, scale, rotation, alpha and other properties. It will move as the main Scene Camera moves and be clipped\r\n * at the edge of the canvas. It's important to remember some limitations of DOM Elements: The obvious one is that\r\n * they appear above or below your game canvas. You cannot blend them into the display list, meaning you cannot have\r\n * a DOM Element, then a Sprite, then another DOM Element behind it.\r\n *\r\n * They also cannot be enabled for input. To do that, you have to use the `addListener` method to add native event\r\n * listeners directly. The final limitation is to do with cameras. The DOM Container is sized to match the game canvas\r\n * entirely and clipped accordingly. DOM Elements respect camera scrolling and scrollFactor settings, but if you\r\n * change the size of the camera so it no longer matches the size of the canvas, they won't be clipped accordingly.\r\n *\r\n * DOM Game Objects can be added to a Phaser Container, however you should only nest them **one level deep**.\r\n * Any further down the chain and they will ignore all root container properties.\r\n *\r\n * Also, all DOM Elements are inserted into the same DOM Container, regardless of which Scene they are created in.\r\n *\r\n * Note that you should only have DOM Elements in a Scene with a _single_ Camera. If you require multiple cameras,\r\n * use parallel scenes to achieve this.\r\n *\r\n * DOM Elements are a powerful way to align native HTML with your Phaser Game Objects. For example, you can insert\r\n * a login form for a multiplayer game directly into your title screen. Or a text input box for a highscore table.\r\n * Or a banner ad from a 3rd party service. Or perhaps you'd like to use them for high resolution text display and\r\n * UI. The choice is up to you, just remember that you're dealing with standard HTML and CSS floating over the top\r\n * of your game, and should treat it accordingly.\r\n *\r\n * @class DOMElement\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.17.0\r\n *\r\n * @extends Phaser.GameObjects.Components.AlphaSingle\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x=0] - The horizontal position of this DOM Element in the world.\r\n * @param {number} [y=0] - The vertical position of this DOM Element in the world.\r\n * @param {(Element|string)} [element] - 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'.\r\n * @param {(string|any)} [style] - 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.\r\n * @param {string} [innerText] - If given, will be set directly as the elements `innerText` property value, replacing whatever was there before.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "classdesc": "DOM Element Game Objects are a way to control and manipulate HTML Elements over the top of your game.\r\rIn order for DOM Elements to display you have to enable them by adding the following to your game\rconfiguration object:\r\r```javascript\rdom {\r createContainer: true\r}\r```\r\rYou must also have a parent container for Phaser. This is specified by the `parent` property in the\rgame config.\r\rWhen these two things are added, Phaser will automatically create a DOM Container div that is positioned\rover the top of the game canvas. This div is sized to match the canvas, and if the canvas size changes,\ras a result of settings within the Scale Manager, the dom container is resized accordingly.\r\rIf you have not already done so, you have to provide a `parent` in the Game Configuration, or the DOM\rContainer will fail to be created.\r\rYou can create a DOM Element by either passing in DOMStrings, or by passing in a reference to an existing\rElement that you wish to be placed under the control of Phaser. For example:\r\r```javascript\rthis.add.dom(x, y, 'div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\r```\r\rThe above code will insert a div element into the DOM Container at the given x/y coordinate. The DOMString in\rthe 4th argument sets the initial CSS style of the div and the final argument is the inner text. In this case,\rit will create a lime colored div that is 220px by 100px in size with the text Phaser in it, in an Arial font.\r\rYou should nearly always, without exception, use explicitly sized HTML Elements, in order to fully control\ralignment and positioning of the elements next to regular game content.\r\rRather than specify the CSS and HTML directly you can use the `load.html` File Loader to load it into the\rcache and then use the `createFromCache` method instead. You can also use `createFromHTML` and various other\rmethods available in this class to help construct your elements.\r\rOnce the element has been created you can then control it like you would any other Game Object. You can set its\rposition, scale, rotation, alpha and other properties. It will move as the main Scene Camera moves and be clipped\rat the edge of the canvas. It's important to remember some limitations of DOM Elements: The obvious one is that\rthey appear above or below your game canvas. You cannot blend them into the display list, meaning you cannot have\ra DOM Element, then a Sprite, then another DOM Element behind it.\r\rThey also cannot be enabled for input. To do that, you have to use the `addListener` method to add native event\rlisteners directly. The final limitation is to do with cameras. The DOM Container is sized to match the game canvas\rentirely and clipped accordingly. DOM Elements respect camera scrolling and scrollFactor settings, but if you\rchange the size of the camera so it no longer matches the size of the canvas, they won't be clipped accordingly.\r\rDOM Game Objects can be added to a Phaser Container, however you should only nest them **one level deep**.\rAny further down the chain and they will ignore all root container properties.\r\rAlso, all DOM Elements are inserted into the same DOM Container, regardless of which Scene they are created in.\r\rNote that you should only have DOM Elements in a Scene with a _single_ Camera. If you require multiple cameras,\ruse parallel scenes to achieve this.\r\rDOM Elements are a powerful way to align native HTML with your Phaser Game Objects. For example, you can insert\ra login form for a multiplayer game directly into your title screen. Or a text input box for a highscore table.\rOr a banner ad from a 3rd party service. Or perhaps you'd like to use them for high resolution text display and\rUI. The choice is up to you, just remember that you're dealing with standard HTML and CSS floating over the top\rof 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this DOM Element in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this DOM Element in the world.", "name": "y" }, { "type": { "names": [ "Element", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Element" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R010419", "___s": true }, { "comment": "/**\r\n * A reference to the parent DOM Container that the Game instance created when it started.\r\n *\r\n * @name Phaser.GameObjects.DOMElement#parent\r\n * @type {Element}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 124, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "A reference to the parent DOM Container that the Game instance created when it started.", "name": "parent", "type": { "names": [ "Element" ], "parsedType": { "type": "NameExpression", "name": "Element" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#parent", "scope": "instance", "kind": "member", "___id": "T000002R010424", "___s": true }, { "comment": "/**\r\n * A reference to the HTML Cache.\r\n *\r\n * @name Phaser.GameObjects.DOMElement#cache\r\n * @type {Phaser.Cache.BaseCache}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 138, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "A reference to the HTML Cache.", "name": "cache", "type": { "names": [ "Phaser.Cache.BaseCache" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#cache", "scope": "instance", "kind": "member", "___id": "T000002R010426", "___s": true }, { "comment": "/**\r\n * The actual DOM Element that this Game Object is bound to. For example, if you've created a `
`\r\n * then this property is a direct reference to that element within the dom.\r\n *\r\n * @name Phaser.GameObjects.DOMElement#node\r\n * @type {Element}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 147, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "The actual DOM Element that this Game Object is bound to. For example, if you've created a `
`\rthen this property is a direct reference to that element within the dom.", "name": "node", "type": { "names": [ "Element" ], "parsedType": { "type": "NameExpression", "name": "Element" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#node", "scope": "instance", "kind": "member", "___id": "T000002R010428", "___s": true }, { "comment": "/**\r\n * By default a DOM Element will have its transform, display, opacity, zIndex and blend mode properties\r\n * updated when its rendered. If, for some reason, you don't want any of these changed other than the\r\n * CSS transform, then set this flag to `true`. When `true` only the CSS Transform is applied and it's\r\n * up to you to keep track of and set the other properties as required.\r\n *\r\n * This can be handy if, for example, you've a nested DOM Element and you don't want the opacity to be\r\n * picked-up by any of its children.\r\n *\r\n * @name Phaser.GameObjects.DOMElement#transformOnly\r\n * @type {boolean}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 157, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "By default a DOM Element will have its transform, display, opacity, zIndex and blend mode properties\rupdated when its rendered. If, for some reason, you don't want any of these changed other than the\rCSS transform, then set this flag to `true`. When `true` only the CSS Transform is applied and it's\rup to you to keep track of and set the other properties as required.\r\rThis can be handy if, for example, you've a nested DOM Element and you don't want the opacity to be\rpicked-up by any of its children.", "name": "transformOnly", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#transformOnly", "scope": "instance", "kind": "member", "___id": "T000002R010430", "___s": true }, { "comment": "/**\r\n * The angle, in radians, by which to skew the DOM Element on the horizontal axis.\r\n *\r\n * https://developer.mozilla.org/en-US/docs/Web/CSS/transform\r\n *\r\n * @name Phaser.GameObjects.DOMElement#skewX\r\n * @type {number}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 172, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "The angle, in radians, by which to skew the DOM Element on the horizontal axis.\r\rhttps://developer.mozilla.org/en-US/docs/Web/CSS/transform", "name": "skewX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#skewX", "scope": "instance", "kind": "member", "___id": "T000002R010432", "___s": true }, { "comment": "/**\r\n * The angle, in radians, by which to skew the DOM Element on the vertical axis.\r\n *\r\n * https://developer.mozilla.org/en-US/docs/Web/CSS/transform\r\n *\r\n * @name Phaser.GameObjects.DOMElement#skewY\r\n * @type {number}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 183, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "The angle, in radians, by which to skew the DOM Element on the vertical axis.\r\rhttps://developer.mozilla.org/en-US/docs/Web/CSS/transform", "name": "skewY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#skewY", "scope": "instance", "kind": "member", "___id": "T000002R010434", "___s": true }, { "comment": "/**\r\n * A Vector4 that contains the 3D rotation of this DOM Element around a fixed axis in 3D space.\r\n *\r\n * The x, y, and z components define the direction of the rotation axis. The w component holds the\r\n * angle of rotation, in the unit defined by the `rotate3dAngle` property (degrees by default).\r\n *\r\n * For more details see the following MDN page:\r\n *\r\n * https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/rotate3d\r\n *\r\n * @name Phaser.GameObjects.DOMElement#rotate3d\r\n * @type {Phaser.Math.Vector4}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 194, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "A Vector4 that contains the 3D rotation of this DOM Element around a fixed axis in 3D space.\r\rThe x, y, and z components define the direction of the rotation axis. The w component holds the\rangle of rotation, in the unit defined by the `rotate3dAngle` property (degrees by default).\r\rFor more details see the following MDN page:\r\rhttps://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/rotate3d", "name": "rotate3d", "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#rotate3d", "scope": "instance", "kind": "member", "___id": "T000002R010436", "___s": true }, { "comment": "/**\r\n * The unit that represents the 3D rotation values. By default this is `deg` for degrees, but can\r\n * be changed to any supported unit. See this page for further details:\r\n *\r\n * https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/rotate3d\r\n *\r\n * @name Phaser.GameObjects.DOMElement#rotate3dAngle\r\n * @type {string}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 210, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "The unit that represents the 3D rotation values. By default this is `deg` for degrees, but can\rbe changed to any supported unit. See this page for further details:\r\rhttps://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/rotate3d", "name": "rotate3dAngle", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#rotate3dAngle", "scope": "instance", "kind": "member", "___id": "T000002R010438", "___s": true }, { "comment": "/**\r\n * Sets the CSS `pointerEvents` attribute on the DOM Element during rendering.\r\n *\r\n * This is 'auto' by default. Changing it may have unintended side-effects with\r\n * internal Phaser input handling, such as dragging, so only change this if you\r\n * understand the implications.\r\n *\r\n * @name Phaser.GameObjects.DOMElement#pointerEvents\r\n * @type {string}\r\n * @since 3.55.0\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 222, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Sets the CSS `pointerEvents` attribute on the DOM Element during rendering.\r\rThis is 'auto' by default. Changing it may have unintended side-effects with\rinternal Phaser input handling, such as dragging, so only change this if you\runderstand the implications.", "name": "pointerEvents", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.55.0", "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#pointerEvents", "scope": "instance", "kind": "member", "___id": "T000002R010440", "___s": true }, { "comment": "/**\r\n * The native (un-scaled) width of this Game Object.\r\n *\r\n * For a DOM Element this property is read-only.\r\n *\r\n * The property `displayWidth` holds the computed bounds of this DOM Element, factoring in scaling.\r\n *\r\n * @name Phaser.GameObjects.DOMElement#width\r\n * @type {number}\r\n * @readonly\r\n * @since 3.17.0\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 235, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "The native (un-scaled) width of this Game Object.\r\rFor a DOM Element this property is read-only.\r\rThe property `displayWidth` holds the computed bounds of this DOM Element, factoring in scaling.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.17.0", "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#width", "scope": "instance", "kind": "member", "___id": "T000002R010442", "___s": true }, { "comment": "/**\r\n * The native (un-scaled) height of this Game Object.\r\n *\r\n * For a DOM Element this property is read-only.\r\n *\r\n * The property `displayHeight` holds the computed bounds of this DOM Element, factoring in scaling.\r\n *\r\n * @name Phaser.GameObjects.DOMElement#height\r\n * @type {number}\r\n * @readonly\r\n * @since 3.17.0\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 249, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "The native (un-scaled) height of this Game Object.\r\rFor a DOM Element this property is read-only.\r\rThe property `displayHeight` holds the computed bounds of this DOM Element, factoring in scaling.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.17.0", "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#height", "scope": "instance", "kind": "member", "___id": "T000002R010444", "___s": true }, { "comment": "/**\r\n * The computed display width of this Game Object, based on the `getBoundingClientRect` DOM call.\r\n *\r\n * The property `width` holds the un-scaled width of this DOM Element.\r\n *\r\n * @name Phaser.GameObjects.DOMElement#displayWidth\r\n * @type {number}\r\n * @readonly\r\n * @since 3.17.0\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 263, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "The computed display width of this Game Object, based on the `getBoundingClientRect` DOM call.\r\rThe property `width` holds the un-scaled width of this DOM Element.", "name": "displayWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.17.0", "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#displayWidth", "scope": "instance", "kind": "member", "___id": "T000002R010446", "___s": true }, { "comment": "/**\r\n * The computed display height of this Game Object, based on the `getBoundingClientRect` DOM call.\r\n *\r\n * The property `height` holds the un-scaled height of this DOM Element.\r\n *\r\n * @name Phaser.GameObjects.DOMElement#displayHeight\r\n * @type {number}\r\n * @readonly\r\n * @since 3.17.0\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 275, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "The computed display height of this Game Object, based on the `getBoundingClientRect` DOM call.\r\rThe property `height` holds the un-scaled height of this DOM Element.", "name": "displayHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.17.0", "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#displayHeight", "scope": "instance", "kind": "member", "___id": "T000002R010448", "___s": true }, { "comment": "/**\r\n * Sets the horizontal and vertical skew values of this DOM Element.\r\n *\r\n * For more information see: https://developer.mozilla.org/en-US/docs/Web/CSS/transform\r\n *\r\n * @method Phaser.GameObjects.DOMElement#setSkew\r\n * @since 3.17.0\r\n *\r\n * @param {number} [x=0] - The angle, in radians, by which to skew the DOM Element on the horizontal axis.\r\n * @param {number} [y=x] - The angle, in radians, by which to skew the DOM Element on the vertical axis.\r\n *\r\n * @return {this} This DOM Element instance.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 341, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Sets the horizontal and vertical skew values of this DOM Element.\r\rFor 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This DOM Element instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#setSkew", "scope": "instance", "___id": "T000002R010457", "___s": true }, { "comment": "/**\r\n * Sets the perspective CSS property of the _parent DOM Container_. This determines the distance between the z=0\r\n * plane and the user in order to give a 3D-positioned element some perspective. Each 3D element with\r\n * z > 0 becomes larger; each 3D-element with z < 0 becomes smaller. The strength of the effect is determined\r\n * by the value of this property.\r\n *\r\n * For more information see: https://developer.mozilla.org/en-US/docs/Web/CSS/perspective\r\n *\r\n * **Changing this value changes it globally for all DOM Elements, as they all share the same parent container.**\r\n *\r\n * @method Phaser.GameObjects.DOMElement#setPerspective\r\n * @since 3.17.0\r\n *\r\n * @param {number} value - The perspective value, in pixels, that determines the distance between the z plane and the user.\r\n *\r\n * @return {this} This DOM Element instance.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 365, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Sets the perspective CSS property of the _parent DOM Container_. This determines the distance between the z=0\rplane and the user in order to give a 3D-positioned element some perspective. Each 3D element with\rz > 0 becomes larger; each 3D-element with z < 0 becomes smaller. The strength of the effect is determined\rby the value of this property.\r\rFor more information see: https://developer.mozilla.org/en-US/docs/Web/CSS/perspective\r\r**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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The perspective value, in pixels, that determines the distance between the z plane and the user.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This DOM Element instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#setPerspective", "scope": "instance", "___id": "T000002R010463", "___s": true }, { "comment": "/**\r\n * The perspective CSS property value of the _parent DOM Container_. This determines the distance between the z=0\r\n * plane and the user in order to give a 3D-positioned element some perspective. Each 3D element with\r\n * z > 0 becomes larger; each 3D-element with z < 0 becomes smaller. The strength of the effect is determined\r\n * by the value of this property.\r\n *\r\n * For more information see: https://developer.mozilla.org/en-US/docs/Web/CSS/perspective\r\n *\r\n * **Changing this value changes it globally for all DOM Elements, as they all share the same parent container.**\r\n *\r\n * @name Phaser.GameObjects.DOMElement#perspective\r\n * @type {number}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 389, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "The perspective CSS property value of the _parent DOM Container_. This determines the distance between the z=0\rplane and the user in order to give a 3D-positioned element some perspective. Each 3D element with\rz > 0 becomes larger; each 3D-element with z < 0 becomes smaller. The strength of the effect is determined\rby the value of this property.\r\rFor more information see: https://developer.mozilla.org/en-US/docs/Web/CSS/perspective\r\r**Changing this value changes it globally for all DOM Elements, as they all share the same parent container.**", "name": "perspective", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.17.0", "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#perspective", "scope": "instance", "kind": "member", "___id": "T000002R010466", "___s": true }, { "comment": "/**\r\n * Adds one or more native DOM event listeners onto the underlying Element of this Game Object.\r\n * The event is then dispatched via this Game Objects standard event emitter.\r\n *\r\n * For example:\r\n *\r\n * ```javascript\r\n * var div = this.add.dom(x, y, element);\r\n *\r\n * div.addListener('click');\r\n *\r\n * div.on('click', handler);\r\n * ```\r\n *\r\n * @method Phaser.GameObjects.DOMElement#addListener\r\n * @since 3.17.0\r\n *\r\n * @param {string} events - The DOM event/s to listen for. You can specify multiple events by separating them with spaces.\r\n *\r\n * @return {this} This DOM Element instance.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 417, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Adds one or more native DOM event listeners onto the underlying Element of this Game Object.\rThe event is then dispatched via this Game Objects standard event emitter.\r\rFor example:\r\r```javascript\rvar div = this.add.dom(x, y, element);\r\rdiv.addListener('click');\r\rdiv.on('click', handler);\r```", "kind": "function", "name": "addListener", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The DOM event/s to listen for. You can specify multiple events by separating them with spaces.", "name": "events" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This DOM Element instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#addListener", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#addListener", "___id": "T000002R010471", "___s": true }, { "comment": "/**\r\n * Removes one or more native DOM event listeners from the underlying Element of this Game Object.\r\n *\r\n * @method Phaser.GameObjects.DOMElement#removeListener\r\n * @since 3.17.0\r\n *\r\n * @param {string} events - The DOM event/s to stop listening for. You can specify multiple events by separating them with spaces.\r\n *\r\n * @return {this} This DOM Element instance.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 453, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This DOM Element instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#removeListener", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#removeListener", "___id": "T000002R010475", "___s": true }, { "comment": "/**\r\n * Creates a native DOM Element, adds it to the parent DOM Container and then binds it to this Game Object,\r\n * so you can control it. The `tagName` should be a string and is passed to `document.createElement`:\r\n *\r\n * ```javascript\r\n * this.add.dom().createElement('div');\r\n * ```\r\n *\r\n * For more details on acceptable tag names see: https://developer.mozilla.org/en-US/docs/Web/API/Document/createElement\r\n *\r\n * You can also pass in a DOMString or style object to set the CSS on the created element, and an optional `innerText`\r\n * value as well. Here is an example of a DOMString:\r\n *\r\n * ```javascript\r\n * this.add.dom().createElement('div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\r\n * ```\r\n *\r\n * And using a style object:\r\n *\r\n * ```javascript\r\n * var style = {\r\n * 'background-color': 'lime';\r\n * 'width': '200px';\r\n * 'height': '100px';\r\n * 'font': '48px Arial';\r\n * };\r\n *\r\n * this.add.dom().createElement('div', style, 'Phaser');\r\n * ```\r\n *\r\n * If this Game Object already has an Element, it is removed from the DOM entirely first.\r\n * Any event listeners you may have previously created will need to be re-created after this call.\r\n *\r\n * @method Phaser.GameObjects.DOMElement#createElement\r\n * @since 3.17.0\r\n *\r\n * @param {string} tagName - 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.\r\n * @param {(string|any)} [style] - Either a DOMString that holds the CSS styles to be applied to the created element, or an object the styles will be read from.\r\n * @param {string} [innerText] - A DOMString that holds the text that will be set as the innerText of the created element.\r\n *\r\n * @return {this} This DOM Element instance.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Creates a native DOM Element, adds it to the parent DOM Container and then binds it to this Game Object,\rso you can control it. The `tagName` should be a string and is passed to `document.createElement`:\r\r```javascript\rthis.add.dom().createElement('div');\r```\r\rFor more details on acceptable tag names see: https://developer.mozilla.org/en-US/docs/Web/API/Document/createElement\r\rYou can also pass in a DOMString or style object to set the CSS on the created element, and an optional `innerText`\rvalue as well. Here is an example of a DOMString:\r\r```javascript\rthis.add.dom().createElement('div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\r```\r\rAnd using a style object:\r\r```javascript\rvar style = {\r 'background-color': 'lime';\r 'width': '200px';\r 'height': '100px';\r 'font': '48px Arial';\r};\r\rthis.add.dom().createElement('div', style, 'Phaser');\r```\r\rIf this Game Object already has an Element, it is removed from the DOM entirely first.\rAny 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "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 read from.", "name": "style" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This DOM Element instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#createElement", "scope": "instance", "___id": "T000002R010481", "___s": true }, { "comment": "/**\r\n * Binds a new DOM Element to this Game Object. If this Game Object already has an Element it is removed from the DOM\r\n * entirely first. Any event listeners you may have previously created will need to be re-created on the new element.\r\n *\r\n * The `element` argument you pass to this method can be either a string tagName:\r\n *\r\n * ```javascript\r\n *

Phaser

\r\n *\r\n * this.add.dom().setElement('heading');\r\n * ```\r\n *\r\n * Or a reference to an Element instance:\r\n *\r\n * ```javascript\r\n *

Phaser

\r\n *\r\n * var h1 = document.getElementById('heading');\r\n *\r\n * this.add.dom().setElement(h1);\r\n * ```\r\n *\r\n * You can also pass in a DOMString or style object to set the CSS on the created element, and an optional `innerText`\r\n * value as well. Here is an example of a DOMString:\r\n *\r\n * ```javascript\r\n * this.add.dom().setElement(h1, 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\r\n * ```\r\n *\r\n * And using a style object:\r\n *\r\n * ```javascript\r\n * var style = {\r\n * 'background-color': 'lime';\r\n * 'width': '200px';\r\n * 'height': '100px';\r\n * 'font': '48px Arial';\r\n * };\r\n *\r\n * this.add.dom().setElement(h1, style, 'Phaser');\r\n * ```\r\n *\r\n * @method Phaser.GameObjects.DOMElement#setElement\r\n * @since 3.17.0\r\n *\r\n * @param {(string|Element)} element - If a string it is passed to `getElementById()`, or it should be a reference to an existing Element.\r\n * @param {(string|any)} [style] - Either a DOMString that holds the CSS styles to be applied to the created element, or an object the styles will be read from.\r\n * @param {string} [innerText] - A DOMString that holds the text that will be set as the innerText of the created element.\r\n *\r\n * @return {this} This DOM Element instance.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 539, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Binds a new DOM Element to this Game Object. If this Game Object already has an Element it is removed from the DOM\rentirely first. Any event listeners you may have previously created will need to be re-created on the new element.\r\rThe `element` argument you pass to this method can be either a string tagName:\r\r```javascript\r

Phaser

\r\rthis.add.dom().setElement('heading');\r```\r\rOr a reference to an Element instance:\r\r```javascript\r

Phaser

\r\rvar h1 = document.getElementById('heading');\r\rthis.add.dom().setElement(h1);\r```\r\rYou can also pass in a DOMString or style object to set the CSS on the created element, and an optional `innerText`\rvalue as well. Here is an example of a DOMString:\r\r```javascript\rthis.add.dom().setElement(h1, 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\r```\r\rAnd using a style object:\r\r```javascript\rvar style = {\r 'background-color': 'lime';\r 'width': '200px';\r 'height': '100px';\r 'font': '48px Arial';\r};\r\rthis.add.dom().setElement(h1, style, 'Phaser');\r```", "kind": "function", "name": "setElement", "since": "3.17.0", "params": [ { "type": { "names": [ "string", "Element" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "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 read from.", "name": "style" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This DOM Element instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#setElement", "scope": "instance", "___id": "T000002R010483", "___s": true }, { "comment": "/**\r\n * Takes a block of html from the HTML Cache, that has previously been preloaded into the game, and then\r\n * creates a DOM Element from it. The loaded HTML is set as the `innerHTML` property of the created\r\n * element.\r\n *\r\n * Assume the following html is stored in a file called `loginform.html`:\r\n *\r\n * ```html\r\n * \r\n * \r\n * ```\r\n *\r\n * Which is loaded into your game using the cache key 'login':\r\n *\r\n * ```javascript\r\n * this.load.html('login', 'assets/loginform.html');\r\n * ```\r\n *\r\n * You can create a DOM Element from it using the cache key:\r\n *\r\n * ```javascript\r\n * this.add.dom().createFromCache('login');\r\n * ```\r\n *\r\n * The optional `elementType` argument controls the container that is created, into which the loaded html is inserted.\r\n * The default is a plain `div` object, but any valid tagName can be given.\r\n *\r\n * If this Game Object already has an Element, it is removed from the DOM entirely first.\r\n * Any event listeners you may have previously created will need to be re-created after this call.\r\n *\r\n * @method Phaser.GameObjects.DOMElement#createFromCache\r\n * @since 3.17.0\r\n *\r\n * @param {string} key - The key of the html cache entry to use for this DOM Element.\r\n * @param {string} [tagName='div'] - The tag name of the element into which all of the loaded html will be inserted. Defaults to a plain div tag.\r\n *\r\n * @return {this} This DOM Element instance.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 654, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Takes a block of html from the HTML Cache, that has previously been preloaded into the game, and then\rcreates a DOM Element from it. The loaded HTML is set as the `innerHTML` property of the created\relement.\r\rAssume the following html is stored in a file called `loginform.html`:\r\r```html\r\r\r```\r\rWhich is loaded into your game using the cache key 'login':\r\r```javascript\rthis.load.html('login', 'assets/loginform.html');\r```\r\rYou can create a DOM Element from it using the cache key:\r\r```javascript\rthis.add.dom().createFromCache('login');\r```\r\rThe optional `elementType` argument controls the container that is created, into which the loaded html is inserted.\rThe default is a plain `div` object, but any valid tagName can be given.\r\rIf this Game Object already has an Element, it is removed from the DOM entirely first.\rAny 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the html cache entry to use for this DOM Element.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This DOM Element instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#createFromCache", "scope": "instance", "___id": "T000002R010498", "___s": true }, { "comment": "/**\r\n * Takes a string of html and then creates a DOM Element from it. The HTML is set as the `innerHTML`\r\n * property of the created element.\r\n *\r\n * ```javascript\r\n * let form = `\r\n * \r\n * \r\n * `;\r\n * ```\r\n *\r\n * You can create a DOM Element from it using the string:\r\n *\r\n * ```javascript\r\n * this.add.dom().createFromHTML(form);\r\n * ```\r\n *\r\n * The optional `elementType` argument controls the type of container that is created, into which the html is inserted.\r\n * The default is a plain `div` object, but any valid tagName can be given.\r\n *\r\n * If this Game Object already has an Element, it is removed from the DOM entirely first.\r\n * Any event listeners you may have previously created will need to be re-created after this call.\r\n *\r\n * @method Phaser.GameObjects.DOMElement#createFromHTML\r\n * @since 3.17.0\r\n *\r\n * @param {string} html - A string of html to be set as the `innerHTML` property of the created element.\r\n * @param {string} [tagName='div'] - The tag name of the element into which all of the html will be inserted. Defaults to a plain div tag.\r\n *\r\n * @return {this} This DOM Element instance.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 704, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Takes a string of html and then creates a DOM Element from it. The HTML is set as the `innerHTML`\rproperty of the created element.\r\r```javascript\rlet form = `\r\r\r`;\r```\r\rYou can create a DOM Element from it using the string:\r\r```javascript\rthis.add.dom().createFromHTML(form);\r```\r\rThe optional `elementType` argument controls the type of container that is created, into which the html is inserted.\rThe default is a plain `div` object, but any valid tagName can be given.\r\rIf this Game Object already has an Element, it is removed from the DOM entirely first.\rAny 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A string of html to be set as the `innerHTML` property of the created element.", "name": "html" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This DOM Element instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#createFromHTML", "scope": "instance", "___id": "T000002R010501", "___s": true }, { "comment": "/**\r\n * Removes the current DOM Element bound to this Game Object from the DOM entirely and resets the\r\n * `node` property of this Game Object to be `null`.\r\n *\r\n * @method Phaser.GameObjects.DOMElement#removeElement\r\n * @since 3.17.0\r\n *\r\n * @return {this} This DOM Element instance.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 761, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Removes the current DOM Element bound to this Game Object from the DOM entirely and resets the\r`node` property of this Game Object to be `null`.", "kind": "function", "name": "removeElement", "since": "3.17.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This DOM Element instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#removeElement", "scope": "instance", "___id": "T000002R010511", "___s": true }, { "comment": "/**\r\n * Internal method that sets the `displayWidth` and `displayHeight` properties, and the `clientWidth` \r\n * and `clientHeight` values into the `width` and `height` properties respectively.\r\n *\r\n * This is called automatically whenever a new element is created or set.\r\n *\r\n * @method Phaser.GameObjects.DOMElement#updateSize\r\n * @since 3.17.0\r\n *\r\n * @return {this} This DOM Element instance.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 782, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Internal method that sets the `displayWidth` and `displayHeight` properties, and the `clientWidth` \rand `clientHeight` values into the `width` and `height` properties respectively.\r\rThis is called automatically whenever a new element is created or set.", "kind": "function", "name": "updateSize", "since": "3.17.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This DOM Element instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#updateSize", "scope": "instance", "___id": "T000002R010514", "___s": true }, { "comment": "/**\r\n * Gets all children from this DOM Elements node, using `querySelectorAll('*')` and then iterates through\r\n * them, looking for the first one that has a property matching the given key and value. It then returns this child\r\n * if found, or `null` if not.\r\n *\r\n * @method Phaser.GameObjects.DOMElement#getChildByProperty\r\n * @since 3.17.0\r\n *\r\n * @param {string} property - The property to search the children for.\r\n * @param {string} value - The value the property must strictly equal.\r\n *\r\n * @return {?Element} The first matching child DOM Element, or `null` if not found.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Gets all children from this DOM Elements node, using `querySelectorAll('*')` and then iterates through\rthem, looking for the first one that has a property matching the given key and value. It then returns this child\rif found, or `null` if not.", "kind": "function", "name": "getChildByProperty", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to search the children for.", "name": "property" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The value the property must strictly equal.", "name": "value" } ], "returns": [ { "type": { "names": [ "Element" ], "parsedType": { "type": "NameExpression", "name": "Element", "nullable": true } }, "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", "___id": "T000002R010521", "___s": true }, { "comment": "/**\r\n * Gets all children from this DOM Elements node, using `querySelectorAll('*')` and then iterates through\r\n * them, looking for the first one that has a matching id. It then returns this child if found, or `null` if not.\r\n *\r\n * Be aware that class and id names are case-sensitive.\r\n *\r\n * @method Phaser.GameObjects.DOMElement#getChildByID\r\n * @since 3.17.0\r\n *\r\n * @param {string} id - The id to search the children for.\r\n *\r\n * @return {?Element} The first matching child DOM Element, or `null` if not found.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 837, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Gets all children from this DOM Elements node, using `querySelectorAll('*')` and then iterates through\rthem, looking for the first one that has a matching id. It then returns this child if found, or `null` if not.\r\rBe aware that class and id names are case-sensitive.", "kind": "function", "name": "getChildByID", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The id to search the children for.", "name": "id" } ], "returns": [ { "type": { "names": [ "Element" ], "parsedType": { "type": "NameExpression", "name": "Element", "nullable": true } }, "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", "___id": "T000002R010525", "___s": true }, { "comment": "/**\r\n * Gets all children from this DOM Elements node, using `querySelectorAll('*')` and then iterates through\r\n * them, looking for the first one that has a matching name. It then returns this child if found, or `null` if not.\r\n *\r\n * Be aware that class and id names are case-sensitive.\r\n *\r\n * @method Phaser.GameObjects.DOMElement#getChildByName\r\n * @since 3.17.0\r\n *\r\n * @param {string} name - The name to search the children for.\r\n *\r\n * @return {?Element} The first matching child DOM Element, or `null` if not found.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 855, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Gets all children from this DOM Elements node, using `querySelectorAll('*')` and then iterates through\rthem, looking for the first one that has a matching name. It then returns this child if found, or `null` if not.\r\rBe aware that class and id names are case-sensitive.", "kind": "function", "name": "getChildByName", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to search the children for.", "name": "name" } ], "returns": [ { "type": { "names": [ "Element" ], "parsedType": { "type": "NameExpression", "name": "Element", "nullable": true } }, "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", "___id": "T000002R010527", "___s": true }, { "comment": "/**\r\n * Sets the `className` property of the DOM Element node and updates the internal sizes.\r\n *\r\n * @method Phaser.GameObjects.DOMElement#setClassName\r\n * @since 3.17.0\r\n *\r\n * @param {string} className - A string representing the class or space-separated classes of the element.\r\n *\r\n * @return {this} This DOM Element instance.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 873, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A string representing the class or space-separated classes of the element.", "name": "className" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This DOM Element instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#setClassName", "scope": "instance", "___id": "T000002R010529", "___s": true }, { "comment": "/**\r\n * Sets the `innerText` property of the DOM Element node and updates the internal sizes.\r\n *\r\n * Note that only certain types of Elements can have `innerText` set on them.\r\n *\r\n * @method Phaser.GameObjects.DOMElement#setText\r\n * @since 3.17.0\r\n *\r\n * @param {string} text - A DOMString representing the rendered text content of the element.\r\n *\r\n * @return {this} This DOM Element instance.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 895, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Sets the `innerText` property of the DOM Element node and updates the internal sizes.\r\rNote that only certain types of Elements can have `innerText` set on them.", "kind": "function", "name": "setText", "since": "3.17.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A DOMString representing the rendered text content of the element.", "name": "text" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This DOM Element instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#setText", "scope": "instance", "___id": "T000002R010532", "___s": true }, { "comment": "/**\r\n * Sets the `innerHTML` property of the DOM Element node and updates the internal sizes.\r\n *\r\n * @method Phaser.GameObjects.DOMElement#setHTML\r\n * @since 3.17.0\r\n *\r\n * @param {string} html - A DOMString of html to be set as the `innerHTML` property of the element.\r\n *\r\n * @return {this} This DOM Element instance.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A DOMString of html to be set as the `innerHTML` property of the element.", "name": "html" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This DOM Element instance." } ], "memberof": "Phaser.GameObjects.DOMElement", "longname": "Phaser.GameObjects.DOMElement#setHTML", "scope": "instance", "___id": "T000002R010535", "___s": true }, { "comment": "/**\r\n * Compares the renderMask with the renderFlags to see if this Game Object will render or not.\r\n *\r\n * DOMElements always return `true` as they need to still set values during the render pass, even if not visible.\r\n *\r\n * @method Phaser.GameObjects.DOMElement#willRender\r\n * @since 3.17.0\r\n *\r\n * @return {boolean} `true` if the Game Object should be rendered, otherwise `false`.\r\n */", "meta": { "filename": "DOMElement.js", "lineno": 959, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "Compares the renderMask with the renderFlags to see if this Game Object will render or not.\r\rDOMElements 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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R010543", "___s": true }, { "comment": "/**\r\n * DOM Element Game Objects are a way to control and manipulate HTML Elements over the top of your game.\r\n *\r\n * In order for DOM Elements to display you have to enable them by adding the following to your game\r\n * configuration object:\r\n *\r\n * ```javascript\r\n * dom {\r\n * createContainer: true\r\n * }\r\n * ```\r\n *\r\n * When this is added, Phaser will automatically create a DOM Container div that is positioned over the top\r\n * of the game canvas. This div is sized to match the canvas, and if the canvas size changes, as a result of\r\n * settings within the Scale Manager, the dom container is resized accordingly.\r\n *\r\n * You can create a DOM Element by either passing in DOMStrings, or by passing in a reference to an existing\r\n * Element that you wish to be placed under the control of Phaser. For example:\r\n *\r\n * ```javascript\r\n * this.add.dom(x, y, 'div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\r\n * ```\r\n *\r\n * The above code will insert a div element into the DOM Container at the given x/y coordinate. The DOMString in\r\n * the 4th argument sets the initial CSS style of the div and the final argument is the inner text. In this case,\r\n * it will create a lime colored div that is 220px by 100px in size with the text Phaser in it, in an Arial font.\r\n *\r\n * You should nearly always, without exception, use explicitly sized HTML Elements, in order to fully control\r\n * alignment and positioning of the elements next to regular game content.\r\n *\r\n * Rather than specify the CSS and HTML directly you can use the `load.html` File Loader to load it into the\r\n * cache and then use the `createFromCache` method instead. You can also use `createFromHTML` and various other\r\n * methods available in this class to help construct your elements.\r\n *\r\n * Once the element has been created you can then control it like you would any other Game Object. You can set its\r\n * position, scale, rotation, alpha and other properties. It will move as the main Scene Camera moves and be clipped\r\n * at the edge of the canvas. It's important to remember some limitations of DOM Elements: The obvious one is that\r\n * they appear above or below your game canvas. You cannot blend them into the display list, meaning you cannot have\r\n * a DOM Element, then a Sprite, then another DOM Element behind it.\r\n *\r\n * They also cannot be enabled for input. To do that, you have to use the `addListener` method to add native event\r\n * listeners directly. The final limitation is to do with cameras. The DOM Container is sized to match the game canvas\r\n * entirely and clipped accordingly. DOM Elements respect camera scrolling and scrollFactor settings, but if you\r\n * change the size of the camera so it no longer matches the size of the canvas, they won't be clipped accordingly.\r\n *\r\n * Also, all DOM Elements are inserted into the same DOM Container, regardless of which Scene they are created in.\r\n *\r\n * DOM Elements are a powerful way to align native HTML with your Phaser Game Objects. For example, you can insert\r\n * a login form for a multiplayer game directly into your title screen. Or a text input box for a highscore table.\r\n * Or a banner ad from a 3rd party service. Or perhaps you'd like to use them for high resolution text display and\r\n * UI. The choice is up to you, just remember that you're dealing with standard HTML and CSS floating over the top\r\n * of your game, and should treat it accordingly.\r\n *\r\n * Note: This method will only be available if the DOM Element Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#dom\r\n * @since 3.17.0\r\n *\r\n * @param {number} x - The horizontal position of this DOM Element in the world.\r\n * @param {number} y - The vertical position of this DOM Element in the world.\r\n * @param {(HTMLElement|string)} [element] - 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'.\r\n * @param {(string|any)} [style] - 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 replace whatever CSS styles may have been previously set.\r\n * @param {string} [innerText] - If given, will be set directly as the elements `innerText` property value, replacing whatever was there before.\r\n *\r\n * @return {Phaser.GameObjects.DOMElement} The Game Object that was created.\r\n */", "meta": { "filename": "DOMElementFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\domelement", "code": {} }, "description": "DOM Element Game Objects are a way to control and manipulate HTML Elements over the top of your game.\r\rIn order for DOM Elements to display you have to enable them by adding the following to your game\rconfiguration object:\r\r```javascript\rdom {\r createContainer: true\r}\r```\r\rWhen this is added, Phaser will automatically create a DOM Container div that is positioned over the top\rof the game canvas. This div is sized to match the canvas, and if the canvas size changes, as a result of\rsettings within the Scale Manager, the dom container is resized accordingly.\r\rYou can create a DOM Element by either passing in DOMStrings, or by passing in a reference to an existing\rElement that you wish to be placed under the control of Phaser. For example:\r\r```javascript\rthis.add.dom(x, y, 'div', 'background-color: lime; width: 220px; height: 100px; font: 48px Arial', 'Phaser');\r```\r\rThe above code will insert a div element into the DOM Container at the given x/y coordinate. The DOMString in\rthe 4th argument sets the initial CSS style of the div and the final argument is the inner text. In this case,\rit will create a lime colored div that is 220px by 100px in size with the text Phaser in it, in an Arial font.\r\rYou should nearly always, without exception, use explicitly sized HTML Elements, in order to fully control\ralignment and positioning of the elements next to regular game content.\r\rRather than specify the CSS and HTML directly you can use the `load.html` File Loader to load it into the\rcache and then use the `createFromCache` method instead. You can also use `createFromHTML` and various other\rmethods available in this class to help construct your elements.\r\rOnce the element has been created you can then control it like you would any other Game Object. You can set its\rposition, scale, rotation, alpha and other properties. It will move as the main Scene Camera moves and be clipped\rat the edge of the canvas. It's important to remember some limitations of DOM Elements: The obvious one is that\rthey appear above or below your game canvas. You cannot blend them into the display list, meaning you cannot have\ra DOM Element, then a Sprite, then another DOM Element behind it.\r\rThey also cannot be enabled for input. To do that, you have to use the `addListener` method to add native event\rlisteners directly. The final limitation is to do with cameras. The DOM Container is sized to match the game canvas\rentirely and clipped accordingly. DOM Elements respect camera scrolling and scrollFactor settings, but if you\rchange the size of the camera so it no longer matches the size of the canvas, they won't be clipped accordingly.\r\rAlso, all DOM Elements are inserted into the same DOM Container, regardless of which Scene they are created in.\r\rDOM Elements are a powerful way to align native HTML with your Phaser Game Objects. For example, you can insert\ra login form for a multiplayer game directly into your title screen. Or a text input box for a highscore table.\rOr a banner ad from a 3rd party service. Or perhaps you'd like to use them for high resolution text display and\rUI. The choice is up to you, just remember that you're dealing with standard HTML and CSS floating over the top\rof your game, and should treat it accordingly.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this DOM Element in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this DOM Element in the world.", "name": "y" }, { "type": { "names": [ "HTMLElement", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "HTMLElement" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "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 replace whatever CSS styles may have been previously set.", "name": "style" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.DOMElement" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#dom", "scope": "instance", "___id": "T000002R010584", "___s": true }, { "comment": "/**\r\n * The Game Object Added to Scene Event.\r\n *\r\n * This event is dispatched when a Game Object is added to a Scene.\r\n *\r\n * Listen for it on a Game Object instance using `GameObject.on('addedtoscene', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#ADDED_TO_SCENE\r\n * @type {string}\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that was added to the Scene.\r\n * @param {Phaser.Scene} scene - The Scene to which the Game Object was added.\r\n */", "meta": { "filename": "ADDED_TO_SCENE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Game Object Added to Scene Event.\r\rThis event is dispatched when a Game Object is added to a Scene.\r\rListen for it on a Game Object instance using `GameObject.on('addedtoscene', listener)`.", "kind": "event", "name": "ADDED_TO_SCENE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was added to the Scene.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which the Game Object was added.", "name": "scene" } ], "memberof": "Phaser.GameObjects.Events", "longname": "Phaser.GameObjects.Events#event:ADDED_TO_SCENE", "scope": "instance", "___id": "T000002R010594", "___s": true }, { "comment": "/**\r\n * The Game Object Destroy Event.\r\n *\r\n * This event is dispatched when a Game Object instance is being destroyed.\r\n *\r\n * Listen for it on a Game Object instance using `GameObject.on('destroy', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#DESTROY\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object which is being destroyed.\r\n * @param {boolean} fromScene - `True` if this Game Object is being destroyed by the Scene, `false` if not.\r\n */", "meta": { "filename": "DESTROY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Game Object Destroy Event.\r\rThis event is dispatched when a Game Object instance is being destroyed.\r\rListen for it on a Game Object instance using `GameObject.on('destroy', listener)`.", "kind": "event", "name": "DESTROY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object which is being destroyed.", "name": "gameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`True` if this Game Object is being destroyed by the Scene, `false` if not.", "name": "fromScene" } ], "memberof": "Phaser.GameObjects.Events", "longname": "Phaser.GameObjects.Events#event:DESTROY", "scope": "instance", "___id": "T000002R010596", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.GameObjects.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.GameObjects", "longname": "Phaser.GameObjects.Events", "scope": "static", "___id": "T000002R010598", "___s": true }, { "comment": "/**\r\n * The Game Object Removed from Scene Event.\r\n *\r\n * This event is dispatched when a Game Object is removed from a Scene.\r\n *\r\n * Listen for it on a Game Object instance using `GameObject.on('removedfromscene', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#REMOVED_FROM_SCENE\r\n * @type {string}\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that was removed from the Scene.\r\n * @param {Phaser.Scene} scene - The Scene from which the Game Object was removed.\r\n */", "meta": { "filename": "REMOVED_FROM_SCENE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Game Object Removed from Scene Event.\r\rThis event is dispatched when a Game Object is removed from a Scene.\r\rListen for it on a Game Object instance using `GameObject.on('removedfromscene', listener)`.", "kind": "event", "name": "REMOVED_FROM_SCENE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was removed from the Scene.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene from which the Game Object was removed.", "name": "scene" } ], "memberof": "Phaser.GameObjects.Events", "longname": "Phaser.GameObjects.Events#event:REMOVED_FROM_SCENE", "scope": "instance", "___id": "T000002R010618", "___s": true }, { "comment": "/**\r\n * The Video Game Object Complete Event.\r\n *\r\n * This event is dispatched when a Video finishes playback by reaching the end of its duration. It\r\n * is also dispatched if a video marker sequence is being played and reaches the end.\r\n *\r\n * Note that not all videos can fire this event. Live streams, for example, have no fixed duration,\r\n * so never technically 'complete'.\r\n *\r\n * If a video is stopped from playback, via the `Video.stop` method, it will emit the\r\n * `VIDEO_STOP` event instead of this one.\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('complete', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_COMPLETE\r\n * @type {string}\r\n * @since 3.20.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object which completed playback.\r\n */", "meta": { "filename": "VIDEO_COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Complete Event.\r\rThis event is dispatched when a Video finishes playback by reaching the end of its duration. It\ris also dispatched if a video marker sequence is being played and reaches the end.\r\rNote that not all videos can fire this event. Live streams, for example, have no fixed duration,\rso never technically 'complete'.\r\rIf a video is stopped from playback, via the `Video.stop` method, it will emit the\r`VIDEO_STOP` event instead of this one.\r\rListen for it from a Video Game Object instance using `Video.on('complete', listener)`.", "kind": "event", "name": "VIDEO_COMPLETE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R010620", "___s": true }, { "comment": "/**\r\n * The Video Game Object Created Event.\r\n *\r\n * This event is dispatched when the texture for a Video has been created. This happens\r\n * when enough of the video source has been loaded that the browser is able to render a\r\n * frame from it.\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('created', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_CREATED\r\n * @type {string}\r\n * @since 3.20.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object which raised the event.\r\n * @param {number} width - The width of the video.\r\n * @param {number} height - The height of the video.\r\n */", "meta": { "filename": "VIDEO_CREATED_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Created Event.\r\rThis event is dispatched when the texture for a Video has been created. This happens\rwhen enough of the video source has been loaded that the browser is able to render a\rframe from it.\r\rListen for it from a Video Game Object instance using `Video.on('created', listener)`.", "kind": "event", "name": "VIDEO_CREATED", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Video" } }, "description": "The Video Game Object which raised the event.", "name": "video" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the video.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the video.", "name": "height" } ], "memberof": "Phaser.GameObjects.Events", "longname": "Phaser.GameObjects.Events#event:VIDEO_CREATED", "scope": "instance", "___id": "T000002R010622", "___s": true }, { "comment": "/**\r\n * The Video Game Object Error Event.\r\n *\r\n * This event is dispatched when a Video tries to play a source that does not exist, or is the wrong file type.\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('error', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_ERROR\r\n * @type {string}\r\n * @since 3.20.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object which threw the error.\r\n * @param {DOMException|string} event - The native DOM event the browser raised during playback.\r\n */", "meta": { "filename": "VIDEO_ERROR_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Error Event.\r\rThis event is dispatched when a Video tries to play a source that does not exist, or is the wrong file type.\r\rListen for it from a Video Game Object instance using `Video.on('error', listener)`.", "kind": "event", "name": "VIDEO_ERROR", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Video" } }, "description": "The Video Game Object which threw the error.", "name": "video" }, { "type": { "names": [ "DOMException", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "DOMException" }, { "type": "NameExpression", "name": "string" } ] } }, "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", "___id": "T000002R010624", "___s": true }, { "comment": "/**\r\n * The Video Game Object Locked Event.\r\n *\r\n * This event is dispatched when a Video was attempted to be played, but the browser prevented it\r\n * from doing so due to the Media Engagement Interaction policy.\r\n *\r\n * If you get this event you will need to wait for the user to interact with the browser before\r\n * the video will play. This is a browser security measure to prevent autoplaying videos with\r\n * audio. An interaction includes a mouse click, a touch, or a key press.\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('locked', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_LOCKED\r\n * @type {string}\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object which raised the event.\r\n */", "meta": { "filename": "VIDEO_LOCKED_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Locked Event.\r\rThis event is dispatched when a Video was attempted to be played, but the browser prevented it\rfrom doing so due to the Media Engagement Interaction policy.\r\rIf you get this event you will need to wait for the user to interact with the browser before\rthe video will play. This is a browser security measure to prevent autoplaying videos with\raudio. An interaction includes a mouse click, a touch, or a key press.\r\rListen for it from a Video Game Object instance using `Video.on('locked', listener)`.", "kind": "event", "name": "VIDEO_LOCKED", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Video" } }, "description": "The Video Game Object which raised the event.", "name": "video" } ], "memberof": "Phaser.GameObjects.Events", "longname": "Phaser.GameObjects.Events#event:VIDEO_LOCKED", "scope": "instance", "___id": "T000002R010626", "___s": true }, { "comment": "/**\r\n * The Video Game Object Loop Event.\r\n *\r\n * This event is dispatched when a Video that is currently playing has looped. This only\r\n * happens if the `loop` parameter was specified, or the `setLoop` method was called,\r\n * and if the video has a fixed duration. Video streams, for example, cannot loop, as\r\n * they have no duration.\r\n *\r\n * Looping is based on the result of the Video `timeupdate` event. This event is not\r\n * frame-accurate, due to the way browsers work, so please do not rely on this loop\r\n * event to be time or frame precise.\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('loop', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_LOOP\r\n * @type {string}\r\n * @since 3.20.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object which has looped.\r\n */", "meta": { "filename": "VIDEO_LOOP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Loop Event.\r\rThis event is dispatched when a Video that is currently playing has looped. This only\rhappens if the `loop` parameter was specified, or the `setLoop` method was called,\rand if the video has a fixed duration. Video streams, for example, cannot loop, as\rthey have no duration.\r\rLooping is based on the result of the Video `timeupdate` event. This event is not\rframe-accurate, due to the way browsers work, so please do not rely on this loop\revent to be time or frame precise.\r\rListen for it from a Video Game Object instance using `Video.on('loop', listener)`.", "kind": "event", "name": "VIDEO_LOOP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R010628", "___s": true }, { "comment": "/**\r\n * The Video Game Object Metadata Event.\r\n *\r\n * This event is dispatched when a Video has access to the metadata.\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('metadata', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_METADATA\r\n * @type {string}\r\n * @since 3.80.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object which fired the event.\r\n * @param {DOMException|string} event - The native DOM event the browser raised during playback.\r\n */", "meta": { "filename": "VIDEO_METADATA_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Metadata Event.\r\rThis event is dispatched when a Video has access to the metadata.\r\rListen for it from a Video Game Object instance using `Video.on('metadata', listener)`.", "kind": "event", "name": "VIDEO_METADATA", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.80.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Video" } }, "description": "The Video Game Object which fired the event.", "name": "video" }, { "type": { "names": [ "DOMException", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "DOMException" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The native DOM event the browser raised during playback.", "name": "event" } ], "memberof": "Phaser.GameObjects.Events", "longname": "Phaser.GameObjects.Events#event:VIDEO_METADATA", "scope": "instance", "___id": "T000002R010630", "___s": true }, { "comment": "/**\r\n * The Video Game Object Playing Event.\r\n *\r\n * The playing event is fired after playback is first started,\r\n * and whenever it is restarted. For example it is fired when playback\r\n * resumes after having been paused or delayed due to lack of data.\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('playing', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_PLAYING\r\n * @type {string}\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object which started playback.\r\n */", "meta": { "filename": "VIDEO_PLAYING_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Playing Event.\r\rThe playing event is fired after playback is first started,\rand whenever it is restarted. For example it is fired when playback\rresumes after having been paused or delayed due to lack of data.\r\rListen for it from a Video Game Object instance using `Video.on('playing', listener)`.", "kind": "event", "name": "VIDEO_PLAYING", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Video" } }, "description": "The Video Game Object which started playback.", "name": "video" } ], "memberof": "Phaser.GameObjects.Events", "longname": "Phaser.GameObjects.Events#event:VIDEO_PLAYING", "scope": "instance", "___id": "T000002R010632", "___s": true }, { "comment": "/**\r\n * The Video Game Object Play Event.\r\n *\r\n * This event is dispatched when a Video begins playback. For videos that do not require\r\n * interaction unlocking, this is usually as soon as the `Video.play` method is called.\r\n * However, for videos that require unlocking, it is fired once playback begins after\r\n * they've been unlocked.\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('play', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_PLAY\r\n * @type {string}\r\n * @since 3.20.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object which started playback.\r\n */", "meta": { "filename": "VIDEO_PLAY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Play Event.\r\rThis event is dispatched when a Video begins playback. For videos that do not require\rinteraction unlocking, this is usually as soon as the `Video.play` method is called.\rHowever, for videos that require unlocking, it is fired once playback begins after\rthey've been unlocked.\r\rListen for it from a Video Game Object instance using `Video.on('play', listener)`.", "kind": "event", "name": "VIDEO_PLAY", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R010634", "___s": true }, { "comment": "/**\r\n * The Video Game Object Seeked Event.\r\n *\r\n * This event is dispatched when a Video completes seeking to a new point in its timeline.\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('seeked', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_SEEKED\r\n * @type {string}\r\n * @since 3.20.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object which completed seeking.\r\n */", "meta": { "filename": "VIDEO_SEEKED_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Seeked Event.\r\rThis event is dispatched when a Video completes seeking to a new point in its timeline.\r\rListen for it from a Video Game Object instance using `Video.on('seeked', listener)`.", "kind": "event", "name": "VIDEO_SEEKED", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R010636", "___s": true }, { "comment": "/**\r\n * The Video Game Object Seeking Event.\r\n *\r\n * This event is dispatched when a Video _begins_ seeking to a new point in its timeline.\r\n * When the seek is complete, it will dispatch the `VIDEO_SEEKED` event to conclude.\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('seeking', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_SEEKING\r\n * @type {string}\r\n * @since 3.20.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object which started seeking.\r\n */", "meta": { "filename": "VIDEO_SEEKING_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Seeking Event.\r\rThis event is dispatched when a Video _begins_ seeking to a new point in its timeline.\rWhen the seek is complete, it will dispatch the `VIDEO_SEEKED` event to conclude.\r\rListen for it from a Video Game Object instance using `Video.on('seeking', listener)`.", "kind": "event", "name": "VIDEO_SEEKING", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R010638", "___s": true }, { "comment": "/**\r\n * The Video Game Object Stalled Event.\r\n *\r\n * This event is dispatched by a Video Game Object when the video playback stalls.\r\n *\r\n * This can happen if the video is buffering.\r\n *\r\n * If will fire for any of the following native DOM events:\r\n *\r\n * `stalled`\r\n * `suspend`\r\n * `waiting`\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('stalled', listener)`.\r\n *\r\n * Note that being stalled isn't always a negative thing. A video can be stalled if it\r\n * has downloaded enough data in to its buffer to not need to download any more until\r\n * the current batch of frames have rendered.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_STALLED\r\n * @type {string}\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object which threw the error.\r\n * @param {Event} event - The native DOM event the browser raised during playback.\r\n */", "meta": { "filename": "VIDEO_STALLED_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Stalled Event.\r\rThis event is dispatched by a Video Game Object when the video playback stalls.\r\rThis can happen if the video is buffering.\r\rIf will fire for any of the following native DOM events:\r\r`stalled`\r`suspend`\r`waiting`\r\rListen for it from a Video Game Object instance using `Video.on('stalled', listener)`.\r\rNote that being stalled isn't always a negative thing. A video can be stalled if it\rhas downloaded enough data in to its buffer to not need to download any more until\rthe current batch of frames have rendered.", "kind": "event", "name": "VIDEO_STALLED", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Video" } }, "description": "The Video Game Object which threw the error.", "name": "video" }, { "type": { "names": [ "Event" ], "parsedType": { "type": "NameExpression", "name": "Event" } }, "description": "The native DOM event the browser raised during playback.", "name": "event" } ], "memberof": "Phaser.GameObjects.Events", "longname": "Phaser.GameObjects.Events#event:VIDEO_STALLED", "scope": "instance", "___id": "T000002R010640", "___s": true }, { "comment": "/**\r\n * The Video Game Object Stopped Event.\r\n *\r\n * This event is dispatched when a Video is stopped from playback via a call to the `Video.stop` method,\r\n * either directly via game code, or indirectly as the result of changing a video source or destroying it.\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('stop', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_STOP\r\n * @type {string}\r\n * @since 3.20.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object which stopped playback.\r\n */", "meta": { "filename": "VIDEO_STOP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Stopped Event.\r\rThis event is dispatched when a Video is stopped from playback via a call to the `Video.stop` method,\reither directly via game code, or indirectly as the result of changing a video source or destroying it.\r\rListen for it from a Video Game Object instance using `Video.on('stop', listener)`.", "kind": "event", "name": "VIDEO_STOP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R010642", "___s": true }, { "comment": "/**\r\n * The Video Game Object Texture Ready Event.\r\n *\r\n * This event is dispatched by a Video Game Object when it has finished creating its texture.\r\n *\r\n * This happens when the video has finished loading enough data for its first frame.\r\n *\r\n * If you wish to use the Video texture elsewhere in your game, such as as a Sprite texture,\r\n * then you should listen for this event first, before creating the Sprites that use it.\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('textureready', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_TEXTURE\r\n * @type {string}\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object that emitted the event.\r\n * @param {Phaser.Textures.Texture} texture - The Texture that was created.\r\n */", "meta": { "filename": "VIDEO_TEXTURE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Texture Ready Event.\r\rThis event is dispatched by a Video Game Object when it has finished creating its texture.\r\rThis happens when the video has finished loading enough data for its first frame.\r\rIf you wish to use the Video texture elsewhere in your game, such as as a Sprite texture,\rthen you should listen for this event first, before creating the Sprites that use it.\r\rListen for it from a Video Game Object instance using `Video.on('textureready', listener)`.", "kind": "event", "name": "VIDEO_TEXTURE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Video" } }, "description": "The Video Game Object that emitted the event.", "name": "video" }, { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "description": "The Texture that was created.", "name": "texture" } ], "memberof": "Phaser.GameObjects.Events", "longname": "Phaser.GameObjects.Events#event:VIDEO_TEXTURE", "scope": "instance", "___id": "T000002R010644", "___s": true }, { "comment": "/**\r\n * The Video Game Object Unlocked Event.\r\n *\r\n * This event is dispatched when a Video that was prevented from playback due to the browsers\r\n * Media Engagement Interaction policy, is unlocked by a user gesture.\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('unlocked', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_UNLOCKED\r\n * @type {string}\r\n * @since 3.20.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object which raised the event.\r\n */", "meta": { "filename": "VIDEO_UNLOCKED_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Unlocked Event.\r\rThis event is dispatched when a Video that was prevented from playback due to the browsers\rMedia Engagement Interaction policy, is unlocked by a user gesture.\r\rListen for it from a Video Game Object instance using `Video.on('unlocked', listener)`.", "kind": "event", "name": "VIDEO_UNLOCKED", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.20.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R010646", "___s": true }, { "comment": "/**\r\n * The Video Game Object Unsupported Event.\r\n *\r\n * This event is dispatched by a Video Game Object if the media source\r\n * (which may be specified as a MediaStream, MediaSource, Blob, or File,\r\n * for example) doesn't represent a supported media format.\r\n *\r\n * Listen for it from a Video Game Object instance using `Video.on('unsupported', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Events#VIDEO_UNSUPPORTED\r\n * @type {string}\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Video} video - The Video Game Object which started playback.\r\n * @param {DOMException|string} event - The native DOM event the browser raised during playback.\r\n */", "meta": { "filename": "VIDEO_UNSUPPORTED_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\events", "code": {} }, "description": "The Video Game Object Unsupported Event.\r\rThis event is dispatched by a Video Game Object if the media source\r(which may be specified as a MediaStream, MediaSource, Blob, or File,\rfor example) doesn't represent a supported media format.\r\rListen for it from a Video Game Object instance using `Video.on('unsupported', listener)`.", "kind": "event", "name": "VIDEO_UNSUPPORTED", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Video" } }, "description": "The Video Game Object which started playback.", "name": "video" }, { "type": { "names": [ "DOMException", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "DOMException" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The native DOM event the browser raised during playback.", "name": "event" } ], "memberof": "Phaser.GameObjects.Events", "longname": "Phaser.GameObjects.Events#event:VIDEO_UNSUPPORTED", "scope": "instance", "___id": "T000002R010648", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An Extern Game Object is a special type of Game Object that allows you to pass\r\n * rendering off to a 3rd party.\r\n *\r\n * When you create an Extern and place it in the display list of a Scene, the renderer will\r\n * process the list as usual. When it finds an Extern it will flush the current batch\r\n * and prepare a transform matrix which your render function can\r\n * take advantage of, if required.\r\n *\r\n * The WebGL context is then left in a 'clean' state, ready for you to bind your own shaders,\r\n * or draw to it, whatever you wish to do. This should all take place in the `render` method.\r\n * The correct way to deploy an Extern object is to create a class that extends it, then\r\n * override the `render` (and optionally `preUpdate`) methods and pass off control to your\r\n * 3rd party libraries or custom WebGL code there.\r\n *\r\n * The `render` method is called with this signature:\r\n * `render(renderer: Phaser.Renderer.WebGL.WebGLRenderer, drawingContext: Phaser.Renderer.WebGL.DrawingContext, calcMatrix: Phaser.GameObjects.Components.TransformMatrix, displayList: Phaser.GameObjects.GameObject[], displayListIndex: number): void`.\r\n *\r\n * The `displayList` and `displayListIndex` parameters allow you to check\r\n * other objects in the display list. This might be convenient for optimizing\r\n * operations such as resource management.\r\n *\r\n * Once you've finished, you should free-up any of your resources.\r\n * The Extern will then return Phaser state and carry on rendering the display list.\r\n *\r\n * Although this object has lots of properties such as Alpha, Blend Mode and Tint, none of\r\n * them are used during rendering unless you take advantage of them in your own render code.\r\n *\r\n * @example\r\n * extern.render = (webGLRenderer, drawingContext, calcMatrix) => {\r\n * // You may want to initialize the external renderer here.\r\n * // ...\r\n * \r\n * // Ensure the DrawingContext framebuffer is bound.\r\n * // This allows you to use Filters on the external render.\r\n * webGLRenderer.glWrapper.updateBindingsFramebuffer({\r\n * bindings: {\r\n * framebuffer: drawingContext.framebuffer\r\n * }\r\n * }, true);\r\n * \r\n * // Run the external render method.\r\n * // ...\r\n * };\r\n *\r\n * @class Extern\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.16.0\r\n *\r\n * @extends Phaser.GameObjects.Components.Alpha\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Flip\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Size\r\n * @extends Phaser.GameObjects.Components.Texture\r\n * @extends Phaser.GameObjects.Components.Tint\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n */", "meta": { "filename": "Extern.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\extern", "code": {} }, "classdesc": "An Extern Game Object is a special type of Game Object that allows you to pass\rrendering off to a 3rd party.\r\rWhen you create an Extern and place it in the display list of a Scene, the renderer will\rprocess the list as usual. When it finds an Extern it will flush the current batch\rand prepare a transform matrix which your render function can\rtake advantage of, if required.\r\rThe WebGL context is then left in a 'clean' state, ready for you to bind your own shaders,\ror draw to it, whatever you wish to do. This should all take place in the `render` method.\rThe correct way to deploy an Extern object is to create a class that extends it, then\roverride the `render` (and optionally `preUpdate`) methods and pass off control to your\r3rd party libraries or custom WebGL code there.\r\rThe `render` method is called with this signature:\r`render(renderer: Phaser.Renderer.WebGL.WebGLRenderer, drawingContext: Phaser.Renderer.WebGL.DrawingContext, calcMatrix: Phaser.GameObjects.Components.TransformMatrix, displayList: Phaser.GameObjects.GameObject[], displayListIndex: number): void`.\r\rThe `displayList` and `displayListIndex` parameters allow you to check\rother objects in the display list. This might be convenient for optimizing\roperations such as resource management.\r\rOnce you've finished, you should free-up any of your resources.\rThe Extern will then return Phaser state and carry on rendering the display list.\r\rAlthough this object has lots of properties such as Alpha, Blend Mode and Tint, none of\rthem are used during rendering unless you take advantage of them in your own render code.", "examples": [ "extern.render = (webGLRenderer, drawingContext, calcMatrix) => {\r // You may want to initialize the external renderer here.\r // ...\r\r // Ensure the DrawingContext framebuffer is bound.\r // This allows you to use Filters on the external render.\r webGLRenderer.glWrapper.updateBindingsFramebuffer({\r bindings: {\r framebuffer: drawingContext.framebuffer\r }\r }, true);\r\r // Run the external render method.\r // ...\r };" ], "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R010654", "___s": true }, { "comment": "/**\r\n * Called when this Extern is added to a Scene.\r\n *\r\n * Registers the Extern with the Scene's Update List so that `preUpdate` is called each frame.\r\n *\r\n * @method Phaser.GameObjects.Extern#addedToScene\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Extern.js", "lineno": 104, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\extern", "code": {} }, "description": "Called when this Extern is added to a Scene.\r\rRegisters the Extern with the Scene's Update List so that `preUpdate` is called each frame.", "kind": "function", "name": "addedToScene", "since": "3.50.0", "memberof": "Phaser.GameObjects.Extern", "longname": "Phaser.GameObjects.Extern#addedToScene", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#addedToScene", "___id": "T000002R010659", "___s": true }, { "comment": "/**\r\n * Called when this Extern is removed from a Scene.\r\n *\r\n * Removes the Extern from the Scene's Update List so that `preUpdate` is no longer called.\r\n *\r\n * @method Phaser.GameObjects.Extern#removedFromScene\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Extern.js", "lineno": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\extern", "code": {} }, "description": "Called when this Extern is removed from a Scene.\r\rRemoves the Extern from the Scene's Update List so that `preUpdate` is no longer called.", "kind": "function", "name": "removedFromScene", "since": "3.50.0", "memberof": "Phaser.GameObjects.Extern", "longname": "Phaser.GameObjects.Extern#removedFromScene", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#removedFromScene", "___id": "T000002R010661", "___s": true }, { "comment": "/**\r\n * Called automatically by the Scene Update List each frame.\r\n *\r\n * Override this method in your own class to add custom logic that\r\n * should run every frame, such as updating animations or physics.\r\n *\r\n * @method Phaser.GameObjects.Extern#preUpdate\r\n * @since 3.16.0\r\n *\r\n * @param {number} time - The current timestamp, as generated by the Request Animation Frame or SetTimeout.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "Extern.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\extern", "code": {} }, "description": "Called automatically by the Scene Update List each frame.\r\rOverride this method in your own class to add custom logic that\rshould run every frame, such as updating animations or physics.", "kind": "function", "name": "preUpdate", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp, as generated by the Request Animation Frame or SetTimeout.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time, in ms, elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.GameObjects.Extern", "longname": "Phaser.GameObjects.Extern#preUpdate", "scope": "instance", "___id": "T000002R010663", "___s": true }, { "comment": "/**\r\n * Override this method in your own class to provide custom rendering logic.\r\n *\r\n * When the renderer encounters this Extern in the display list, it will flush the\r\n * current batch, prepare a transform matrix, and leave the WebGL context in a clean\r\n * state for you to bind your own shaders or draw calls.\r\n *\r\n * @method Phaser.GameObjects.Extern#render\r\n * @since 3.16.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - The WebGL Renderer instance.\r\n * @param {Phaser.Renderer.WebGL.DrawingContext} drawingContext - The current Drawing Context.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} calcMatrix - The calculated Transform Matrix for this Extern.\r\n * @param {Phaser.GameObjects.GameObject[]} displayList - The current display list for the Scene.\r\n * @param {number} displayListIndex - The index of this Extern within the display list.\r\n */", "meta": { "filename": "Extern.js", "lineno": 148, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\extern", "code": {} }, "description": "Override this method in your own class to provide custom rendering logic.\r\rWhen the renderer encounters this Extern in the display list, it will flush the\rcurrent batch, prepare a transform matrix, and leave the WebGL context in a clean\rstate for you to bind your own shaders or draw calls.", "kind": "function", "name": "render", "since": "3.16.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "The WebGL Renderer instance.", "name": "renderer" }, { "type": { "names": [ "Phaser.Renderer.WebGL.DrawingContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.DrawingContext" } }, "description": "The current Drawing Context.", "name": "drawingContext" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The calculated Transform Matrix for this Extern.", "name": "calcMatrix" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "The current display list for the Scene.", "name": "displayList" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of this Extern within the display list.", "name": "displayListIndex" } ], "memberof": "Phaser.GameObjects.Extern", "longname": "Phaser.GameObjects.Extern#render", "scope": "instance", "___id": "T000002R010665", "___s": true }, { "comment": "/**\r\n * Creates a new Extern Game Object and adds it to the Scene's display list.\r\n *\r\n * An Extern is a special type of Game Object that allows you to integrate custom rendering\r\n * logic directly into Phaser's render pipeline. By adding an Extern to the display list,\r\n * you can inject your own WebGL or Canvas draw calls at a specific point in the rendering\r\n * order, without Phaser interfering with the renderer state. This is useful when you need\r\n * to use a third-party renderer, perform custom GPU operations, or render content that\r\n * Phaser does not natively support, while still having it composited correctly with other\r\n * Game Objects in your Scene.\r\n *\r\n * Note: This method will only be available if the Extern Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#extern\r\n * @since 3.16.0\r\n *\r\n * @return {Phaser.GameObjects.Extern} The Extern Game Object that was created and added to the display list.\r\n */", "meta": { "filename": "ExternFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\extern", "code": {} }, "description": "Creates a new Extern Game Object and adds it to the Scene's display list.\r\rAn Extern is a special type of Game Object that allows you to integrate custom rendering\rlogic directly into Phaser's render pipeline. By adding an Extern to the display list,\ryou can inject your own WebGL or Canvas draw calls at a specific point in the rendering\rorder, without Phaser interfering with the renderer state. This is useful when you need\rto use a third-party renderer, perform custom GPU operations, or render content that\rPhaser does not natively support, while still having it composited correctly with other\rGame Objects in your Scene.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Extern" } }, "description": "The Extern Game Object that was created and added to the display list." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#extern", "scope": "instance", "___id": "T000002R010670", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The base class that all Game Objects in Phaser extend.\r\n *\r\n * A Game Object is anything that can be added to a Scene's display list and rendered to screen,\r\n * such as a Sprite, Image, Text, or Graphics object. Game Objects are the building blocks of\r\n * every Phaser game — they represent visual entities that live in a Scene, can be positioned,\r\n * scaled, rotated, and interacted with.\r\n *\r\n * This class provides the core shared functionality used by all Game Objects: lifecycle management\r\n * (active/destroy), data storage via the Data Manager, input handling, physics body attachment,\r\n * display list and update list membership, and event emission.\r\n *\r\n * You do not instantiate `GameObject` directly. Instead, use it as the base class for your own\r\n * custom Game Object types by extending it through Phaser's `Class` utility, or simply use one\r\n * of the many built-in Game Object types provided by Phaser.\r\n *\r\n * @class GameObject\r\n * @memberof Phaser.GameObjects\r\n * @extends Phaser.Events.EventEmitter\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.GameObjects.Components.Filters\r\n * @extends Phaser.GameObjects.Components.RenderSteps\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {string} type - A textual representation of the type of Game Object, i.e. `sprite`.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "classdesc": "The base class that all Game Objects in Phaser extend.\r\rA Game Object is anything that can be added to a Scene's display list and rendered to screen,\rsuch as a Sprite, Image, Text, or Graphics object. Game Objects are the building blocks of\revery Phaser game — they represent visual entities that live in a Scene, can be positioned,\rscaled, rotated, and interacted with.\r\rThis class provides the core shared functionality used by all Game Objects: lifecycle management\r(active/destroy), data storage via the Data Manager, input handling, physics body attachment,\rdisplay list and update list membership, and event emission.\r\rYou do not instantiate `GameObject` directly. Instead, use it as the base class for your own\rcustom Game Object types by extending it through Phaser's `Class` utility, or simply use one\rof the many built-in Game Object types provided by Phaser.", "kind": "class", "name": "GameObject", "memberof": "Phaser.GameObjects", "augments": [ "Phaser.Events.EventEmitter", "Phaser.GameObjects.Components.Filters", "Phaser.GameObjects.Components.RenderSteps" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A textual representation of the type of Game Object, i.e. `sprite`.", "name": "type" } ], "scope": "static", "longname": "Phaser.GameObjects.GameObject", "___id": "T000002R010692", "___s": true }, { "comment": "/**\r\n * A reference to the Scene to which this Game Object belongs.\r\n *\r\n * Game Objects can only belong to one Scene.\r\n *\r\n * You should consider this property as being read-only. You cannot move a\r\n * Game Object to another Scene by simply changing it.\r\n *\r\n * @name Phaser.GameObjects.GameObject#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "A reference to the Scene to which this Game Object belongs.\r\rGame Objects can only belong to one Scene.\r\rYou should consider this property as being read-only. You cannot move a\rGame Object to another Scene by simply changing it.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#scene", "scope": "instance", "kind": "member", "___id": "T000002R010697", "___s": true }, { "comment": "/**\r\n * Holds a reference to the Display List that contains this Game Object.\r\n *\r\n * This is set automatically when this Game Object is added to a Scene or Layer.\r\n *\r\n * You should treat this property as being read-only.\r\n *\r\n * @name Phaser.GameObjects.GameObject#displayList\r\n * @type {(Phaser.GameObjects.DisplayList|Phaser.GameObjects.Layer)}\r\n * @default null\r\n * @since 3.50.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Holds a reference to the Display List that contains this Game Object.\r\rThis is set automatically when this Game Object is added to a Scene or Layer.\r\rYou should treat this property as being read-only.", "name": "displayList", "type": { "names": [ "Phaser.GameObjects.DisplayList", "Phaser.GameObjects.Layer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.DisplayList" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Layer" } ] } }, "defaultvalue": "null", "since": "3.50.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#displayList", "scope": "instance", "kind": "member", "___id": "T000002R010699", "___s": true }, { "comment": "/**\r\n * A textual representation of this Game Object, i.e. `sprite`.\r\n * Used internally by Phaser but is available for your own custom classes to populate.\r\n *\r\n * @name Phaser.GameObjects.GameObject#type\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 87, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "A textual representation of this Game Object, i.e. `sprite`.\rUsed internally by Phaser but is available for your own custom classes to populate.", "name": "type", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#type", "scope": "instance", "kind": "member", "___id": "T000002R010701", "___s": true }, { "comment": "/**\r\n * The current state of this Game Object.\r\n *\r\n * Phaser itself will never modify this value, although plugins may do so.\r\n *\r\n * Use this property to track the state of a Game Object during its lifetime. For example, it could change from\r\n * a state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\r\n * in your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\r\n * If you need to store complex data about your Game Object, look at using the Data Component instead.\r\n *\r\n * @name Phaser.GameObjects.GameObject#state\r\n * @type {(number|string)}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The current state of this Game Object.\r\rPhaser itself will never modify this value, although plugins may do so.\r\rUse this property to track the state of a Game Object during its lifetime. For example, it could change from\ra state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant\rin your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.\rIf you need to store complex data about your Game Object, look at using the Data Component instead.", "name": "state", "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.16.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#state", "scope": "instance", "kind": "member", "___id": "T000002R010703", "___s": true }, { "comment": "/**\r\n * The parent Container of this Game Object, if it has one.\r\n *\r\n * @name Phaser.GameObjects.GameObject#parentContainer\r\n * @type {Phaser.GameObjects.Container}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The parent Container of this Game Object, if it has one.", "name": "parentContainer", "type": { "names": [ "Phaser.GameObjects.Container" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Container" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#parentContainer", "scope": "instance", "kind": "member", "___id": "T000002R010705", "___s": true }, { "comment": "/**\r\n * The name of this Game Object.\r\n * Empty by default and never populated by Phaser, this is left for developers to use.\r\n *\r\n * @name Phaser.GameObjects.GameObject#name\r\n * @type {string}\r\n * @default ''\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The name of this Game Object.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#name", "scope": "instance", "kind": "member", "___id": "T000002R010707", "___s": true }, { "comment": "/**\r\n * The active state of this Game Object.\r\n * A Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\r\n * An active object is one which is having its logic and internal systems updated.\r\n *\r\n * @name Phaser.GameObjects.GameObject#active\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 133, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The active state of this Game Object.\rA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.\rAn active object is one which is having its logic and internal systems updated.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#active", "scope": "instance", "kind": "member", "___id": "T000002R010709", "___s": true }, { "comment": "/**\r\n * The Tab Index of the Game Object.\r\n * Reserved for future use by plugins and the Input Manager.\r\n *\r\n * @name Phaser.GameObjects.GameObject#tabIndex\r\n * @type {number}\r\n * @default -1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The Tab Index of the Game Object.\rReserved for future use by plugins and the Input Manager.", "name": "tabIndex", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#tabIndex", "scope": "instance", "kind": "member", "___id": "T000002R010711", "___s": true }, { "comment": "/**\r\n * A Data Manager.\r\n * It allows you to store, query and get key/value paired information specific to this Game Object.\r\n * `null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.\r\n *\r\n * @name Phaser.GameObjects.GameObject#data\r\n * @type {Phaser.Data.DataManager}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 156, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "A Data Manager.\rIt allows you to store, query and get key/value paired information specific to this Game Object.\r`null` by default. Automatically created if you use `getData` or `setData` or `setDataEnabled`.", "name": "data", "type": { "names": [ "Phaser.Data.DataManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Data.DataManager" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#data", "scope": "instance", "kind": "member", "___id": "T000002R010713", "___s": true }, { "comment": "/**\r\n * The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\r\n * The bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\r\n * If those components are not used by your custom class then you can use this bitmask as you wish.\r\n *\r\n * @name Phaser.GameObjects.GameObject#renderFlags\r\n * @type {number}\r\n * @default 15\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 168, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\rThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\rIf those components are not used by your custom class then you can use this bitmask as you wish.", "name": "renderFlags", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#renderFlags", "scope": "instance", "kind": "member", "___id": "T000002R010715", "___s": true }, { "comment": "/**\r\n * A bitmask that controls if this Game Object is drawn by a Camera or not.\r\n * Not usually set directly, instead call `Camera.ignore`, however you can\r\n * set this property directly using the Camera.id property:\r\n *\r\n * @example\r\n * this.cameraFilter |= camera.id\r\n *\r\n * @name Phaser.GameObjects.GameObject#cameraFilter\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 180, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "A bitmask that controls if this Game Object is drawn by a Camera or not.\rNot usually set directly, instead call `Camera.ignore`, however you can\rset this property directly using the Camera.id property:", "examples": [ "this.cameraFilter |= camera.id" ], "name": "cameraFilter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#cameraFilter", "scope": "instance", "kind": "member", "___id": "T000002R010717", "___s": true }, { "comment": "/**\r\n * The current vertex rounding mode of this Game Object.\r\n * This is used by the WebGL Renderer to determine how to round the vertex positions.\r\n * It can have several values:\r\n *\r\n * - `off` - No rounding is applied.\r\n * - `safe` - Rounding is applied if the object is 'safe'.\r\n * - `safeAuto` - Rounding is applied if the object is 'safe' and the camera has `roundPixels` enabled.\r\n * - `full` - Rounding is always applied.\r\n * - `fullAuto` - Rounding is always applied if the camera has `roundPixels` enabled.\r\n *\r\n * A 'safe' object is one that is not rotated or scaled\r\n * by any transform matrix while rendering.\r\n * The effective transform is a simple translation.\r\n * In such cases, rounding will affect all vertices the same way.\r\n *\r\n * Using full rounding can cause vertices to wobble, because they might\r\n * not be aligned to the pixel grid.\r\n * Full rounding gives a janky look like PS1 games.\r\n *\r\n * You can use other values if you want to create your own custom rounding modes.\r\n *\r\n * @name Phaser.GameObjects.GameObject#vertexRoundMode\r\n * @type {string}\r\n * @default 'safeAuto'\r\n * @since 4.0.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 195, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The current vertex rounding mode of this Game Object.\rThis is used by the WebGL Renderer to determine how to round the vertex positions.\rIt can have several values:\r\r- `off` - No rounding is applied.\r- `safe` - Rounding is applied if the object is 'safe'.\r- `safeAuto` - Rounding is applied if the object is 'safe' and the camera has `roundPixels` enabled.\r- `full` - Rounding is always applied.\r- `fullAuto` - Rounding is always applied if the camera has `roundPixels` enabled.\r\rA 'safe' object is one that is not rotated or scaled\rby any transform matrix while rendering.\rThe effective transform is a simple translation.\rIn such cases, rounding will affect all vertices the same way.\r\rUsing full rounding can cause vertices to wobble, because they might\rnot be aligned to the pixel grid.\rFull rounding gives a janky look like PS1 games.\r\rYou can use other values if you want to create your own custom rounding modes.", "name": "vertexRoundMode", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "'safeAuto'", "since": "4.0.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#vertexRoundMode", "scope": "instance", "kind": "member", "___id": "T000002R010719", "___s": true }, { "comment": "/**\r\n * If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\r\n * Not usually set directly. Instead call `GameObject.setInteractive()`.\r\n *\r\n * @name Phaser.GameObjects.GameObject#input\r\n * @type {?Phaser.Types.Input.InteractiveObject}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 224, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\rNot usually set directly. Instead call `GameObject.setInteractive()`.", "name": "input", "type": { "names": [ "Phaser.Types.Input.InteractiveObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.InteractiveObject", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#input", "scope": "instance", "kind": "member", "___id": "T000002R010721", "___s": true }, { "comment": "/**\r\n * If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics Body.\r\n *\r\n * @name Phaser.GameObjects.GameObject#body\r\n * @type {?(Phaser.Physics.Arcade.Body|Phaser.Physics.Arcade.StaticBody|MatterJS.BodyType)}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 235, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics Body.", "name": "body", "type": { "names": [ "Phaser.Physics.Arcade.Body", "Phaser.Physics.Arcade.StaticBody", "MatterJS.BodyType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.StaticBody" }, { "type": "NameExpression", "name": "MatterJS.BodyType" } ], "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#body", "scope": "instance", "kind": "member", "___id": "T000002R010723", "___s": true }, { "comment": "/**\r\n * This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\r\n * This includes calls that may come from a Group, Container or the Scene itself.\r\n * While it allows you to persist a Game Object across Scenes, please understand you are entirely\r\n * responsible for managing references to and from this Game Object.\r\n *\r\n * @name Phaser.GameObjects.GameObject#ignoreDestroy\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.5.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "This Game Object will ignore all calls made to its destroy method if this flag is set to `true`.\rThis includes calls that may come from a Group, Container or the Scene itself.\rWhile it allows you to persist a Game Object across Scenes, please understand you are entirely\rresponsible for managing references to and from this Game Object.", "name": "ignoreDestroy", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.5.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#ignoreDestroy", "scope": "instance", "kind": "member", "___id": "T000002R010725", "___s": true }, { "comment": "/**\r\n * Whether this Game Object has been destroyed.\r\n * Check this property to avoid bugs caused by calling methods on a\r\n * destroyed Game Object, e.g. in a Tween or Timer.\r\n *\r\n * This is a read-only property that is automatically set to `true`\r\n * when the Game Object is destroyed.\r\n * You should not set this property directly.\r\n * It is set before `preDestroy` is called or the DESTROY event is emitted.\r\n *\r\n * @name Phaser.GameObjects.GameObject#isDestroyed\r\n * @type {boolean}\r\n * @default false\r\n * @readonly\r\n * @since 4.0.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 258, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Whether this Game Object has been destroyed.\rCheck this property to avoid bugs caused by calling methods on a\rdestroyed Game Object, e.g. in a Tween or Timer.\r\rThis is a read-only property that is automatically set to `true`\rwhen the Game Object is destroyed.\rYou should not set this property directly.\rIt is set before `preDestroy` is called or the DESTROY event is emitted.", "name": "isDestroyed", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "readonly": true, "since": "4.0.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#isDestroyed", "scope": "instance", "kind": "member", "___id": "T000002R010727", "___s": true }, { "comment": "/**\r\n * Sets the `active` property of this Game Object and returns this Game Object for further chaining.\r\n * A Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.\r\n *\r\n * @method Phaser.GameObjects.GameObject#setActive\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - True if this Game Object should be set as active, false if not.\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Sets the `active` property of this Game Object and returns this Game Object for further chaining.\rA 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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if this Game Object should be set as active, false if not.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#setActive", "scope": "instance", "___id": "T000002R010729", "___s": true }, { "comment": "/**\r\n * Sets the `name` property of this Game Object and returns this Game Object for further chaining.\r\n * The `name` property is not populated by Phaser and is presented for your own use.\r\n *\r\n * @method Phaser.GameObjects.GameObject#setName\r\n * @since 3.0.0\r\n *\r\n * @param {string} value - The name to be given to this Game Object.\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 307, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Sets the `name` property of this Game Object and returns this Game Object for further chaining.\rThe `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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Game Object.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#setName", "scope": "instance", "___id": "T000002R010732", "___s": true }, { "comment": "/**\r\n * Sets the current state of this Game Object.\r\n *\r\n * Phaser itself will never modify the State of a Game Object, although plugins may do so.\r\n *\r\n * For example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\r\n * The state value should typically be an integer (ideally mapped to a constant\r\n * in your game code), but could also be a string. It is recommended to keep it light and simple.\r\n * If you need to store complex data about your Game Object, look at using the Data Component instead.\r\n *\r\n * @method Phaser.GameObjects.GameObject#setState\r\n * @since 3.16.0\r\n *\r\n * @param {(number|string)} value - The state of the Game Object.\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 325, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Sets the current state of this Game Object.\r\rPhaser itself will never modify the State of a Game Object, although plugins may do so.\r\rFor example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.\rThe state value should typically be an integer (ideally mapped to a constant\rin your game code), but could also be a string. It is recommended to keep it light and simple.\rIf 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": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The state of the Game Object.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#setState", "scope": "instance", "___id": "T000002R010735", "___s": true }, { "comment": "/**\r\n * Adds a Data Manager component to this Game Object.\r\n *\r\n * @method Phaser.GameObjects.GameObject#setDataEnabled\r\n * @since 3.0.0\r\n * @see Phaser.Data.DataManager\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 349, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#setDataEnabled", "scope": "instance", "___id": "T000002R010738", "___s": true }, { "comment": "/**\r\n * Allows you to store a key value pair within this Game Objects Data Manager.\r\n *\r\n * If the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\r\n * before setting the value.\r\n *\r\n * If the key doesn't already exist in the Data Manager then it is created.\r\n *\r\n * ```javascript\r\n * sprite.setData('name', 'Red Gem Stone');\r\n * ```\r\n *\r\n * You can also pass in an object of key value pairs as the first argument:\r\n *\r\n * ```javascript\r\n * sprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\r\n * ```\r\n *\r\n * To get a value back again you can call `getData`:\r\n *\r\n * ```javascript\r\n * sprite.getData('gold');\r\n * ```\r\n *\r\n * Or you can access the value directly via the `values` property, where it works like any other variable:\r\n *\r\n * ```javascript\r\n * sprite.data.values.gold += 50;\r\n * ```\r\n *\r\n * When the value is first set, a `setdata` event is emitted from this Game Object.\r\n *\r\n * If the key already exists, a `changedata` event is emitted instead, along an event named after the key.\r\n * For example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\r\n * These events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\r\n *\r\n * Please note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\r\n * This means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.\r\n *\r\n * @method Phaser.GameObjects.GameObject#setData\r\n * @since 3.0.0\r\n *\r\n * @generic {any} T\r\n * @genericUse {(string|T)} - [key]\r\n *\r\n * @param {(string|object)} key - The key to set the value for. Or an object of key value pairs. If an object the `data` argument is ignored.\r\n * @param {*} [value] - The value to set for the given key. If an object is provided as the key this argument is ignored.\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Allows you to store a key value pair within this Game Objects Data Manager.\r\rIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\rbefore setting the value.\r\rIf the key doesn't already exist in the Data Manager then it is created.\r\r```javascript\rsprite.setData('name', 'Red Gem Stone');\r```\r\rYou can also pass in an object of key value pairs as the first argument:\r\r```javascript\rsprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });\r```\r\rTo get a value back again you can call `getData`:\r\r```javascript\rsprite.getData('gold');\r```\r\rOr you can access the value directly via the `values` property, where it works like any other variable:\r\r```javascript\rsprite.data.values.gold += 50;\r```\r\rWhen the value is first set, a `setdata` event is emitted from this Game Object.\r\rIf the key already exists, a `changedata` event is emitted instead, along an event named after the key.\rFor example, if you updated an existing key called `PlayerLives` then it would emit the event `changedata-PlayerLives`.\rThese events will be emitted regardless if you use this method to set the value, or the direct `values` setter.\r\rPlease note that the data keys are case-sensitive and must be valid JavaScript Object property strings.\rThis means the keys `gold` and `Gold` are treated as two unique values within the Data Manager.", "kind": "function", "name": "setData", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{any} T", "value": "{any} T" }, { "originalTitle": "genericUse", "title": "genericuse", "text": "{(string|T)} - [key]", "value": "{(string|T)} - [key]" } ], "params": [ { "type": { "names": [ "string", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "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": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The value to set for the given key. If an object is provided as the key this argument is ignored.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#setData", "scope": "instance", "___id": "T000002R010741", "___s": true }, { "comment": "/**\r\n * Increase a value for the given key within this Game Object's Data Manager. If the key doesn't already exist in the Data Manager then it is created with a value of 0 before being increased.\r\n *\r\n * If the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\r\n * before setting the value.\r\n *\r\n * If the key doesn't already exist in the Data Manager then it is created.\r\n *\r\n * When the value is first set, a `setdata` event is emitted from this Game Object.\r\n *\r\n * @method Phaser.GameObjects.GameObject#incData\r\n * @since 3.23.0\r\n *\r\n * @param {string} key - The key to change the value for.\r\n * @param {number} [amount=1] - The amount to increase the given key by. Pass a negative value to decrease the key.\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Increase a value for the given key within this Game Object's Data Manager. If the key doesn't already exist in the Data Manager then it is created with a value of 0 before being increased.\r\rIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\rbefore setting the value.\r\rIf the key doesn't already exist in the Data Manager then it is created.\r\rWhen the value is first set, a `setdata` event is emitted from this Game Object.", "kind": "function", "name": "incData", "since": "3.23.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to change the value for.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The amount to increase the given key by. Pass a negative value to decrease the key.", "name": "amount" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#incData", "scope": "instance", "___id": "T000002R010744", "___s": true }, { "comment": "/**\r\n * Toggle a boolean value for the given key within this Game Object's Data Manager. If the key doesn't already exist in the Data Manager then it is created with a value of `false` before being toggled to `true`.\r\n *\r\n * If the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\r\n * before setting the value.\r\n *\r\n * If the key doesn't already exist in the Data Manager then it is created.\r\n *\r\n * When the value is first set, a `setdata` event is emitted from this Game Object.\r\n *\r\n * @method Phaser.GameObjects.GameObject#toggleData\r\n * @since 3.23.0\r\n *\r\n * @param {string} key - The key to toggle the value for.\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 460, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Toggle a boolean value for the given key within this Game Object's Data Manager. If the key doesn't already exist in the Data Manager then it is created with a value of `false` before being toggled to `true`.\r\rIf the Game Object has not been enabled for data (via `setDataEnabled`) then it will be enabled\rbefore setting the value.\r\rIf the key doesn't already exist in the Data Manager then it is created.\r\rWhen the value is first set, a `setdata` event is emitted from this Game Object.", "kind": "function", "name": "toggleData", "since": "3.23.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to toggle the value for.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#toggleData", "scope": "instance", "___id": "T000002R010747", "___s": true }, { "comment": "/**\r\n * Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\r\n *\r\n * You can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\r\n *\r\n * ```javascript\r\n * sprite.getData('gold');\r\n * ```\r\n *\r\n * Or access the value directly:\r\n *\r\n * ```javascript\r\n * sprite.data.values.gold;\r\n * ```\r\n *\r\n * You can also pass in an array of keys, in which case an array of values will be returned:\r\n *\r\n * ```javascript\r\n * sprite.getData([ 'gold', 'armor', 'health' ]);\r\n * ```\r\n *\r\n * This approach is useful for destructuring arrays in ES6.\r\n *\r\n * @method Phaser.GameObjects.GameObject#getData\r\n * @since 3.0.0\r\n *\r\n * @param {(string|string[])} key - The key of the value to retrieve, or an array of keys.\r\n *\r\n * @return {*} The value belonging to the given key, or an array of values, the order of which will match the input array.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 489, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.\r\rYou can also access values via the `values` object. For example, if you had a key called `gold` you can do either:\r\r```javascript\rsprite.getData('gold');\r```\r\rOr access the value directly:\r\r```javascript\rsprite.data.values.gold;\r```\r\rYou can also pass in an array of keys, in which case an array of values will be returned:\r\r```javascript\rsprite.getData([ 'gold', 'armor', 'health' ]);\r```\r\rThis approach is useful for destructuring arrays in ES6.", "kind": "function", "name": "getData", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "description": "The key of the value to retrieve, or an array of keys.", "name": "key" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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", "___id": "T000002R010750", "___s": true }, { "comment": "/**\r\n * Pass this Game Object to the Input Manager to enable it for Input.\r\n *\r\n * Input works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\r\n * for the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\r\n * input detection.\r\n *\r\n * If no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\r\n * this isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\r\n * shape for it to use.\r\n *\r\n * You can also provide an Input Configuration Object as the only argument to this method.\r\n *\r\n * @example\r\n * sprite.setInteractive();\r\n *\r\n * @example\r\n * sprite.setInteractive(new Phaser.Geom.Circle(45, 46, 45), Phaser.Geom.Circle.Contains);\r\n *\r\n * @example\r\n * graphics.setInteractive(new Phaser.Geom.Rectangle(0, 0, 128, 128), Phaser.Geom.Rectangle.Contains);\r\n *\r\n * @method Phaser.GameObjects.GameObject#setInteractive\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Types.Input.InputConfiguration|any)} [hitArea] - Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not given it will try to create a Rectangle based on the texture frame.\r\n * @param {Phaser.Types.Input.HitAreaCallback} [callback] - The callback that determines if the pointer is within the Hit Area shape or not. If you provide a shape you must also provide a callback.\r\n * @param {boolean} [dropZone=false] - Should this Game Object be treated as a drop zone target?\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 529, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Pass this Game Object to the Input Manager to enable it for Input.\r\rInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\rfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\rinput detection.\r\rIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\rthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\rshape for it to use.\r\rYou can also provide an Input Configuration Object as the only argument to this method.", "examples": [ "sprite.setInteractive();", "sprite.setInteractive(new Phaser.Geom.Circle(45, 46, 45), Phaser.Geom.Circle.Contains);", "graphics.setInteractive(new Phaser.Geom.Rectangle(0, 0, 128, 128), Phaser.Geom.Rectangle.Contains);" ], "kind": "function", "name": "setInteractive", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Input.InputConfiguration", "any" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Input.InputConfiguration" }, { "type": "NameExpression", "name": "any" } ] } }, "optional": true, "description": "Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not given it will try to create a Rectangle based on the texture frame.", "name": "hitArea" }, { "type": { "names": [ "Phaser.Types.Input.HitAreaCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.HitAreaCallback" } }, "optional": true, "description": "The callback that determines if the pointer is within the Hit Area shape or not. If you provide a shape you must also provide a callback.", "name": "callback" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should this Game Object be treated as a drop zone target?", "name": "dropZone" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#setInteractive", "scope": "instance", "___id": "T000002R010753", "___s": true }, { "comment": "/**\r\n * If this Game Object has previously been enabled for input, this will disable it.\r\n *\r\n * An object that is disabled for input stops processing or being considered for\r\n * input events, but can be turned back on again at any time by simply calling\r\n * `setInteractive()` with no arguments provided.\r\n *\r\n * If want to completely remove interaction from this Game Object then use `removeInteractive` instead.\r\n *\r\n * @method Phaser.GameObjects.GameObject#disableInteractive\r\n * @since 3.7.0\r\n * \r\n * @param {boolean} [resetCursor=false] - Should the currently active Input cursor, if any, be reset to the default cursor?\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 567, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "If this Game Object has previously been enabled for input, this will disable it.\r\rAn object that is disabled for input stops processing or being considered for\rinput events, but can be turned back on again at any time by simply calling\r`setInteractive()` with no arguments provided.\r\rIf want to completely remove interaction from this Game Object then use `removeInteractive` instead.", "kind": "function", "name": "disableInteractive", "since": "3.7.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the currently active Input cursor, if any, be reset to the default cursor?", "name": "resetCursor" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#disableInteractive", "scope": "instance", "___id": "T000002R010755", "___s": true }, { "comment": "/**\r\n * If this Game Object has previously been enabled for input, this will queue it\r\n * for removal, causing it to no longer be interactive. The removal happens on\r\n * the next game step, it is not immediate.\r\n *\r\n * The Interactive Object that was assigned to this Game Object will be destroyed,\r\n * removed from the Input Manager and cleared from this Game Object.\r\n *\r\n * If you wish to re-enable this Game Object at a later date you will need to\r\n * re-create its InteractiveObject by calling `setInteractive` again.\r\n *\r\n * If you wish to only temporarily stop an object from receiving input then use\r\n * `disableInteractive` instead, as that toggles the interactive state, where-as\r\n * this erases it completely.\r\n *\r\n * If you wish to resize a hit area, don't remove and then set it as being\r\n * interactive. Instead, access the hitarea object directly and resize the shape\r\n * being used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\r\n * shape is a Rectangle, which it is by default.)\r\n *\r\n * @method Phaser.GameObjects.GameObject#removeInteractive\r\n * @since 3.7.0\r\n * \r\n * @param {boolean} [resetCursor=false] - Should the currently active Input cursor, if any, be reset to the default cursor?\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 592, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "If this Game Object has previously been enabled for input, this will queue it\rfor removal, causing it to no longer be interactive. The removal happens on\rthe next game step, it is not immediate.\r\rThe Interactive Object that was assigned to this Game Object will be destroyed,\rremoved from the Input Manager and cleared from this Game Object.\r\rIf you wish to re-enable this Game Object at a later date you will need to\rre-create its InteractiveObject by calling `setInteractive` again.\r\rIf you wish to only temporarily stop an object from receiving input then use\r`disableInteractive` instead, as that toggles the interactive state, where-as\rthis erases it completely.\r\rIf you wish to resize a hit area, don't remove and then set it as being\rinteractive. Instead, access the hitarea object directly and resize the shape\rbeing used. I.e.: `sprite.input.hitArea.setSize(width, height)` (assuming the\rshape is a Rectangle, which it is by default.)", "kind": "function", "name": "removeInteractive", "since": "3.7.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the currently active Input cursor, if any, be reset to the default cursor?", "name": "resetCursor" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#removeInteractive", "scope": "instance", "___id": "T000002R010758", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is added to a Scene.\r\n *\r\n * Can be overridden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to add themselves into the Update List.\r\n *\r\n * You can also listen for the `ADDED_TO_SCENE` event from this Game Object.\r\n *\r\n * @method Phaser.GameObjects.GameObject#addedToScene\r\n * @since 3.50.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 635, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "This callback is invoked when this Game Object is added to a Scene.\r\rCan be overridden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to add themselves into the Update List.\r\rYou can also listen for the `ADDED_TO_SCENE` event from this Game Object.", "kind": "function", "name": "addedToScene", "since": "3.50.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#addedToScene", "scope": "instance", "___id": "T000002R010762", "___s": true }, { "comment": "/**\r\n * This callback is invoked when this Game Object is removed from a Scene.\r\n *\r\n * Can be overridden by custom Game Objects, but be aware of some Game Objects that\r\n * will use this, such as Sprites, to remove themselves from the Update List.\r\n *\r\n * You can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.\r\n *\r\n * @method Phaser.GameObjects.GameObject#removedFromScene\r\n * @since 3.50.0\r\n */", "meta": { "filename": "GameObject.js", "lineno": 650, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "This callback is invoked when this Game Object is removed from a Scene.\r\rCan be overridden by custom Game Objects, but be aware of some Game Objects that\rwill use this, such as Sprites, to remove themselves from the Update List.\r\rYou can also listen for the `REMOVED_FROM_SCENE` event from this Game Object.", "kind": "function", "name": "removedFromScene", "since": "3.50.0", "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#removedFromScene", "scope": "instance", "___id": "T000002R010764", "___s": true }, { "comment": "/**\r\n * Override this method in your own custom Game Objects to perform per-frame update logic.\r\n * This method is called by the Scene's Update List on every game frame, if the Game Object\r\n * is on that list. It is not called automatically — the Game Object must be added to the\r\n * Update List via `addToUpdateList` or by having a `preUpdate` method.\r\n *\r\n * This base implementation is intentionally empty, allowing Game Objects to be used in an\r\n * Object Pool without requiring any update logic.\r\n *\r\n * @method Phaser.GameObjects.GameObject#update\r\n * @since 3.0.0\r\n *\r\n * @param {...*} [args] - Any arguments that are passed to the update method.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 665, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Override this method in your own custom Game Objects to perform per-frame update logic.\rThis method is called by the Scene's Update List on every game frame, if the Game Object\ris on that list. It is not called automatically — the Game Object must be added to the\rUpdate List via `addToUpdateList` or by having a `preUpdate` method.\r\rThis base implementation is intentionally empty, allowing Game Objects to be used in an\rObject Pool without requiring any update logic.", "kind": "function", "name": "update", "since": "3.0.0", "params": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "Any arguments that are passed to the update method.", "name": "args" } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#update", "scope": "instance", "___id": "T000002R010766", "___s": true }, { "comment": "/**\r\n * Returns a JSON representation of the Game Object.\r\n *\r\n * @method Phaser.GameObjects.GameObject#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.GameObjects.JSONGameObject} A JSON representation of the Game Object.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 683, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Returns a JSON representation of the Game Object.", "kind": "function", "name": "toJSON", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.JSONGameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.JSONGameObject" } }, "description": "A JSON representation of the Game Object." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#toJSON", "scope": "instance", "___id": "T000002R010768", "___s": true }, { "comment": "/**\r\n * Compares the renderMask with the renderFlags to see if this Game Object will render or not.\r\n * Also checks the Game Object against the given Cameras exclusion list.\r\n *\r\n * @method Phaser.GameObjects.GameObject#willRender\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to check against this Game Object.\r\n *\r\n * @return {boolean} True if the Game Object should be rendered, otherwise false.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 696, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Compares the renderMask with the renderFlags to see if this Game Object will render or not.\rAlso 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to check against this Game Object.", "name": "camera" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#willRender", "scope": "instance", "___id": "T000002R010770", "___s": true }, { "comment": "/**\r\n * Checks if this Game Object should round its vertices,\r\n * based on the given Camera and the `vertexRoundMode` of this Game Object.\r\n * This is used by the WebGL Renderer to determine how to round the vertex positions.\r\n *\r\n * You can override this method in your own custom Game Object classes to provide\r\n * custom logic for vertex rounding.\r\n *\r\n * @method Phaser.GameObjects.GameObject#willRoundVertices\r\n * @since 4.0.0\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to check against this Game Object.\r\n * @param {boolean} onlyTranslated - If true, the object is only translated, not scaled or rotated.\r\n * @return {boolean} True if the Game Object should be rounded, otherwise false.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 714, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Checks if this Game Object should round its vertices,\rbased on the given Camera and the `vertexRoundMode` of this Game Object.\rThis is used by the WebGL Renderer to determine how to round the vertex positions.\r\rYou can override this method in your own custom Game Object classes to provide\rcustom logic for vertex rounding.", "kind": "function", "name": "willRoundVertices", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to check against this Game Object.", "name": "camera" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "If true, the object is only translated, not scaled or rotated.", "name": "onlyTranslated" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rounded, otherwise false." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#willRoundVertices", "scope": "instance", "___id": "T000002R010773", "___s": true }, { "comment": "/**\r\n * Sets the vertex round mode of this Game Object.\r\n * This is used by the WebGL Renderer to determine how to round the vertex positions.\r\n * @see {@link Phaser.GameObjects.GameObject#vertexRoundMode} for more details.\r\n *\r\n * @method Phaser.GameObjects.GameObject#setVertexRoundMode\r\n * @since 4.0.0\r\n * @param {string} mode - The vertex round mode to set. Can be 'off', 'safe', 'safeAuto', 'full' or 'fullAuto'.\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 750, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Sets the vertex round mode of this Game Object.\rThis is used by the WebGL Renderer to determine how to round the vertex positions.", "see": [ "{@link Phaser.GameObjects.GameObject#vertexRoundMode} for more details." ], "kind": "function", "name": "setVertexRoundMode", "since": "4.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The vertex round mode to set. Can be 'off', 'safe', 'safeAuto', 'full' or 'fullAuto'.", "name": "mode" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#setVertexRoundMode", "scope": "instance", "___id": "T000002R010775", "___s": true }, { "comment": "/**\r\n * Returns an array containing the display list index of either this Game Object, or if it has one,\r\n * its parent Container. It then iterates up through all of the parent containers until it hits the\r\n * root of the display list (which is index 0 in the returned array).\r\n *\r\n * Used internally by the InputPlugin but also useful if you wish to find out the display depth of\r\n * this Game Object and all of its ancestors.\r\n *\r\n * @method Phaser.GameObjects.GameObject#getIndexList\r\n * @since 3.4.0\r\n *\r\n * @return {number[]} An array of display list position indexes.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 767, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Returns an array containing the display list index of either this Game Object, or if it has one,\rits parent Container. It then iterates up through all of the parent containers until it hits the\rroot of the display list (which is index 0 in the returned array).\r\rUsed internally by the InputPlugin but also useful if you wish to find out the display depth of\rthis Game Object and all of its ancestors.", "kind": "function", "name": "getIndexList", "since": "3.4.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array of display list position indexes." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#getIndexList", "scope": "instance", "___id": "T000002R010778", "___s": true }, { "comment": "/**\r\n * Adds this Game Object to the given Display List.\r\n *\r\n * If no Display List is specified, it will default to the Display List owned by the Scene to which\r\n * this Game Object belongs.\r\n *\r\n * A Game Object can only exist on one Display List at any given time, but may move freely between them.\r\n *\r\n * If this Game Object is already on another Display List when this method is called, it will first\r\n * be removed from it, before being added to the new list.\r\n *\r\n * You can query which list it is on by looking at the `Phaser.GameObjects.GameObject#displayList` property.\r\n *\r\n * If a Game Object isn't on any display list, it will not be rendered. If you just wish to temporarily\r\n * disable it from rendering, consider using the `setVisible` method, instead.\r\n *\r\n * @method Phaser.GameObjects.GameObject#addToDisplayList\r\n * @fires Phaser.Scenes.Events#ADDED_TO_SCENE\r\n * @fires Phaser.GameObjects.Events#ADDED_TO_SCENE\r\n * @since 3.53.0\r\n *\r\n * @param {(Phaser.GameObjects.DisplayList|Phaser.GameObjects.Layer)} [displayList] - The Display List to add to. Defaults to the Scene Display List.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 816, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Adds this Game Object to the given Display List.\r\rIf no Display List is specified, it will default to the Display List owned by the Scene to which\rthis Game Object belongs.\r\rA Game Object can only exist on one Display List at any given time, but may move freely between them.\r\rIf this Game Object is already on another Display List when this method is called, it will first\rbe removed from it, before being added to the new list.\r\rYou can query which list it is on by looking at the `Phaser.GameObjects.GameObject#displayList` property.\r\rIf a Game Object isn't on any display list, it will not be rendered. If you just wish to temporarily\rdisable it from rendering, consider using the `setVisible` method, instead.", "kind": "function", "name": "addToDisplayList", "fires": [ "Phaser.Scenes.Events#event:ADDED_TO_SCENE", "Phaser.GameObjects.Events#event:ADDED_TO_SCENE" ], "since": "3.53.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.DisplayList", "Phaser.GameObjects.Layer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.DisplayList" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Layer" } ] } }, "optional": true, "description": "The Display List to add to. Defaults to the Scene Display List.", "name": "displayList" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#addToDisplayList", "scope": "instance", "___id": "T000002R010785", "___s": true }, { "comment": "/**\r\n * Adds this Game Object to the Update List belonging to the Scene.\r\n *\r\n * When a Game Object is added to the Update List it will have its `preUpdate` method called\r\n * every game frame. This method is passed two parameters: `time` and `delta`.\r\n *\r\n * If you wish to run your own logic within `preUpdate` then you should always call\r\n * `super.preUpdate(time, delta)` within it, or it may fail to process required operations,\r\n * such as Sprite animations.\r\n *\r\n * @method Phaser.GameObjects.GameObject#addToUpdateList\r\n * @since 3.53.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 867, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Adds this Game Object to the Update List belonging to the Scene.\r\rWhen a Game Object is added to the Update List it will have its `preUpdate` method called\revery game frame. This method is passed two parameters: `time` and `delta`.\r\rIf you wish to run your own logic within `preUpdate` then you should always call\r`super.preUpdate(time, delta)` within it, or it may fail to process required operations,\rsuch as Sprite animations.", "kind": "function", "name": "addToUpdateList", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#addToUpdateList", "scope": "instance", "___id": "T000002R010789", "___s": true }, { "comment": "/**\r\n * Removes this Game Object from the Display List it is currently on.\r\n *\r\n * A Game Object can only exist on one Display List at any given time, but may be freely removed\r\n * and added back at a later stage.\r\n *\r\n * You can query which list it is on by looking at the `Phaser.GameObjects.GameObject#displayList` property.\r\n *\r\n * If a Game Object isn't on any Display List, it will not be rendered. If you just wish to temporarily\r\n * disable it from rendering, consider using the `setVisible` method, instead.\r\n *\r\n * @method Phaser.GameObjects.GameObject#removeFromDisplayList\r\n * @fires Phaser.Scenes.Events#REMOVED_FROM_SCENE\r\n * @fires Phaser.GameObjects.Events#REMOVED_FROM_SCENE\r\n * @since 3.53.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 892, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Removes this Game Object from the Display List it is currently on.\r\rA Game Object can only exist on one Display List at any given time, but may be freely removed\rand added back at a later stage.\r\rYou can query which list it is on by looking at the `Phaser.GameObjects.GameObject#displayList` property.\r\rIf a Game Object isn't on any Display List, it will not be rendered. If you just wish to temporarily\rdisable it from rendering, consider using the `setVisible` method, instead.", "kind": "function", "name": "removeFromDisplayList", "fires": [ "Phaser.Scenes.Events#event:REMOVED_FROM_SCENE", "Phaser.GameObjects.Events#event:REMOVED_FROM_SCENE" ], "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#removeFromDisplayList", "scope": "instance", "___id": "T000002R010791", "___s": true }, { "comment": "/**\r\n * Removes this Game Object from the Scene's Update List.\r\n *\r\n * When a Game Object is on the Update List, it will have its `preUpdate` method called\r\n * every game frame. Calling this method will remove it from the list, preventing this.\r\n *\r\n * Removing a Game Object from the Update List will stop most internal functions working.\r\n * For example, removing a Sprite from the Update List will prevent it from being able to\r\n * run animations.\r\n *\r\n * @method Phaser.GameObjects.GameObject#removeFromUpdateList\r\n * @since 3.53.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 930, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Removes this Game Object from the Scene's Update List.\r\rWhen a Game Object is on the Update List, it will have its `preUpdate` method called\revery game frame. Calling this method will remove it from the list, preventing this.\r\rRemoving a Game Object from the Update List will stop most internal functions working.\rFor example, removing a Sprite from the Update List will prevent it from being able to\rrun animations.", "kind": "function", "name": "removeFromUpdateList", "since": "3.53.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#removeFromUpdateList", "scope": "instance", "___id": "T000002R010795", "___s": true }, { "comment": "/**\r\n * Returns a reference to the underlying display list _array_ that contains this Game Object,\r\n * which will be either the Scene's Display List or the internal list belonging\r\n * to its parent Container, if it has one.\r\n * \r\n * If this Game Object is not on a display list or in a container, it will return `null`.\r\n * \r\n * You should be very careful with this method, and understand that it returns a direct reference to the\r\n * internal array used by the Display List. Mutating this array directly can cause all kinds of subtle\r\n * and difficult to debug issues in your game.\r\n *\r\n * @method Phaser.GameObjects.GameObject#getDisplayList\r\n * @since 3.85.0\r\n *\r\n * @return {?Phaser.GameObjects.GameObject[]} The internal Display List array of Game Objects, or `null`.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 955, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Returns a reference to the underlying display list _array_ that contains this Game Object,\rwhich will be either the Scene's Display List or the internal list belonging\rto its parent Container, if it has one.\r\rIf this Game Object is not on a display list or in a container, it will return `null`.\r\rYou should be very careful with this method, and understand that it returns a direct reference to the\rinternal array used by the Display List. Mutating this array directly can cause all kinds of subtle\rand difficult to debug issues in your game.", "kind": "function", "name": "getDisplayList", "since": "3.85.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ], "nullable": true } }, "nullable": true, "description": "The internal Display List array of Game Objects, or `null`." } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#getDisplayList", "scope": "instance", "___id": "T000002R010797", "___s": true }, { "comment": "/**\r\n * Destroys this Game Object removing it from the Display List and Update List and\r\n * severing all ties to parent resources.\r\n *\r\n * Also removes itself from the Input Manager and Physics Manager if previously enabled.\r\n *\r\n * Use this to remove a Game Object from your game if you don't ever plan to use it again.\r\n * As long as no reference to it exists within your own code it should become free for\r\n * garbage collection by the browser.\r\n *\r\n * If you just want to temporarily disable an object then look at using the\r\n * Game Object Pool instead of destroying it, as destroyed objects cannot be resurrected.\r\n *\r\n * @method Phaser.GameObjects.GameObject#destroy\r\n * @fires Phaser.GameObjects.Events#DESTROY\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [fromScene=false] - `True` if this Game Object is being destroyed by the Scene, `false` if not.\r\n */", "meta": { "filename": "GameObject.js", "lineno": 987, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Destroys this Game Object removing it from the Display List and Update List and\rsevering all ties to parent resources.\r\rAlso removes itself from the Input Manager and Physics Manager if previously enabled.\r\rUse this to remove a Game Object from your game if you don't ever plan to use it again.\rAs long as no reference to it exists within your own code it should become free for\rgarbage collection by the browser.\r\rIf you just want to temporarily disable an object then look at using the\rGame 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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "`True` if this Game Object is being destroyed by the Scene, `false` if not.", "name": "fromScene" } ], "memberof": "Phaser.GameObjects.GameObject", "longname": "Phaser.GameObjects.GameObject#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R010802", "___s": true }, { "comment": "/**\r\n * The bitmask that `GameObject.renderFlags` is compared against to determine if the Game Object will render or not.\r\n *\r\n * @constant {number} RENDER_MASK\r\n * @memberof Phaser.GameObjects.GameObject\r\n * @default\r\n */", "meta": { "filename": "GameObject.js", "lineno": 1066, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.GameObjects.GameObject", "scope": "static", "longname": "Phaser.GameObjects.GameObject.RENDER_MASK", "___id": "T000002R010814", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Game Object Creator is a Scene plugin that allows you to quickly create many common\r\n * types of Game Objects and return them using a configuration object, rather than\r\n * having to specify individual parameters as required by the GameObjectFactory.\r\n *\r\n * Game Objects made via this class are automatically added to the Scene and Update List\r\n * unless you explicitly set the `add` property in the configuration object to `false`.\r\n *\r\n * @class GameObjectCreator\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object Creator belongs.\r\n */", "meta": { "filename": "GameObjectCreator.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "classdesc": "The Game Object Creator is a Scene plugin that allows you to quickly create many common\rtypes of Game Objects and return them using a configuration object, rather than\rhaving to specify individual parameters as required by the GameObjectFactory.\r\rGame Objects made via this class are automatically added to the Scene and Update List\runless you explicitly set the `add` property in the configuration object to `false`.", "kind": "class", "name": "GameObjectCreator", "memberof": "Phaser.GameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object Creator belongs.", "name": "scene" } ], "scope": "static", "longname": "Phaser.GameObjects.GameObjectCreator", "___id": "T000002R010820", "___s": true }, { "comment": "/**\r\n * The Scene to which this Game Object Creator belongs.\r\n *\r\n * @name Phaser.GameObjects.GameObjectCreator#scene\r\n * @type {Phaser.Scene}\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObjectCreator.js", "lineno": 33, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The Scene to which this Game Object Creator belongs.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "access": "protected", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#scene", "scope": "instance", "kind": "member", "___id": "T000002R010823", "___s": true }, { "comment": "/**\r\n * A reference to the Scene.Systems.\r\n *\r\n * @name Phaser.GameObjects.GameObjectCreator#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObjectCreator.js", "lineno": 43, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "A reference to the Scene.Systems.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "access": "protected", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#systems", "scope": "instance", "kind": "member", "___id": "T000002R010825", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Event Emitter.\r\n *\r\n * @name Phaser.GameObjects.GameObjectCreator#events\r\n * @type {Phaser.Events.EventEmitter}\r\n * @protected\r\n * @since 3.50.0\r\n */", "meta": { "filename": "GameObjectCreator.js", "lineno": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "A reference to the Scene Event Emitter.", "name": "events", "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "access": "protected", "since": "3.50.0", "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#events", "scope": "instance", "kind": "member", "___id": "T000002R010827", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Display List.\r\n *\r\n * @name Phaser.GameObjects.GameObjectCreator#displayList\r\n * @type {Phaser.GameObjects.DisplayList}\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObjectCreator.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "A reference to the Scene Display List.", "name": "displayList", "type": { "names": [ "Phaser.GameObjects.DisplayList" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.DisplayList" } }, "access": "protected", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#displayList", "scope": "instance", "kind": "member", "___id": "T000002R010829", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Update List.\r\n *\r\n * @name Phaser.GameObjects.GameObjectCreator#updateList\r\n * @type {Phaser.GameObjects.UpdateList}\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObjectCreator.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "A reference to the Scene Update List.", "name": "updateList", "type": { "names": [ "Phaser.GameObjects.UpdateList" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.UpdateList" } }, "access": "protected", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#updateList", "scope": "instance", "kind": "member", "___id": "T000002R010831", "___s": true }, { "comment": "/**\r\n * Registers a Game Object creator function on the GameObjectCreator prototype,\r\n * making it available for creating Game Objects via the Scene's make property.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator.register\r\n * @static\r\n * @since 3.0.0\r\n *\r\n * @param {string} factoryType - The key of the factory that you will use to call the Phaser.Scene.make[ factoryType ] method.\r\n * @param {function} factoryFunction - The constructor function to be called when you invoke the Phaser.Scene.make method.\r\n */", "meta": { "filename": "GameObjectCreator.js", "lineno": 154, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Registers a Game Object creator function on the GameObjectCreator prototype,\rmaking it available for creating Game Objects via the Scene's make property.", "kind": "function", "name": "register", "scope": "static", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the factory that you will use to call the Phaser.Scene.make[ factoryType ] method.", "name": "factoryType" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The constructor function to be called when you invoke the Phaser.Scene.make method.", "name": "factoryFunction" } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator.register", "___id": "T000002R010848", "___s": true }, { "comment": "/**\r\n * Removes a previously registered custom Game Object Creator from the GameObjectCreator prototype,\r\n * making it no longer available via the Scene's make property.\r\n *\r\n * With this method you can remove a custom Game Object Creator that has been previously\r\n * registered in the Game Object Creator. Pass in its `factoryType` in order to remove it.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator.remove\r\n * @static\r\n * @since 3.0.0\r\n *\r\n * @param {string} factoryType - The key of the factory that you want to remove from the GameObjectCreator.\r\n */", "meta": { "filename": "GameObjectCreator.js", "lineno": 173, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Removes a previously registered custom Game Object Creator from the GameObjectCreator prototype,\rmaking it no longer available via the Scene's make property.\r\rWith this method you can remove a custom Game Object Creator that has been previously\rregistered in the Game Object Creator. Pass in its `factoryType` in order to remove it.", "kind": "function", "name": "remove", "scope": "static", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the factory that you want to remove from the GameObjectCreator.", "name": "factoryType" } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator.remove", "___id": "T000002R010851", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Game Object Factory is a Scene plugin that allows you to quickly create many common\r\n * types of Game Objects and have them automatically registered with the Scene.\r\n * It is accessible via `this.add` from within a Scene.\r\n *\r\n * Game Objects directly register themselves with the Factory and inject their own creation\r\n * methods into the class.\r\n *\r\n * @class GameObjectFactory\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object Factory belongs.\r\n */", "meta": { "filename": "GameObjectFactory.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "classdesc": "The Game Object Factory is a Scene plugin that allows you to quickly create many common\rtypes of Game Objects and have them automatically registered with the Scene.\rIt is accessible via `this.add` from within a Scene.\r\rGame Objects directly register themselves with the Factory and inject their own creation\rmethods into the class.", "kind": "class", "name": "GameObjectFactory", "memberof": "Phaser.GameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object Factory belongs.", "name": "scene" } ], "scope": "static", "longname": "Phaser.GameObjects.GameObjectFactory", "___id": "T000002R010857", "___s": true }, { "comment": "/**\r\n * The Scene to which this Game Object Factory belongs.\r\n *\r\n * @name Phaser.GameObjects.GameObjectFactory#scene\r\n * @type {Phaser.Scene}\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObjectFactory.js", "lineno": 33, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The Scene to which this Game Object Factory belongs.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "access": "protected", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#scene", "scope": "instance", "kind": "member", "___id": "T000002R010860", "___s": true }, { "comment": "/**\r\n * A reference to the Scene.Systems.\r\n *\r\n * @name Phaser.GameObjects.GameObjectFactory#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObjectFactory.js", "lineno": 43, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "A reference to the Scene.Systems.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "access": "protected", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#systems", "scope": "instance", "kind": "member", "___id": "T000002R010862", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Event Emitter.\r\n *\r\n * @name Phaser.GameObjects.GameObjectFactory#events\r\n * @type {Phaser.Events.EventEmitter}\r\n * @protected\r\n * @since 3.50.0\r\n */", "meta": { "filename": "GameObjectFactory.js", "lineno": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "A reference to the Scene Event Emitter.", "name": "events", "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "access": "protected", "since": "3.50.0", "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#events", "scope": "instance", "kind": "member", "___id": "T000002R010864", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Display List.\r\n *\r\n * @name Phaser.GameObjects.GameObjectFactory#displayList\r\n * @type {Phaser.GameObjects.DisplayList}\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObjectFactory.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "A reference to the Scene Display List.", "name": "displayList", "type": { "names": [ "Phaser.GameObjects.DisplayList" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.DisplayList" } }, "access": "protected", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#displayList", "scope": "instance", "kind": "member", "___id": "T000002R010866", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Update List.\r\n *\r\n * @name Phaser.GameObjects.GameObjectFactory#updateList\r\n * @type {Phaser.GameObjects.UpdateList}\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GameObjectFactory.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "A reference to the Scene Update List.", "name": "updateList", "type": { "names": [ "Phaser.GameObjects.UpdateList" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.UpdateList" } }, "access": "protected", "since": "3.0.0", "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#updateList", "scope": "instance", "kind": "member", "___id": "T000002R010868", "___s": true }, { "comment": "/**\r\n * Adds an existing Game Object to this Scene.\r\n *\r\n * If the Game Object renders, it will be added to the Display List.\r\n * If it has a `preUpdate` method, it will be added to the Update List.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#existing\r\n * @since 3.0.0\r\n *\r\n * @generic {(Phaser.GameObjects.GameObject|Phaser.GameObjects.Group|Phaser.GameObjects.Layer)} G - [child,$return]\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.Group|Phaser.GameObjects.Layer)} child - The child to be added to this Scene.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that was added.\r\n */", "meta": { "filename": "GameObjectFactory.js", "lineno": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Adds an existing Game Object to this Scene.\r\rIf the Game Object renders, it will be added to the Display List.\rIf it has a `preUpdate` method, it will be added to the Update List.", "kind": "function", "name": "existing", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{(Phaser.GameObjects.GameObject|Phaser.GameObjects.Group|Phaser.GameObjects.Layer)} G - [child,$return]", "value": "{(Phaser.GameObjects.GameObject|Phaser.GameObjects.Group|Phaser.GameObjects.Layer)} G - [child,$return]" } ], "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Group", "Phaser.GameObjects.Layer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Group" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Layer" } ] } }, "description": "The child to be added to this Scene.", "name": "child" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that was added." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#existing", "scope": "instance", "___id": "T000002R010876", "___s": true }, { "comment": "/**\r\n * Registers a Game Object factory function on the GameObjectFactory prototype,\r\n * making it available for creating Game Objects via the Scene's add property.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory.register\r\n * @static\r\n * @since 3.0.0\r\n *\r\n * @param {string} factoryType - The key under which the factory will be registered, accessible as `Phaser.Scene.add[factoryType]`.\r\n * @param {function} factoryFunction - The factory function to be called when `Phaser.Scene.add[factoryType]` is invoked.\r\n */", "meta": { "filename": "GameObjectFactory.js", "lineno": 186, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Registers a Game Object factory function on the GameObjectFactory prototype,\rmaking it available for creating Game Objects via the Scene's add property.", "kind": "function", "name": "register", "scope": "static", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key under which the factory will be registered, accessible as `Phaser.Scene.add[factoryType]`.", "name": "factoryType" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The factory function to be called when `Phaser.Scene.add[factoryType]` is invoked.", "name": "factoryFunction" } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory.register", "___id": "T000002R010887", "___s": true }, { "comment": "/**\r\n * Removes a Game Object factory function from the GameObjectFactory prototype.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory.remove\r\n * @static\r\n * @since 3.0.0\r\n *\r\n * @param {string} factoryType - The key of the factory that you want to remove from the GameObjectFactory.\r\n */", "meta": { "filename": "GameObjectFactory.js", "lineno": 205, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Removes a Game Object factory function from the GameObjectFactory prototype.", "kind": "function", "name": "remove", "scope": "static", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R010890", "___s": true }, { "comment": "/**\r\n * Calculates the Transform Matrix of the given Game Object and Camera, factoring in\r\n * the parent matrix if provided.\r\n *\r\n * Note that the object this result contains _references_ to the Transform Matrices,\r\n * not new instances of them. Therefore, you should use their values immediately, or\r\n * copy them to your own matrix, as they will be replaced as soon as another Game\r\n * Object is rendered.\r\n *\r\n * @function Phaser.GameObjects.GetCalcMatrix\r\n * @memberof Phaser.GameObjects\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} src - The Game Object to calculate the transform matrix for.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera being used to render the Game Object.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentMatrix] - The transform matrix of the parent container, if any.\r\n * @param {boolean} [ignoreCameraPosition=false] - Should the camera's translation be ignored? This is what moves a camera around on the screen, but it should be ignored when the camera is being rendered to a framebuffer.\r\n *\r\n * @return {Phaser.Types.GameObjects.GetCalcMatrixResults} The results object containing the updated transform matrices.\r\n */", "meta": { "filename": "GetCalcMatrix.js", "lineno": 21, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "Calculates the Transform Matrix of the given Game Object and Camera, factoring in\rthe parent matrix if provided.\r\rNote that the object this result contains _references_ to the Transform Matrices,\rnot new instances of them. Therefore, you should use their values immediately, or\rcopy them to your own matrix, as they will be replaced as soon as another Game\rObject is rendered.", "kind": "function", "name": "GetCalcMatrix", "memberof": "Phaser.GameObjects", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to calculate the transform matrix for.", "name": "src" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera being used to render the Game Object.", "name": "camera" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "The transform matrix of the parent container, if any.", "name": "parentMatrix" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the camera's translation be ignored? This is what moves a camera around on the screen, but it should be ignored when the camera is being rendered to a framebuffer.", "name": "ignoreCameraPosition" } ], "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.GetCalcMatrixResults" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.GetCalcMatrixResults" } }, "description": "The results object containing the updated transform matrices." } ], "longname": "Phaser.GameObjects.GetCalcMatrix", "scope": "static", "___id": "T000002R010903", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Gradient Game Object.\r\n *\r\n * This Game Object is a quad which displays a gradient.\r\n * You can manipulate this object like any other, make it interactive,\r\n * and use it in filters and masks to create visually stunning effects.\r\n *\r\n * Behind the scenes, a Gradient is a {@link Phaser.GameObjects.Shader} using a specific shader program.\r\n *\r\n * The gradient color is determined by a {@link Phaser.Display.ColorRamp},\r\n * containing one or more {@link Phaser.Display.ColorBand} objects.\r\n * The ramp is laid out along the `shape` of the gradient,\r\n * originating from the `start` location.\r\n * The `shapeMode` describes how the gradient fills elsewhere,\r\n * e.g. a LINEAR gradient creates straight bands\r\n * while a RADIAL gradient creates circles.\r\n *\r\n * Note that the shape of the gradient is fitted to a square.\r\n * If its width and height are not equal, the shape will be distorted.\r\n * This may be what you want.\r\n *\r\n * A Gradient can be animated by modifying its `offset` property,\r\n * or by modifying the ramp data. If you modify ramp data,\r\n * you may have to call `gradient.ramp.encode()` to rebuild it.\r\n *\r\n * @example\r\n * // Create a linear gradient going left to right.\r\n * scene.add.gradient(undefined, 100, 100, 200, 200);\r\n *\r\n * // Create a glowing halo.\r\n * var halo = scene.add.gradient({\r\n * bands: [\r\n * {\r\n * start: 0.5,\r\n * end: 0.6,\r\n * colorStart: [ 0.5, 0.5, 1, 0 ],\r\n * colorEnd: 0xffffff,\r\n * colorSpace: 1,\r\n * interpolation: 4,\r\n * },\r\n * {\r\n * start: 0.6,\r\n * end: 1,\r\n * colorStart: 0xffffff,\r\n * colorEnd: [ 1, 0.5, 0.5, 0 ],\r\n * colorSpace: 1,\r\n * interpolation: 3,\r\n * },\r\n * ],\r\n * dither: true,\r\n * repeatMode: 1,\r\n * shapeMode: 2,\r\n * start: { x: 0.5, y: 0.5 },\r\n * shape: { x: 0.5, y: 0.0 },\r\n * }, 400, 300, 800, 800);\r\n *\r\n * // Animate the halo, given a `time` value in seconds:\r\n * halo.offset = 0.1 * (1 + Math.sin(time/1000));\r\n *\r\n * @class Gradient\r\n * @extends Phaser.GameObjects.Shader\r\n * @memberof Phaser.GameObjects\r\n * @since 4.0.0\r\n * @constructor\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {Phaser.Types.GameObjects.Gradient.GradientQuadConfig} [config] - The configuration for this Game Object.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "Gradient.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\gradient", "code": {} }, "classdesc": "A Gradient Game Object.\r\rThis Game Object is a quad which displays a gradient.\rYou can manipulate this object like any other, make it interactive,\rand use it in filters and masks to create visually stunning effects.\r\rBehind the scenes, a Gradient is a {@link Phaser.GameObjects.Shader} using a specific shader program.\r\rThe gradient color is determined by a {@link Phaser.Display.ColorRamp},\rcontaining one or more {@link Phaser.Display.ColorBand} objects.\rThe ramp is laid out along the `shape` of the gradient,\roriginating from the `start` location.\rThe `shapeMode` describes how the gradient fills elsewhere,\re.g. a LINEAR gradient creates straight bands\rwhile a RADIAL gradient creates circles.\r\rNote that the shape of the gradient is fitted to a square.\rIf its width and height are not equal, the shape will be distorted.\rThis may be what you want.\r\rA Gradient can be animated by modifying its `offset` property,\ror by modifying the ramp data. If you modify ramp data,\ryou may have to call `gradient.ramp.encode()` to rebuild it.", "examples": [ "// Create a linear gradient going left to right.\rscene.add.gradient(undefined, 100, 100, 200, 200);\r\r// Create a glowing halo.\rvar halo = scene.add.gradient({\r bands: [\r {\r start: 0.5,\r end: 0.6,\r colorStart: [ 0.5, 0.5, 1, 0 ],\r colorEnd: 0xffffff,\r colorSpace: 1,\r interpolation: 4,\r },\r {\r start: 0.6,\r end: 1,\r colorStart: 0xffffff,\r colorEnd: [ 1, 0.5, 0.5, 0 ],\r colorSpace: 1,\r interpolation: 3,\r },\r ],\r dither: true,\r repeatMode: 1,\r shapeMode: 2,\r start: { x: 0.5, y: 0.5 },\r shape: { x: 0.5, y: 0.0 },\r}, 400, 300, 800, 800);\r\r// Animate the halo, given a `time` value in seconds:\rhalo.offset = 0.1 * (1 + Math.sin(time/1000));" ], "kind": "class", "name": "Gradient", "augments": [ "Phaser.GameObjects.Shader" ], "memberof": "Phaser.GameObjects", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.Types.GameObjects.Gradient.GradientQuadConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Gradient.GradientQuadConfig" } }, "optional": true, "description": "The configuration for this Game Object.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "scope": "static", "longname": "Phaser.GameObjects.Gradient", "___id": "T000002R010912", "___s": true }, { "comment": "/**\r\n * The ramp which contains the color data for the gradient.\r\n *\r\n * By default, this is a linear progression from black to white.\r\n * You can encode much more complex gradients with the ColorRamp.\r\n *\r\n * @name Phaser.GameObjects.Gradient#ramp\r\n * @type {Phaser.Display.ColorRamp}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\gradient", "code": {} }, "description": "The ramp which contains the color data for the gradient.\r\rBy default, this is a linear progression from black to white.\rYou can encode much more complex gradients with the ColorRamp.", "name": "ramp", "type": { "names": [ "Phaser.Display.ColorRamp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.ColorRamp" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Gradient", "longname": "Phaser.GameObjects.Gradient#ramp", "scope": "instance", "kind": "member", "___id": "T000002R010930", "___s": true }, { "comment": "/**\r\n * Move the start of the gradient.\r\n * You can animate gradients in this way.\r\n *\r\n * Note that the offset effect changes based on shape and repeat mode.\r\n * Conic gradients may appear weird!\r\n *\r\n * Animate the offset from -1 to 1 using mode 1 (TRUNCATE)\r\n * to create a one-time shockwave.\r\n *\r\n * Use mode 2 (SAWTOOTH) or 3 (TRIANGULAR) to create a moving pattern.\r\n *\r\n * @name Phaser.GameObjects.Gradient#offset\r\n * @type {number}\r\n * @default 0\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\gradient", "code": {} }, "description": "Move the start of the gradient.\rYou can animate gradients in this way.\r\rNote that the offset effect changes based on shape and repeat mode.\rConic gradients may appear weird!\r\rAnimate the offset from -1 to 1 using mode 1 (TRUNCATE)\rto create a one-time shockwave.\r\rUse mode 2 (SAWTOOTH) or 3 (TRIANGULAR) to create a moving pattern.", "name": "offset", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.0.0", "memberof": "Phaser.GameObjects.Gradient", "longname": "Phaser.GameObjects.Gradient#offset", "scope": "instance", "kind": "member", "___id": "T000002R010934", "___s": true }, { "comment": "/**\r\n * The repeat mode of the gradient.\r\n * Gradient progress is evaluated as a number,\r\n * where 0 is the start of the `shape` vector and 1 is the end.\r\n * Repeat mode tells us how to handle that number below 0/above 1.\r\n *\r\n * This can be one of the following:\r\n *\r\n * - 0 (EXTEND): values are clamped between 0 and 1,\r\n * so the ends of the gradient become flat color.\r\n * - 1 (TRUNCATE): values are discarded outside 0-1,\r\n * so the ends of the gradient become transparent.\r\n * - 2 (SAWTOOTH): values are modulo 1,\r\n * so the gradient repeats.\r\n * - 3 (TRIANGULAR): values rise to 1 then fall to 0,\r\n * so the gradient goes smoothly back and forth.\r\n *\r\n * Note that conic gradients never leave the range 0-1\r\n * unless offset is applied. They may look weird if you do.\r\n *\r\n * @name Phaser.GameObjects.Gradient#repeatMode\r\n * @type {number}\r\n * @default 0\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\gradient", "code": {} }, "description": "The repeat mode of the gradient.\rGradient progress is evaluated as a number,\rwhere 0 is the start of the `shape` vector and 1 is the end.\rRepeat mode tells us how to handle that number below 0/above 1.\r\rThis can be one of the following:\r\r- 0 (EXTEND): values are clamped between 0 and 1,\r so the ends of the gradient become flat color.\r- 1 (TRUNCATE): values are discarded outside 0-1,\r so the ends of the gradient become transparent.\r- 2 (SAWTOOTH): values are modulo 1,\r so the gradient repeats.\r- 3 (TRIANGULAR): values rise to 1 then fall to 0,\r so the gradient goes smoothly back and forth.\r\rNote that conic gradients never leave the range 0-1\runless offset is applied. They may look weird if you do.", "name": "repeatMode", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.0.0", "memberof": "Phaser.GameObjects.Gradient", "longname": "Phaser.GameObjects.Gradient#repeatMode", "scope": "instance", "kind": "member", "___id": "T000002R010936", "___s": true }, { "comment": "/**\r\n * The shape mode of the gradient.\r\n * Shapes are based on the `shape` vector.\r\n *\r\n * This can be one of the following:\r\n *\r\n * - 0 (LINEAR): a ribbon where the shape points from one side to the other.\r\n * Commonly used for skies etc.\r\n * - 1 (BILINEAR): like LINEAR, but reflected in both directions.\r\n * Useful for gentle waves, reflections etc.\r\n * - 2 (RADIAL): gradient spreads out from the `start`,\r\n * to the radius described by `shape`.\r\n * Useful for glows, ripples etc.\r\n * - 3 (CONIC_SYMMETRIC): gradient is determined by angle to `shape`,\r\n * going from 0 along the shape vector to 1 opposite it.\r\n * Useful for sharp-looking features or light effects.\r\n * - 4 (CONIC_ASYMMETRIC): gradient is determined by angle to `shape`,\r\n * going from 0 to 1 with a full rotation. This creates a seam.\r\n * Good for creating colors that change with angle,\r\n * like speed meters.\r\n *\r\n * @name Phaser.GameObjects.Gradient#shapeMode\r\n * @type {number}\r\n * @default 0\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 178, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\gradient", "code": {} }, "description": "The shape mode of the gradient.\rShapes are based on the `shape` vector.\r\rThis can be one of the following:\r\r- 0 (LINEAR): a ribbon where the shape points from one side to the other.\r Commonly used for skies etc.\r- 1 (BILINEAR): like LINEAR, but reflected in both directions.\r Useful for gentle waves, reflections etc.\r- 2 (RADIAL): gradient spreads out from the `start`,\r to the radius described by `shape`.\r Useful for glows, ripples etc.\r- 3 (CONIC_SYMMETRIC): gradient is determined by angle to `shape`,\r going from 0 along the shape vector to 1 opposite it.\r Useful for sharp-looking features or light effects.\r- 4 (CONIC_ASYMMETRIC): gradient is determined by angle to `shape`,\r going from 0 to 1 with a full rotation. This creates a seam.\r Good for creating colors that change with angle,\r like speed meters.", "name": "shapeMode", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.0.0", "memberof": "Phaser.GameObjects.Gradient", "longname": "Phaser.GameObjects.Gradient#shapeMode", "scope": "instance", "kind": "member", "___id": "T000002R010938", "___s": true }, { "comment": "/**\r\n * The start location of the gradient within its quad.\r\n * The gradient emanates from this point.\r\n * Gradient color starts here and ends at the tip of the `shape` vector.\r\n *\r\n * @name Phaser.GameObjects.Gradient#start\r\n * @type {Phaser.Types.Math.Vector2Like}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 206, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\gradient", "code": {} }, "description": "The start location of the gradient within its quad.\rThe gradient emanates from this point.\rGradient color starts here and ends at the tip of the `shape` vector.", "name": "start", "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Gradient", "longname": "Phaser.GameObjects.Gradient#start", "scope": "instance", "kind": "member", "___id": "T000002R010940", "___s": true }, { "comment": "/**\r\n * The shape vector of the gradient within its quad.\r\n * This points from the start in the direction that the gradient flows.\r\n * Gradient color starts from the `start` vector and ends at the tip of this.\r\n *\r\n * @name Phaser.GameObjects.Gradient#shape\r\n * @type {Phaser.Types.Math.Vector2Like}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 221, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\gradient", "code": {} }, "description": "The shape vector of the gradient within its quad.\rThis points from the start in the direction that the gradient flows.\rGradient color starts from the `start` vector and ends at the tip of this.", "name": "shape", "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Gradient", "longname": "Phaser.GameObjects.Gradient#shape", "scope": "instance", "kind": "member", "___id": "T000002R010942", "___s": true }, { "comment": "/**\r\n * Whether to dither the gradient.\r\n * This helps to eliminate banding by adding a tiny amount of noise\r\n * to the gradient.\r\n * Dither may lose effectiveness if resized, so you should only enable\r\n * it when it will make a difference.\r\n *\r\n * @name Phaser.GameObjects.Gradient#dither\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default false\r\n */", "meta": { "filename": "Gradient.js", "lineno": 242, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\gradient", "code": {} }, "description": "Whether to dither the gradient.\rThis helps to eliminate banding by adding a tiny amount of noise\rto the gradient.\rDither may lose effectiveness if resized, so you should only enable\rit when it will make a difference.", "name": "dither", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "false", "memberof": "Phaser.GameObjects.Gradient", "longname": "Phaser.GameObjects.Gradient#dither", "scope": "instance", "kind": "member", "___id": "T000002R010946", "___s": true }, { "comment": "/**\r\n * Internal destroy handler, called as part of the destroy process.\r\n *\r\n * @method Phaser.GameObjects.Gradient#preDestroy\r\n * @protected\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Gradient.js", "lineno": 306, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\gradient", "code": {} }, "description": "Internal destroy handler, called as part of the destroy process.", "kind": "function", "name": "preDestroy", "access": "protected", "since": "4.0.0", "memberof": "Phaser.GameObjects.Gradient", "longname": "Phaser.GameObjects.Gradient#preDestroy", "scope": "instance", "overrides": "Phaser.GameObjects.Shader#preDestroy", "___id": "T000002R010956", "___s": true }, { "comment": "/**\r\n * Creates a new Gradient Game Object and returns it. A Gradient is a rectangular\r\n * Game Object that renders a smooth color gradient across its surface using WebGL.\r\n * It is useful for backgrounds, overlays, and decorative visual effects where a\r\n * multi-color fill is needed without a texture. Position, size, and gradient\r\n * appearance are all configured via the `config` object.\r\n *\r\n * Note: This method will only be available if the Gradient Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#gradient\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Gradient.GradientConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Gradient} The Game Object that was created.\r\n */", "meta": { "filename": "GradientCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\gradient", "code": {} }, "description": "Creates a new Gradient Game Object and returns it. A Gradient is a rectangular\rGame Object that renders a smooth color gradient across its surface using WebGL.\rIt is useful for backgrounds, overlays, and decorative visual effects where a\rmulti-color fill is needed without a texture. Position, size, and gradient\rappearance are all configured via the `config` object.\r\rNote: This method will only be available if the Gradient Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "gradient", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Gradient.GradientConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Gradient.GradientConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.Gradient" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Gradient" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#gradient", "scope": "instance", "___id": "T000002R010963", "___s": true }, { "comment": "/**\r\n * Creates a new Gradient Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Gradient Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#gradient\r\n * @webglOnly\r\n * @since 4.0.0\r\n *\r\n * @param {(string|Phaser.Types.GameObjects.Gradient.GradientQuadConfig)} [config] - The configuration object this Gradient will use. This defines the shape and appearance of the gradient texture.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n *\r\n * @return {Phaser.GameObjects.Gradient} The Game Object that was created.\r\n */", "meta": { "filename": "GradientFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\gradient", "code": {} }, "description": "Creates a new Gradient Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Gradient Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "gradient", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.Gradient.GradientQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Gradient.GradientQuadConfig" } ] } }, "optional": true, "description": "The configuration object this Gradient will use. This defines the shape and appearance of the gradient texture.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Gradient" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Gradient" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#gradient", "scope": "instance", "___id": "T000002R010974", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Gradient.GradientConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 4.0.0\r\n *\r\n * @property {string|Phaser.Types.GameObjects.Gradient.GradientQuadConfig} [config] - The configuration object this Gradient will use.\r\n * @property {number} [width=128] - The width of the Game Object.\r\n * @property {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "GradientConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\gradient\\typedefs", "code": {} }, "kind": "typedef", "name": "GradientConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "4.0.0", "properties": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.Gradient.GradientQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Gradient.GradientQuadConfig" } ] } }, "optional": true, "description": "The configuration object this Gradient will use.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "memberof": "Phaser.Types.GameObjects.Gradient", "longname": "Phaser.Types.GameObjects.Gradient.GradientConfig", "scope": "static", "___id": "T000002R010975", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Gradient.GradientQuadConfig\r\n * @since 4.0.0\r\n *\r\n * @property {(Phaser.Types.Display.ColorBandConfig | Phaser.Display.ColorBand | Array.)} [bands={colorStart: 0x000000, colorEnd: 0xffffff}] - Configurations for or instances of ColorBands to use in the gradient. These are used to create a `ColorRamp`.\r\n * @property {number} [offset=0] - The gradient offset. This advances or withdraws the gradient along its shape.\r\n * @property {number} [repeatMode=0] - The repeat mode. Gradient progress is evaluated as a number, where 0 is the start of the `shape` vector and 1 is the end. Note that conic gradients never leave the range 0-1 unless offset is applied. They may look weird if you do. Repeat mode tells us how to handle that number below 0/above 1. This can be one of the following:\r\n * - 0 (EXTEND): values are clamped between 0 and 1, so the ends of the gradient become flat color.\r\n * - 1 (TRUNCATE): values are discarded outside 0-1, so the ends of the gradient become transparent.\r\n * - 2 (SAWTOOTH): values are modulo 1, so the gradient repeats.\r\n * - 3 (TRIANGULAR): values rise to 1 then fall to 0, so the gradient goes smoothly back and forth.\r\n * @property {number} [shapeMode=0] - The shape mode. Shapes are based on the `shape` vector. This can be one of the following:\r\n * - 0 (LINEAR): a ribbon where the shape points from one side to the other.\r\n * Commonly use for skies etc.\r\n * - 1 (BILINEAR): like LINEAR, but reflected in both directions.\r\n * Useful for gentle waves, reflections etc.\r\n * - 2 (RADIAL): gradient spreads out from the `start`,\r\n * to the radius described by `shape`.\r\n * Useful for glows, ripples etc.\r\n * - 3 (CONIC_SYMMETRIC): gradient is determined by angle to `shape`,\r\n * going from 0 along the shape vector to 1 opposite it.\r\n * Useful for sharp-looking features or light effects.\r\n * - 4 (CONIC_ASYMMETRIC): gradient is determined by angle to `shape`,\r\n * going from 0 to 1 with a full rotation. This creates a seam.\r\n * Good for creating colors that change with angle,\r\n * like speed meters.\r\n * @property {Phaser.Types.Math.Vector2Like} [start={x: 0, y: 0}] - The start of the gradient, where 0 is top/left and 1 is bottom/right.\r\n * @property {Phaser.Types.Math.Vector2Like} [shape={x: 1, y: 0}] - The shape of the gradient, as a vector pointing from the start. By default the gradient crosses the width of its object.\r\n * @property {number} [length=1] - The length of the gradient. This is used if `shape` is not defined.\r\n * @property {number} [direction=0] - The direction of the gradient. This is used if `shape` is not defined.\r\n * @property {boolean} [dither] - Whether to dither the gradient. Dither can eliminate banding by introducing noise to the output. This effect can be lost when the Gradient is transformed or scaled, so it's only enabled when you want it.\r\n */", "meta": { "filename": "GradientQuadConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\gradient\\typedefs", "code": {} }, "kind": "typedef", "name": "GradientQuadConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "Phaser.Types.Display.ColorBandConfig", "Phaser.Display.ColorBand", "Array.<(Phaser.Types.Display.ColorBandConfig|Phaser.Display.ColorBand)>" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Display.ColorBandConfig" }, { "type": "NameExpression", "name": "Phaser.Display.ColorBand" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Display.ColorBandConfig" }, { "type": "NameExpression", "name": "Phaser.Display.ColorBand" } ] } ] } ] } }, "optional": true, "defaultvalue": "{colorStart: 0x000000, colorEnd: 0xffffff}", "description": "Configurations for or instances of ColorBands to use in the gradient. These are used to create a `ColorRamp`.", "name": "bands" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The gradient offset. This advances or withdraws the gradient along its shape.", "name": "offset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The repeat mode. Gradient progress is evaluated as a number, where 0 is the start of the `shape` vector and 1 is the end. Note that conic gradients never leave the range 0-1 unless offset is applied. They may look weird if you do. Repeat mode tells us how to handle that number below 0/above 1. This can be one of the following:\r - 0 (EXTEND): values are clamped between 0 and 1, so the ends of the gradient become flat color.\r - 1 (TRUNCATE): values are discarded outside 0-1, so the ends of the gradient become transparent.\r - 2 (SAWTOOTH): values are modulo 1, so the gradient repeats.\r - 3 (TRIANGULAR): values rise to 1 then fall to 0, so the gradient goes smoothly back and forth.", "name": "repeatMode" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The shape mode. Shapes are based on the `shape` vector. This can be one of the following:\r- 0 (LINEAR): a ribbon where the shape points from one side to the other.\r Commonly use for skies etc.\r- 1 (BILINEAR): like LINEAR, but reflected in both directions.\r Useful for gentle waves, reflections etc.\r- 2 (RADIAL): gradient spreads out from the `start`,\r to the radius described by `shape`.\r Useful for glows, ripples etc.\r- 3 (CONIC_SYMMETRIC): gradient is determined by angle to `shape`,\r going from 0 along the shape vector to 1 opposite it.\r Useful for sharp-looking features or light effects.\r- 4 (CONIC_ASYMMETRIC): gradient is determined by angle to `shape`,\r going from 0 to 1 with a full rotation. This creates a seam.\r Good for creating colors that change with angle,\r like speed meters.", "name": "shapeMode" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "defaultvalue": "{x: 0, y: 0}", "description": "The start of the gradient, where 0 is top/left and 1 is bottom/right.", "name": "start" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "defaultvalue": "{x: 1, y: 0}", "description": "The shape of the gradient, as a vector pointing from the start. By default the gradient crosses the width of its object.", "name": "shape" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The length of the gradient. This is used if `shape` is not defined.", "name": "length" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The direction of the gradient. This is used if `shape` is not defined.", "name": "direction" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to dither the gradient. Dither can eliminate banding by introducing noise to the output. This effect can be lost when the Gradient is transformed or scaled, so it's only enabled when you want it.", "name": "dither" } ], "memberof": "Phaser.Types.GameObjects.Gradient", "longname": "Phaser.Types.GameObjects.Gradient.GradientQuadConfig", "scope": "static", "___id": "T000002R010976", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Gradient\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\gradient\\typedefs", "code": {} }, "kind": "namespace", "name": "Gradient", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Gradient", "scope": "static", "___id": "T000002R010977", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Graphics object is a way to draw primitive shapes to your game. Primitives include forms of geometry, such as\r\n * Rectangles, Circles, and Polygons. They also include lines, arcs and curves. When you initially create a Graphics\r\n * object it will be empty.\r\n *\r\n * To draw to it you must first specify a line style or fill style (or both), draw shapes using paths, and finally\r\n * fill or stroke them. For example:\r\n *\r\n * ```javascript\r\n * graphics.lineStyle(5, 0xFF00FF, 1.0);\r\n * graphics.beginPath();\r\n * graphics.moveTo(100, 100);\r\n * graphics.lineTo(200, 200);\r\n * graphics.closePath();\r\n * graphics.strokePath();\r\n * ```\r\n *\r\n * There are also many helpful methods that draw and fill/stroke common shapes for you.\r\n *\r\n * ```javascript\r\n * graphics.lineStyle(5, 0xFF00FF, 1.0);\r\n * graphics.fillStyle(0xFFFFFF, 1.0);\r\n * graphics.fillRect(50, 50, 400, 200);\r\n * graphics.strokeRect(50, 50, 400, 200);\r\n * ```\r\n *\r\n * When a Graphics object is rendered it will render differently based on if the game is running under Canvas or WebGL.\r\n * Under Canvas it will use the HTML Canvas context drawing operations to draw the path.\r\n * Under WebGL the graphics data is decomposed into polygons. Both of these are expensive processes, especially with\r\n * complex shapes.\r\n *\r\n * If your Graphics object doesn't change much (or at all) once you've drawn your shape to it, then you will help\r\n * performance by calling {@link Phaser.GameObjects.Graphics#generateTexture}. This will 'bake' the Graphics object into\r\n * a Texture, and return it. You can then use this Texture for Sprites or other display objects. If your Graphics object\r\n * updates frequently then you should avoid doing this, as it will constantly generate new textures, which will consume\r\n * memory.\r\n *\r\n * Under WebGL, Graphics uses its own shader which will batch drawing operations.\r\n * Try to keep Graphics objects grouped together so they can be batched together.\r\n * Avoid mixing object types where possible, as each batch will be flushed,\r\n * costing performance.\r\n *\r\n * As you can tell, Graphics objects are a bit of a trade-off. While they are extremely useful, you need to be careful\r\n * in their complexity and quantity of them in your game.\r\n *\r\n * @class Graphics\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.GameObjects.Components.AlphaSingle\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Lighting\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Graphics object belongs.\r\n * @param {Phaser.Types.GameObjects.Graphics.Options} [options] - Options that set the position and default style of this Graphics object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "classdesc": "A Graphics object is a way to draw primitive shapes to your game. Primitives include forms of geometry, such as\rRectangles, Circles, and Polygons. They also include lines, arcs and curves. When you initially create a Graphics\robject it will be empty.\r\rTo draw to it you must first specify a line style or fill style (or both), draw shapes using paths, and finally\rfill or stroke them. For example:\r\r```javascript\rgraphics.lineStyle(5, 0xFF00FF, 1.0);\rgraphics.beginPath();\rgraphics.moveTo(100, 100);\rgraphics.lineTo(200, 200);\rgraphics.closePath();\rgraphics.strokePath();\r```\r\rThere are also many helpful methods that draw and fill/stroke common shapes for you.\r\r```javascript\rgraphics.lineStyle(5, 0xFF00FF, 1.0);\rgraphics.fillStyle(0xFFFFFF, 1.0);\rgraphics.fillRect(50, 50, 400, 200);\rgraphics.strokeRect(50, 50, 400, 200);\r```\r\rWhen a Graphics object is rendered it will render differently based on if the game is running under Canvas or WebGL.\rUnder Canvas it will use the HTML Canvas context drawing operations to draw the path.\rUnder WebGL the graphics data is decomposed into polygons. Both of these are expensive processes, especially with\rcomplex shapes.\r\rIf your Graphics object doesn't change much (or at all) once you've drawn your shape to it, then you will help\rperformance by calling {@link Phaser.GameObjects.Graphics#generateTexture}. This will 'bake' the Graphics object into\ra Texture, and return it. You can then use this Texture for Sprites or other display objects. If your Graphics object\rupdates frequently then you should avoid doing this, as it will constantly generate new textures, which will consume\rmemory.\r\rUnder WebGL, Graphics uses its own shader which will batch drawing operations.\rTry to keep Graphics objects grouped together so they can be batched together.\rAvoid mixing object types where possible, as each batch will be flushed,\rcosting performance.\r\rAs you can tell, Graphics objects are a bit of a trade-off. While they are extremely useful, you need to be careful\rin 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.Lighting", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.RenderNodes", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible", "Phaser.GameObjects.Components.ScrollFactor" ], "memberof": "Phaser.GameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Graphics object belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.Types.GameObjects.Graphics.Options" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R011009", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of the Graphics.\r\n *\r\n * @name Phaser.GameObjects.Graphics#displayOriginX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Graphics.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "The horizontal display origin of the Graphics.", "name": "displayOriginX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#displayOriginX", "scope": "instance", "kind": "member", "___id": "T000002R011016", "___s": true }, { "comment": "/**\r\n * The vertical display origin of the Graphics.\r\n *\r\n * @name Phaser.GameObjects.Graphics#displayOriginY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Graphics.js", "lineno": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "The vertical display origin of the Graphics.", "name": "displayOriginY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#displayOriginY", "scope": "instance", "kind": "member", "___id": "T000002R011018", "___s": true }, { "comment": "/**\r\n * The array of commands used to render the Graphics.\r\n *\r\n * @name Phaser.GameObjects.Graphics#commandBuffer\r\n * @type {array}\r\n * @default []\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Graphics.js", "lineno": 133, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "The array of commands used to render the Graphics.", "name": "commandBuffer", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#commandBuffer", "scope": "instance", "kind": "member", "___id": "T000002R011020", "___s": true }, { "comment": "/**\r\n * The default fill color for shapes rendered by this Graphics object.\r\n * Set this value with `setDefaultStyles()`.\r\n *\r\n * @name Phaser.GameObjects.Graphics#defaultFillColor\r\n * @type {number}\r\n * @readonly\r\n * @default -1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Graphics.js", "lineno": 143, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "The default fill color for shapes rendered by this Graphics object.\rSet this value with `setDefaultStyles()`.", "name": "defaultFillColor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#defaultFillColor", "scope": "instance", "kind": "member", "___id": "T000002R011022", "___s": true }, { "comment": "/**\r\n * The default fill alpha for shapes rendered by this Graphics object.\r\n * Set this value with `setDefaultStyles()`.\r\n *\r\n * @name Phaser.GameObjects.Graphics#defaultFillAlpha\r\n * @type {number}\r\n * @readonly\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Graphics.js", "lineno": 155, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "The default fill alpha for shapes rendered by this Graphics object.\rSet this value with `setDefaultStyles()`.", "name": "defaultFillAlpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#defaultFillAlpha", "scope": "instance", "kind": "member", "___id": "T000002R011024", "___s": true }, { "comment": "/**\r\n * The default stroke width for shapes rendered by this Graphics object.\r\n * Set this value with `setDefaultStyles()`.\r\n *\r\n * @name Phaser.GameObjects.Graphics#defaultStrokeWidth\r\n * @type {number}\r\n * @readonly\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Graphics.js", "lineno": 167, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "The default stroke width for shapes rendered by this Graphics object.\rSet this value with `setDefaultStyles()`.", "name": "defaultStrokeWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#defaultStrokeWidth", "scope": "instance", "kind": "member", "___id": "T000002R011026", "___s": true }, { "comment": "/**\r\n * The default stroke color for shapes rendered by this Graphics object.\r\n * Set this value with `setDefaultStyles()`.\r\n *\r\n * @name Phaser.GameObjects.Graphics#defaultStrokeColor\r\n * @type {number}\r\n * @readonly\r\n * @default -1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Graphics.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "The default stroke color for shapes rendered by this Graphics object.\rSet this value with `setDefaultStyles()`.", "name": "defaultStrokeColor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#defaultStrokeColor", "scope": "instance", "kind": "member", "___id": "T000002R011028", "___s": true }, { "comment": "/**\r\n * The default stroke alpha for shapes rendered by this Graphics object.\r\n * Set this value with `setDefaultStyles()`.\r\n *\r\n * @name Phaser.GameObjects.Graphics#defaultStrokeAlpha\r\n * @type {number}\r\n * @readonly\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Graphics.js", "lineno": 191, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "The default stroke alpha for shapes rendered by this Graphics object.\rSet this value with `setDefaultStyles()`.", "name": "defaultStrokeAlpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#defaultStrokeAlpha", "scope": "instance", "kind": "member", "___id": "T000002R011030", "___s": true }, { "comment": "/**\r\n * Path detail threshold for the WebGL renderer, in pixels.\r\n * Path segments will be combined until the path is complete\r\n * or the segment length is above the threshold.\r\n *\r\n * If the value is negative, the threshold will be taken from the\r\n * game config `render.pathDetailThreshold` property.\r\n *\r\n * This threshold can greatly improve performance on complex shapes.\r\n * It is calculated at render time and does not affect the original\r\n * path data.\r\n * The threshold is evaluated in screen pixels, so if the object is\r\n * scaled up, fine detail will emerge.\r\n *\r\n * @name Phaser.GameObjects.Graphics#pathDetailThreshold\r\n * @type {number}\r\n * @default -1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Graphics.js", "lineno": 213, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Path detail threshold for the WebGL renderer, in pixels.\rPath segments will be combined until the path is complete\ror the segment length is above the threshold.\r\rIf the value is negative, the threshold will be taken from the\rgame config `render.pathDetailThreshold` property.\r\rThis threshold can greatly improve performance on complex shapes.\rIt is calculated at render time and does not affect the original\rpath data.\rThe threshold is evaluated in screen pixels, so if the object is\rscaled up, fine detail will emerge.", "name": "pathDetailThreshold", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "4.0.0", "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#pathDetailThreshold", "scope": "instance", "kind": "member", "___id": "T000002R011034", "___s": true }, { "comment": "/**\r\n * Set the default style settings for this Graphics object.\r\n *\r\n * @method Phaser.GameObjects.Graphics#setDefaultStyles\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Graphics.Styles} options - The styles to set as defaults.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Graphics.Styles" } }, "description": "The styles to set as defaults.", "name": "options" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#setDefaultStyles", "scope": "instance", "___id": "T000002R011039", "___s": true }, { "comment": "/**\r\n * Set the current line style. Used for all 'stroke' related functions.\r\n *\r\n * @method Phaser.GameObjects.Graphics#lineStyle\r\n * @since 3.0.0\r\n *\r\n * @param {number} lineWidth - The stroke width.\r\n * @param {number} color - The stroke color.\r\n * @param {number} [alpha=1] - The stroke alpha.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Set the current line style. Used for all 'stroke' related functions.", "kind": "function", "name": "lineStyle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The stroke width.", "name": "lineWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The stroke color.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The stroke alpha.", "name": "alpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#lineStyle", "scope": "instance", "___id": "T000002R011046", "___s": true }, { "comment": "/**\r\n * Set the current fill style. Used for all 'fill' related functions.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillStyle\r\n * @since 3.0.0\r\n *\r\n * @param {number} color - The fill color.\r\n * @param {number} [alpha=1] - The fill alpha.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 315, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Set the current fill style. Used for all 'fill' related functions.", "kind": "function", "name": "fillStyle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The fill color.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The fill alpha.", "name": "alpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillStyle", "scope": "instance", "___id": "T000002R011050", "___s": true }, { "comment": "/**\r\n * Sets a gradient fill style. This is a WebGL only feature.\r\n *\r\n * The gradient color values represent the 4 corners of an untransformed rectangle.\r\n * The gradient is used to color all filled shapes and paths drawn after calling this method.\r\n * If you wish to turn a gradient off, call `fillStyle` and provide a new single fill color.\r\n *\r\n * When filling a triangle only the first 3 color values provided are used for the 3 points of a triangle.\r\n *\r\n * This feature is best used only on rectangles and triangles. All other shapes will give strange results.\r\n *\r\n * Note that for objects such as arcs or ellipses, or anything which is made out of triangles, each triangle used\r\n * will be filled with a gradient on its own. There is no ability to gradient fill a shape or path as a single\r\n * entity at this time.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillGradientStyle\r\n * @webglOnly\r\n * @since 3.12.0\r\n *\r\n * @param {number} topLeft - The top left fill color.\r\n * @param {number} topRight - The top right fill color.\r\n * @param {number} bottomLeft - The bottom left fill color.\r\n * @param {number} bottomRight - The bottom right fill color. Not used when filling triangles.\r\n * @param {number} [alphaTopLeft=1] - The top left alpha value. If you give only this value, it's used for all corners.\r\n * @param {number} [alphaTopRight=1] - The top right alpha value.\r\n * @param {number} [alphaBottomLeft=1] - The bottom left alpha value.\r\n * @param {number} [alphaBottomRight=1] - The bottom right alpha value.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 338, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Sets a gradient fill style. This is a WebGL only feature.\r\rThe gradient color values represent the 4 corners of an untransformed rectangle.\rThe gradient is used to color all filled shapes and paths drawn after calling this method.\rIf you wish to turn a gradient off, call `fillStyle` and provide a new single fill color.\r\rWhen filling a triangle only the first 3 color values provided are used for the 3 points of a triangle.\r\rThis feature is best used only on rectangles and triangles. All other shapes will give strange results.\r\rNote that for objects such as arcs or ellipses, or anything which is made out of triangles, each triangle used\rwill be filled with a gradient on its own. There is no ability to gradient fill a shape or path as a single\rentity at this time.", "kind": "function", "name": "fillGradientStyle", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.12.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top left fill color.", "name": "topLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top right fill color.", "name": "topRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom left fill color.", "name": "bottomLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom right fill color. Not used when filling triangles.", "name": "bottomRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The top left alpha value. If you give only this value, it's used for all corners.", "name": "alphaTopLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The top right alpha value.", "name": "alphaTopRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The bottom left alpha value.", "name": "alphaBottomLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The bottom right alpha value.", "name": "alphaBottomRight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillGradientStyle", "scope": "instance", "___id": "T000002R011053", "___s": true }, { "comment": "/**\r\n * Sets a gradient line style. This is a WebGL only feature.\r\n *\r\n * The gradient color values represent the 4 corners of an untransformed rectangle.\r\n * The gradient is used to color all stroked shapes and paths drawn after calling this method.\r\n * If you wish to turn a gradient off, call `lineStyle` and provide a new single line color.\r\n *\r\n * This feature is best used only on single lines. All other shapes will give strange results.\r\n *\r\n * Note that for objects such as arcs or ellipses, or anything which is made out of triangles, each triangle used\r\n * will be filled with a gradient on its own. There is no ability to gradient stroke a shape or path as a single\r\n * entity at this time.\r\n *\r\n * @method Phaser.GameObjects.Graphics#lineGradientStyle\r\n * @webglOnly\r\n * @since 3.12.0\r\n *\r\n * @param {number} lineWidth - The stroke width.\r\n * @param {number} topLeft - The stroke color for the top-left of the gradient.\r\n * @param {number} topRight - The stroke color for the top-right of the gradient.\r\n * @param {number} bottomLeft - The stroke color for the bottom-left of the gradient.\r\n * @param {number} bottomRight - The stroke color for the bottom-right of the gradient.\r\n * @param {number} [alpha=1] - The fill alpha.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 384, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Sets a gradient line style. This is a WebGL only feature.\r\rThe gradient color values represent the 4 corners of an untransformed rectangle.\rThe gradient is used to color all stroked shapes and paths drawn after calling this method.\rIf you wish to turn a gradient off, call `lineStyle` and provide a new single line color.\r\rThis feature is best used only on single lines. All other shapes will give strange results.\r\rNote that for objects such as arcs or ellipses, or anything which is made out of triangles, each triangle used\rwill be filled with a gradient on its own. There is no ability to gradient stroke a shape or path as a single\rentity at this time.", "kind": "function", "name": "lineGradientStyle", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.12.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The stroke width.", "name": "lineWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The stroke color for the top-left of the gradient.", "name": "topLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The stroke color for the top-right of the gradient.", "name": "topRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The stroke color for the bottom-left of the gradient.", "name": "bottomLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The stroke color for the bottom-right of the gradient.", "name": "bottomRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The fill alpha.", "name": "alpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#lineGradientStyle", "scope": "instance", "___id": "T000002R011059", "___s": true }, { "comment": "/**\r\n * Start a new shape path.\r\n *\r\n * @method Phaser.GameObjects.Graphics#beginPath\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 422, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Start a new shape path.", "kind": "function", "name": "beginPath", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#beginPath", "scope": "instance", "___id": "T000002R011062", "___s": true }, { "comment": "/**\r\n * Close the current path.\r\n *\r\n * @method Phaser.GameObjects.Graphics#closePath\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 439, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Close the current path.", "kind": "function", "name": "closePath", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#closePath", "scope": "instance", "___id": "T000002R011064", "___s": true }, { "comment": "/**\r\n * Fill the current path.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillPath\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Fill the current path.", "kind": "function", "name": "fillPath", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillPath", "scope": "instance", "___id": "T000002R011066", "___s": true }, { "comment": "/**\r\n * Fill the current path.\r\n *\r\n * This is an alias for `Graphics.fillPath` and does the same thing.\r\n * It was added to match the CanvasRenderingContext 2D API.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fill\r\n * @since 3.16.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 473, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Fill the current path.\r\rThis is an alias for `Graphics.fillPath` and does the same thing.\rIt was added to match the CanvasRenderingContext 2D API.", "kind": "function", "name": "fill", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fill", "scope": "instance", "___id": "T000002R011068", "___s": true }, { "comment": "/**\r\n * Stroke the current path.\r\n *\r\n * @method Phaser.GameObjects.Graphics#strokePath\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 493, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Stroke the current path.", "kind": "function", "name": "strokePath", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#strokePath", "scope": "instance", "___id": "T000002R011070", "___s": true }, { "comment": "/**\r\n * Stroke the current path.\r\n *\r\n * This is an alias for `Graphics.strokePath` and does the same thing.\r\n * It was added to match the CanvasRenderingContext 2D API.\r\n *\r\n * @method Phaser.GameObjects.Graphics#stroke\r\n * @since 3.16.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 510, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Stroke the current path.\r\rThis is an alias for `Graphics.strokePath` and does the same thing.\rIt was added to match the CanvasRenderingContext 2D API.", "kind": "function", "name": "stroke", "since": "3.16.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#stroke", "scope": "instance", "___id": "T000002R011072", "___s": true }, { "comment": "/**\r\n * Fill the given circle.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillCircleShape\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The circle to fill.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 530, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Fill the given circle.", "kind": "function", "name": "fillCircleShape", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The circle to fill.", "name": "circle" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillCircleShape", "scope": "instance", "___id": "T000002R011074", "___s": true }, { "comment": "/**\r\n * Stroke the given circle.\r\n *\r\n * @method Phaser.GameObjects.Graphics#strokeCircleShape\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The circle to stroke.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 545, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Stroke the given circle.", "kind": "function", "name": "strokeCircleShape", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The circle to stroke.", "name": "circle" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#strokeCircleShape", "scope": "instance", "___id": "T000002R011076", "___s": true }, { "comment": "/**\r\n * Fill a circle with the given position and radius.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillCircle\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate of the center of the circle.\r\n * @param {number} y - The y coordinate of the center of the circle.\r\n * @param {number} radius - The radius of the circle.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 560, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Fill a circle with the given position and radius.", "kind": "function", "name": "fillCircle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the center of the circle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the center of the circle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the circle.", "name": "radius" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillCircle", "scope": "instance", "___id": "T000002R011078", "___s": true }, { "comment": "/**\r\n * Stroke a circle with the given position and radius.\r\n *\r\n * @method Phaser.GameObjects.Graphics#strokeCircle\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate of the center of the circle.\r\n * @param {number} y - The y coordinate of the center of the circle.\r\n * @param {number} radius - The radius of the circle.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 581, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Stroke a circle with the given position and radius.", "kind": "function", "name": "strokeCircle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the center of the circle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the center of the circle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the circle.", "name": "radius" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#strokeCircle", "scope": "instance", "___id": "T000002R011080", "___s": true }, { "comment": "/**\r\n * Fill the given rectangle.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillRectShape\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The rectangle to fill.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 602, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Fill the given rectangle.", "kind": "function", "name": "fillRectShape", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The rectangle to fill.", "name": "rect" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillRectShape", "scope": "instance", "___id": "T000002R011082", "___s": true }, { "comment": "/**\r\n * Stroke the given rectangle.\r\n *\r\n * @method Phaser.GameObjects.Graphics#strokeRectShape\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The rectangle to stroke.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 617, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Stroke the given rectangle.", "kind": "function", "name": "strokeRectShape", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The rectangle to stroke.", "name": "rect" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#strokeRectShape", "scope": "instance", "___id": "T000002R011084", "___s": true }, { "comment": "/**\r\n * Fill a rectangle with the given position and size.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillRect\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate of the top-left of the rectangle.\r\n * @param {number} y - The y coordinate of the top-left of the rectangle.\r\n * @param {number} width - The width of the rectangle.\r\n * @param {number} height - The height of the rectangle.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 632, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Fill a rectangle with the given position and size.", "kind": "function", "name": "fillRect", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the top-left of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the top-left of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the rectangle.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillRect", "scope": "instance", "___id": "T000002R011086", "___s": true }, { "comment": "/**\r\n * Stroke a rectangle with the given position and size.\r\n *\r\n * @method Phaser.GameObjects.Graphics#strokeRect\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate of the top-left of the rectangle.\r\n * @param {number} y - The y coordinate of the top-left of the rectangle.\r\n * @param {number} width - The width of the rectangle.\r\n * @param {number} height - The height of the rectangle.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 655, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Stroke a rectangle with the given position and size.", "kind": "function", "name": "strokeRect", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the top-left of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the top-left of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the rectangle.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#strokeRect", "scope": "instance", "___id": "T000002R011088", "___s": true }, { "comment": "/**\r\n * Fill a rounded rectangle with the given position, size and radius.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillRoundedRect\r\n * @since 3.11.0\r\n *\r\n * @param {number} x - The x coordinate of the top-left of the rectangle.\r\n * @param {number} y - The y coordinate of the top-left of the rectangle.\r\n * @param {number} width - The width of the rectangle.\r\n * @param {number} height - The height of the rectangle.\r\n * @param {(Phaser.Types.GameObjects.Graphics.RoundedRectRadius|number)} [radius=20] - The corner radius; It can also be an object to specify different radius for corners.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 697, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Fill a rounded rectangle with the given position, size and radius.", "kind": "function", "name": "fillRoundedRect", "since": "3.11.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the top-left of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the top-left of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the rectangle.", "name": "height" }, { "type": { "names": [ "Phaser.Types.GameObjects.Graphics.RoundedRectRadius", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Graphics.RoundedRectRadius" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": 20, "description": "The corner radius; It can also be an object to specify different radius for corners.", "name": "radius" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillRoundedRect", "scope": "instance", "___id": "T000002R011093", "___s": true }, { "comment": "/**\r\n * Stroke a rounded rectangle with the given position, size and radius.\r\n *\r\n * @method Phaser.GameObjects.Graphics#strokeRoundedRect\r\n * @since 3.11.0\r\n *\r\n * @param {number} x - The x coordinate of the top-left of the rectangle.\r\n * @param {number} y - The y coordinate of the top-left of the rectangle.\r\n * @param {number} width - The width of the rectangle.\r\n * @param {number} height - The height of the rectangle.\r\n * @param {(Phaser.Types.GameObjects.Graphics.RoundedRectRadius|number)} [radius=20] - The corner radius; It can also be an object to specify different radii for corners.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 789, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Stroke a rounded rectangle with the given position, size and radius.", "kind": "function", "name": "strokeRoundedRect", "since": "3.11.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the top-left of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the top-left of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the rectangle.", "name": "height" }, { "type": { "names": [ "Phaser.Types.GameObjects.Graphics.RoundedRectRadius", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Graphics.RoundedRectRadius" }, { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#strokeRoundedRect", "scope": "instance", "___id": "T000002R011112", "___s": true }, { "comment": "/**\r\n * Fill the given point.\r\n *\r\n * Draws a square at the given position, 1 pixel in size by default.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillPointShape\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector2} point - The point to fill.\r\n * @param {number} [size=1] - The size of the square to draw.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 887, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Fill the given point.\r\rDraws a square at the given position, 1 pixel in size by default.", "kind": "function", "name": "fillPointShape", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point to fill.", "name": "point" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The size of the square to draw.", "name": "size" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillPointShape", "scope": "instance", "___id": "T000002R011132", "___s": true }, { "comment": "/**\r\n * Fill a point at the given position.\r\n *\r\n * Draws a square at the given position, 1 pixel in size by default.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillPoint\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate of the point.\r\n * @param {number} y - The y coordinate of the point.\r\n * @param {number} [size=1] - The size of the square to draw.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 905, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Fill a point at the given position.\r\rDraws a square at the given position, 1 pixel in size by default.", "kind": "function", "name": "fillPoint", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the point.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the point.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The size of the square to draw.", "name": "size" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillPoint", "scope": "instance", "___id": "T000002R011134", "___s": true }, { "comment": "/**\r\n * Fill the given triangle.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillTriangleShape\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The triangle to fill.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 939, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Fill the given triangle.", "kind": "function", "name": "fillTriangleShape", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The triangle to fill.", "name": "triangle" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillTriangleShape", "scope": "instance", "___id": "T000002R011139", "___s": true }, { "comment": "/**\r\n * Stroke the given triangle.\r\n *\r\n * @method Phaser.GameObjects.Graphics#strokeTriangleShape\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The triangle to stroke.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 954, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Stroke the given triangle.", "kind": "function", "name": "strokeTriangleShape", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The triangle to stroke.", "name": "triangle" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#strokeTriangleShape", "scope": "instance", "___id": "T000002R011141", "___s": true }, { "comment": "/**\r\n * Fill a triangle with the given points.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillTriangle\r\n * @since 3.0.0\r\n *\r\n * @param {number} x0 - The x coordinate of the first point.\r\n * @param {number} y0 - The y coordinate of the first point.\r\n * @param {number} x1 - The x coordinate of the second point.\r\n * @param {number} y1 - The y coordinate of the second point.\r\n * @param {number} x2 - The x coordinate of the third point.\r\n * @param {number} y2 - The y coordinate of the third point.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 969, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Fill a triangle with the given points.", "kind": "function", "name": "fillTriangle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the first point.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the first point.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the second point.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the second point.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the third point.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the third point.", "name": "y2" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillTriangle", "scope": "instance", "___id": "T000002R011143", "___s": true }, { "comment": "/**\r\n * Stroke a triangle with the given points.\r\n *\r\n * @method Phaser.GameObjects.Graphics#strokeTriangle\r\n * @since 3.0.0\r\n *\r\n * @param {number} x0 - The x coordinate of the first point.\r\n * @param {number} y0 - The y coordinate of the first point.\r\n * @param {number} x1 - The x coordinate of the second point.\r\n * @param {number} y1 - The y coordinate of the second point.\r\n * @param {number} x2 - The x coordinate of the third point.\r\n * @param {number} y2 - The y coordinate of the third point.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 994, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Stroke a triangle with the given points.", "kind": "function", "name": "strokeTriangle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the first point.", "name": "x0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the first point.", "name": "y0" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the second point.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the second point.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the third point.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the third point.", "name": "y2" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#strokeTriangle", "scope": "instance", "___id": "T000002R011145", "___s": true }, { "comment": "/**\r\n * Draw the given line.\r\n *\r\n * @method Phaser.GameObjects.Graphics#strokeLineShape\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to stroke.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1019, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Draw the given line.", "kind": "function", "name": "strokeLineShape", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to stroke.", "name": "line" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#strokeLineShape", "scope": "instance", "___id": "T000002R011147", "___s": true }, { "comment": "/**\r\n * Draw a line between the given points.\r\n *\r\n * @method Phaser.GameObjects.Graphics#lineBetween\r\n * @since 3.0.0\r\n *\r\n * @param {number} x1 - The x coordinate of the start point of the line.\r\n * @param {number} y1 - The y coordinate of the start point of the line.\r\n * @param {number} x2 - The x coordinate of the end point of the line.\r\n * @param {number} y2 - The y coordinate of the end point of the line.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1034, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Draw a line between the given points.", "kind": "function", "name": "lineBetween", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the start point of the line.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the start point of the line.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the end point of the line.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the end point of the line.", "name": "y2" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#lineBetween", "scope": "instance", "___id": "T000002R011149", "___s": true }, { "comment": "/**\r\n * Draw a line from the current drawing position to the given position.\r\n *\r\n * Moves the current drawing position to the given position.\r\n *\r\n * @method Phaser.GameObjects.Graphics#lineTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate to draw the line to.\r\n * @param {number} y - The y coordinate to draw the line to.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1057, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Draw a line from the current drawing position to the given position.\r\rMoves the current drawing position to the given position.", "kind": "function", "name": "lineTo", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to draw the line to.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to draw the line to.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#lineTo", "scope": "instance", "___id": "T000002R011151", "___s": true }, { "comment": "/**\r\n * Move the current drawing position to the given position.\r\n *\r\n * @method Phaser.GameObjects.Graphics#moveTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate to move to.\r\n * @param {number} y - The y coordinate to move to.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1080, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Move the current drawing position to the given position.", "kind": "function", "name": "moveTo", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to move to.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to move to.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#moveTo", "scope": "instance", "___id": "T000002R011153", "___s": true }, { "comment": "/**\r\n * Stroke the shape represented by the given array of points.\r\n *\r\n * Pass `closeShape` to automatically close the shape by joining the last to the first point.\r\n *\r\n * Pass `closePath` to automatically close the path before it is stroked.\r\n *\r\n * @method Phaser.GameObjects.Graphics#strokePoints\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector2[]} points - The points to stroke.\r\n * @param {boolean} [closeShape=false] - When `true`, the shape is closed by joining the last point to the first point.\r\n * @param {boolean} [closePath=false] - When `true`, the path is closed before being stroked.\r\n * @param {number} [endIndex] - The index of `points` to stop drawing at. Defaults to `points.length`.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1101, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Stroke the shape represented by the given array of points.\r\rPass `closeShape` to automatically close the shape by joining the last to the first point.\r\rPass `closePath` to automatically close the path before it is stroked.", "kind": "function", "name": "strokePoints", "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "The points to stroke.", "name": "points" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "When `true`, the path is closed before being stroked.", "name": "closePath" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The index of `points` to stop drawing at. Defaults to `points.length`.", "name": "endIndex" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#strokePoints", "scope": "instance", "___id": "T000002R011155", "___s": true }, { "comment": "/**\r\n * Fill the shape represented by the given array of points.\r\n *\r\n * Pass `closeShape` to automatically close the shape by joining the last to the first point.\r\n *\r\n * Pass `closePath` to automatically close the path before it is filled.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillPoints\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector2[]} points - The points to fill.\r\n * @param {boolean} [closeShape=false] - When `true`, the shape is closed by joining the last point to the first point.\r\n * @param {boolean} [closePath=false] - When `true`, the path is closed before being filled.\r\n * @param {number} [endIndex] - The index of `points` to stop at. Defaults to `points.length`.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1148, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Fill the shape represented by the given array of points.\r\rPass `closeShape` to automatically close the shape by joining the last to the first point.\r\rPass `closePath` to automatically close the path before it is filled.", "kind": "function", "name": "fillPoints", "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "The points to fill.", "name": "points" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "When `true`, the path is closed before being filled.", "name": "closePath" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The index of `points` to stop at. Defaults to `points.length`.", "name": "endIndex" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillPoints", "scope": "instance", "___id": "T000002R011161", "___s": true }, { "comment": "/**\r\n * Stroke the given ellipse.\r\n *\r\n * @method Phaser.GameObjects.Graphics#strokeEllipseShape\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The ellipse to stroke.\r\n * @param {number} [smoothness=32] - The number of points to draw the ellipse with.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1195, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Stroke the given ellipse.", "kind": "function", "name": "strokeEllipseShape", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The ellipse to stroke.", "name": "ellipse" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The number of points to draw the ellipse with.", "name": "smoothness" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#strokeEllipseShape", "scope": "instance", "___id": "T000002R011167", "___s": true }, { "comment": "/**\r\n * Stroke an ellipse with the given position and size.\r\n *\r\n * @method Phaser.GameObjects.Graphics#strokeEllipse\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate of the center of the ellipse.\r\n * @param {number} y - The y coordinate of the center of the ellipse.\r\n * @param {number} width - The width of the ellipse.\r\n * @param {number} height - The height of the ellipse.\r\n * @param {number} [smoothness=32] - The number of points to draw the ellipse with.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1215, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Stroke an ellipse with the given position and size.", "kind": "function", "name": "strokeEllipse", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the center of the ellipse.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the center of the ellipse.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the ellipse.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the ellipse.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The number of points to draw the ellipse with.", "name": "smoothness" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#strokeEllipse", "scope": "instance", "___id": "T000002R011171", "___s": true }, { "comment": "/**\r\n * Fill the given ellipse.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillEllipseShape\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The ellipse to fill.\r\n * @param {number} [smoothness=32] - The number of points to draw the ellipse with.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1240, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Fill the given ellipse.", "kind": "function", "name": "fillEllipseShape", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The ellipse to fill.", "name": "ellipse" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The number of points to draw the ellipse with.", "name": "smoothness" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillEllipseShape", "scope": "instance", "___id": "T000002R011176", "___s": true }, { "comment": "/**\r\n * Fill an ellipse with the given position and size.\r\n *\r\n * @method Phaser.GameObjects.Graphics#fillEllipse\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate of the center of the ellipse.\r\n * @param {number} y - The y coordinate of the center of the ellipse.\r\n * @param {number} width - The width of the ellipse.\r\n * @param {number} height - The height of the ellipse.\r\n * @param {number} [smoothness=32] - The number of points to draw the ellipse with.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1260, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Fill an ellipse with the given position and size.", "kind": "function", "name": "fillEllipse", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the center of the ellipse.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the center of the ellipse.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the ellipse.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the ellipse.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The number of points to draw the ellipse with.", "name": "smoothness" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#fillEllipse", "scope": "instance", "___id": "T000002R011180", "___s": true }, { "comment": "/**\r\n * Draw an arc.\r\n *\r\n * This method can be used to create circles, or parts of circles.\r\n *\r\n * Make sure you call `beginPath` before starting the arc unless you wish for the arc to automatically\r\n * close when filled or stroked.\r\n *\r\n * Use the optional `overshoot` argument increase the number of iterations that take place when\r\n * the arc is rendered in WebGL. This is useful if you're drawing an arc with an especially thick line,\r\n * as it will allow the arc to fully join-up. Try small values at first, i.e. 0.01.\r\n *\r\n * Call {@link Phaser.GameObjects.Graphics#fillPath} or {@link Phaser.GameObjects.Graphics#strokePath} after calling\r\n * this method to draw the arc.\r\n *\r\n * @method Phaser.GameObjects.Graphics#arc\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate of the center of the circle.\r\n * @param {number} y - The y coordinate of the center of the circle.\r\n * @param {number} radius - The radius of the circle.\r\n * @param {number} startAngle - The starting angle, in radians.\r\n * @param {number} endAngle - The ending angle, in radians.\r\n * @param {boolean} [anticlockwise=false] - Whether the drawing should be anticlockwise or clockwise.\r\n * @param {number} [overshoot=0] - 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.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Draw an arc.\r\rThis method can be used to create circles, or parts of circles.\r\rMake sure you call `beginPath` before starting the arc unless you wish for the arc to automatically\rclose when filled or stroked.\r\rUse the optional `overshoot` argument increase the number of iterations that take place when\rthe arc is rendered in WebGL. This is useful if you're drawing an arc with an especially thick line,\ras it will allow the arc to fully join-up. Try small values at first, i.e. 0.01.\r\rCall {@link Phaser.GameObjects.Graphics#fillPath} or {@link Phaser.GameObjects.Graphics#strokePath} after calling\rthis method to draw the arc.", "kind": "function", "name": "arc", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the center of the circle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the center of the circle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the circle.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The starting angle, in radians.", "name": "startAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The ending angle, in radians.", "name": "endAngle" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether the drawing should be anticlockwise or clockwise.", "name": "anticlockwise" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#arc", "scope": "instance", "___id": "T000002R011185", "___s": true }, { "comment": "/**\r\n * Creates a pie-chart slice shape centered at `x`, `y` with the given radius.\r\n * You must define the start and end angle of the slice.\r\n *\r\n * Setting the `anticlockwise` argument to `true` creates a shape similar to Pacman.\r\n * Setting it to `false` creates a shape like a slice of pie.\r\n *\r\n * This method will begin a new path and close the path at the end of it.\r\n * To display the actual slice you need to call either `strokePath` or `fillPath` after it.\r\n *\r\n * @method Phaser.GameObjects.Graphics#slice\r\n * @since 3.4.0\r\n *\r\n * @param {number} x - The horizontal center of the slice.\r\n * @param {number} y - The vertical center of the slice.\r\n * @param {number} radius - The radius of the slice.\r\n * @param {number} startAngle - The start angle of the slice, given in radians.\r\n * @param {number} endAngle - The end angle of the slice, given in radians.\r\n * @param {boolean} [anticlockwise=false] - Whether the drawing should be anticlockwise or clockwise.\r\n * @param {number} [overshoot=0] - 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.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Creates a pie-chart slice shape centered at `x`, `y` with the given radius.\rYou must define the start and end angle of the slice.\r\rSetting the `anticlockwise` argument to `true` creates a shape similar to Pacman.\rSetting it to `false` creates a shape like a slice of pie.\r\rThis method will begin a new path and close the path at the end of it.\rTo 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal center of the slice.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical center of the slice.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the slice.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The start angle of the slice, given in radians.", "name": "startAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The end angle of the slice, given in radians.", "name": "endAngle" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether the drawing should be anticlockwise or clockwise.", "name": "anticlockwise" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#slice", "scope": "instance", "___id": "T000002R011189", "___s": true }, { "comment": "/**\r\n * Saves the state of the Graphics by pushing the current state onto a stack.\r\n *\r\n * The most recently saved state can then be restored with {@link Phaser.GameObjects.Graphics#restore}.\r\n *\r\n * @method Phaser.GameObjects.Graphics#save\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1365, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Saves the state of the Graphics by pushing the current state onto a stack.\r\rThe 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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#save", "scope": "instance", "___id": "T000002R011193", "___s": true }, { "comment": "/**\r\n * Restores the most recently saved state of the Graphics by popping from the state stack.\r\n *\r\n * Use {@link Phaser.GameObjects.Graphics#save} to save the current state, and call this afterwards to restore that state.\r\n *\r\n * If there is no saved state, this command does nothing.\r\n *\r\n * @method Phaser.GameObjects.Graphics#restore\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1384, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Restores the most recently saved state of the Graphics by popping from the state stack.\r\rUse {@link Phaser.GameObjects.Graphics#save} to save the current state, and call this afterwards to restore that state.\r\rIf there is no saved state, this command does nothing.", "kind": "function", "name": "restore", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#restore", "scope": "instance", "___id": "T000002R011195", "___s": true }, { "comment": "/**\r\n * Inserts a translation command into this Graphics objects command buffer.\r\n *\r\n * All objects drawn _after_ calling this method will be translated\r\n * by the given amount.\r\n *\r\n * This does not change the position of the Graphics object itself,\r\n * only of the objects drawn by it after calling this method.\r\n *\r\n * @method Phaser.GameObjects.Graphics#translateCanvas\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal translation to apply.\r\n * @param {number} y - The vertical translation to apply.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1405, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Inserts a translation command into this Graphics objects command buffer.\r\rAll objects drawn _after_ calling this method will be translated\rby the given amount.\r\rThis does not change the position of the Graphics object itself,\ronly of the objects drawn by it after calling this method.", "kind": "function", "name": "translateCanvas", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal translation to apply.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical translation to apply.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#translateCanvas", "scope": "instance", "___id": "T000002R011197", "___s": true }, { "comment": "/**\r\n * Inserts a scale command into this Graphics objects command buffer.\r\n *\r\n * All objects drawn _after_ calling this method will be scaled\r\n * by the given amount.\r\n *\r\n * This does not change the scale of the Graphics object itself,\r\n * only of the objects drawn by it after calling this method.\r\n *\r\n * @method Phaser.GameObjects.Graphics#scaleCanvas\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal scale to apply.\r\n * @param {number} y - The vertical scale to apply.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1432, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Inserts a scale command into this Graphics objects command buffer.\r\rAll objects drawn _after_ calling this method will be scaled\rby the given amount.\r\rThis does not change the scale of the Graphics object itself,\ronly of the objects drawn by it after calling this method.", "kind": "function", "name": "scaleCanvas", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal scale to apply.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical scale to apply.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#scaleCanvas", "scope": "instance", "___id": "T000002R011199", "___s": true }, { "comment": "/**\r\n * Inserts a rotation command into this Graphics objects command buffer.\r\n *\r\n * All objects drawn _after_ calling this method will be rotated\r\n * by the given amount.\r\n *\r\n * This does not change the rotation of the Graphics object itself,\r\n * only of the objects drawn by it after calling this method.\r\n *\r\n * @method Phaser.GameObjects.Graphics#rotateCanvas\r\n * @since 3.0.0\r\n *\r\n * @param {number} radians - The rotation angle, in radians.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1459, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Inserts a rotation command into this Graphics objects command buffer.\r\rAll objects drawn _after_ calling this method will be rotated\rby the given amount.\r\rThis does not change the rotation of the Graphics object itself,\ronly of the objects drawn by it after calling this method.", "kind": "function", "name": "rotateCanvas", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rotation angle, in radians.", "name": "radians" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#rotateCanvas", "scope": "instance", "___id": "T000002R011201", "___s": true }, { "comment": "/**\r\n * Clear the command buffer and reset the fill style and line style to their defaults.\r\n *\r\n * @method Phaser.GameObjects.Graphics#clear\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1485, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#clear", "scope": "instance", "___id": "T000002R011203", "___s": true }, { "comment": "/**\r\n * Generate a texture from this Graphics object.\r\n *\r\n * If `key` is a string it'll generate a new texture using it and add it into the\r\n * Texture Manager (assuming no key conflict happens).\r\n *\r\n * If `key` is a Canvas it will draw the Graphics to that canvas context. Note that it will NOT\r\n * automatically upload it to the GPU in WebGL mode.\r\n *\r\n * Please understand that the texture is created via the Canvas API of the browser, therefore some\r\n * Graphics features, such as `fillGradientStyle`, will not appear on the resulting texture,\r\n * as they're unsupported by the Canvas API.\r\n *\r\n * @method Phaser.GameObjects.Graphics#generateTexture\r\n * @since 3.0.0\r\n *\r\n * @param {(string|HTMLCanvasElement)} key - The key to store the texture with in the Texture Manager, or a Canvas to draw to.\r\n * @param {number} [width] - The width of the graphics to generate.\r\n * @param {number} [height] - The height of the graphics to generate.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1510, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Generate a texture from this Graphics object.\r\rIf `key` is a string it'll generate a new texture using it and add it into the\rTexture Manager (assuming no key conflict happens).\r\rIf `key` is a Canvas it will draw the Graphics to that canvas context. Note that it will NOT\rautomatically upload it to the GPU in WebGL mode.\r\rPlease understand that the texture is created via the Canvas API of the browser, therefore some\rGraphics features, such as `fillGradientStyle`, will not appear on the resulting texture,\ras they're unsupported by the Canvas API.", "kind": "function", "name": "generateTexture", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "HTMLCanvasElement" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "HTMLCanvasElement" } ] } }, "description": "The key to store the texture with in the Texture Manager, or a Canvas to draw to.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the graphics to generate.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the graphics to generate.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#generateTexture", "scope": "instance", "___id": "T000002R011206", "___s": true }, { "comment": "/**\r\n * Internal destroy handler, called as part of the destroy process.\r\n *\r\n * @method Phaser.GameObjects.Graphics#preDestroy\r\n * @protected\r\n * @since 3.9.0\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1594, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Internal destroy handler, called as part of the destroy process.", "kind": "function", "name": "preDestroy", "access": "protected", "since": "3.9.0", "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics#preDestroy", "scope": "instance", "___id": "T000002R011224", "___s": true }, { "comment": "/**\r\n * A Camera used specifically by the Graphics system for rendering to textures.\r\n *\r\n * @name Phaser.GameObjects.Graphics.TargetCamera\r\n * @type {Phaser.Cameras.Scene2D.Camera}\r\n * @since 3.1.0\r\n */", "meta": { "filename": "Graphics.js", "lineno": 1608, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "A Camera used specifically by the Graphics system for rendering to textures.", "name": "TargetCamera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "since": "3.1.0", "memberof": "Phaser.GameObjects.Graphics", "longname": "Phaser.GameObjects.Graphics.TargetCamera", "scope": "static", "kind": "member", "___id": "T000002R011227", "___s": true }, { "comment": "/**\r\n * Creates a new Graphics Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Graphics Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#graphics\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Graphics.Options} [config] - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Graphics} The Game Object that was created.\r\n */", "meta": { "filename": "GraphicsCreator.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Creates a new Graphics Game Object and returns it.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Graphics.Options" } }, "optional": true, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#graphics", "scope": "instance", "___id": "T000002R011279", "___s": true }, { "comment": "/**\r\n * Creates a new Graphics Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Graphics Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#graphics\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Graphics.Options} [config] - The Graphics configuration.\r\n *\r\n * @return {Phaser.GameObjects.Graphics} The Game Object that was created.\r\n */", "meta": { "filename": "GraphicsFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics", "code": {} }, "description": "Creates a new Graphics Game Object and adds it to the Scene.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Graphics.Options" } }, "optional": true, "description": "The Graphics configuration.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#graphics", "scope": "instance", "___id": "T000002R011285", "___s": true }, { "comment": "/**\r\n * Graphics fill style settings.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.Graphics.FillStyle\r\n * @since 3.0.0\r\n *\r\n * @property {number} [color] - The fill color.\r\n * @property {number} [alpha] - The fill alpha.\r\n */", "meta": { "filename": "FillStyle.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics\\typedefs", "code": {} }, "description": "Graphics fill style settings.", "kind": "typedef", "name": "FillStyle", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The fill color.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The fill alpha.", "name": "alpha" } ], "memberof": "Phaser.Types.GameObjects.Graphics", "longname": "Phaser.Types.GameObjects.Graphics.FillStyle", "scope": "static", "___id": "T000002R011439", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Graphics\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics\\typedefs", "code": {} }, "kind": "namespace", "name": "Graphics", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Graphics", "scope": "static", "___id": "T000002R011440", "___s": true }, { "comment": "/**\r\n * Graphics line style (or stroke style) settings.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.Graphics.LineStyle\r\n * @since 3.0.0\r\n *\r\n * @property {number} [width] - The stroke width.\r\n * @property {number} [color] - The stroke color.\r\n * @property {number} [alpha] - The stroke alpha.\r\n */", "meta": { "filename": "LineStyle.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics\\typedefs", "code": {} }, "description": "Graphics line style (or stroke style) settings.", "kind": "typedef", "name": "LineStyle", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The stroke width.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The stroke color.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The stroke alpha.", "name": "alpha" } ], "memberof": "Phaser.Types.GameObjects.Graphics", "longname": "Phaser.Types.GameObjects.Graphics.LineStyle", "scope": "static", "___id": "T000002R011441", "___s": true }, { "comment": "/**\r\n * Options for the Graphics Game Object.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.Graphics.Options\r\n * @extends Phaser.Types.GameObjects.Graphics.Styles\r\n * @since 3.0.0\r\n *\r\n * @property {number} [x] - The x coordinate of the Graphics.\r\n * @property {number} [y] - The y coordinate of the Graphics.\r\n */", "meta": { "filename": "Options.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics\\typedefs", "code": {} }, "description": "Options for the Graphics Game Object.", "kind": "typedef", "name": "Options", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.Graphics.Styles" ], "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x coordinate of the Graphics.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R011442", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Graphics.RoundedRectRadius\r\n * @since 3.11.0\r\n *\r\n * @property {number} [tl=20] - Top left corner radius. Draw concave arc if this radius is negative.\r\n * @property {number} [tr=20] - Top right corner radius. Draw concave arc if this radius is negative.\r\n * @property {number} [br=20] - Bottom right corner radius. Draw concave arc if this radius is negative.\r\n * @property {number} [bl=20] - Bottom left corner radius. Draw concave arc if this radius is negative.\r\n */", "meta": { "filename": "RoundedRectRadius.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics\\typedefs", "code": {} }, "kind": "typedef", "name": "RoundedRectRadius", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.11.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 20, "description": "Top left corner radius. Draw concave arc if this radius is negative.", "name": "tl" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 20, "description": "Top right corner radius. Draw concave arc if this radius is negative.", "name": "tr" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 20, "description": "Bottom right corner radius. Draw concave arc if this radius is negative.", "name": "br" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 20, "description": "Bottom left corner radius. Draw concave arc if this radius is negative.", "name": "bl" } ], "memberof": "Phaser.Types.GameObjects.Graphics", "longname": "Phaser.Types.GameObjects.Graphics.RoundedRectRadius", "scope": "static", "___id": "T000002R011443", "___s": true }, { "comment": "/**\r\n * Graphics style settings.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.Graphics.Styles\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Types.GameObjects.Graphics.LineStyle} [lineStyle] - The style applied to shape outlines.\r\n * @property {Phaser.Types.GameObjects.Graphics.FillStyle} [fillStyle] - The style applied to shape areas.\r\n */", "meta": { "filename": "Styles.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics\\typedefs", "code": {} }, "description": "Graphics style settings.", "kind": "typedef", "name": "Styles", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Types.GameObjects.Graphics.LineStyle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Graphics.LineStyle" } }, "optional": true, "description": "The style applied to shape outlines.", "name": "lineStyle" }, { "type": { "names": [ "Phaser.Types.GameObjects.Graphics.FillStyle" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R011444", "___s": true }, { "comment": "/**\r\n * A point with a width, used to describe a point on a line.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.Graphics.WidePoint\r\n * @since 4.0.0\r\n *\r\n * @property {number} [x] - The x coordinate of the point.\r\n * @property {number} [y] - The y coordinate of the point.\r\n * @property {number} [width] - The width of the point.\r\n */", "meta": { "filename": "WidePoint.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\graphics\\typedefs", "code": {} }, "description": "A point with a width, used to describe a point on a line.", "kind": "typedef", "name": "WidePoint", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x coordinate of the point.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y coordinate of the point.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the point.", "name": "width" } ], "memberof": "Phaser.Types.GameObjects.Graphics", "longname": "Phaser.Types.GameObjects.Graphics.WidePoint", "scope": "static", "___id": "T000002R011445", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Group is a way for you to create, manipulate, or recycle similar Game Objects.\r\n *\r\n * Groups are commonly used to implement object pools, where a fixed set of Game Objects\r\n * are created up front and then recycled by toggling their `active` and `visible` states,\r\n * avoiding the overhead of repeated construction and garbage collection. This pattern is\r\n * especially useful for frequently spawned objects such as bullets, particles, or enemies.\r\n *\r\n * Group membership is non-exclusive. A Game Object can belong to several groups, one group, or none.\r\n *\r\n * Groups themselves aren't displayable, and can't be positioned, rotated, scaled, or hidden.\r\n *\r\n * @class Group\r\n * @memberof Phaser.GameObjects\r\n * @extends Phaser.Events.EventEmitter\r\n * @constructor\r\n * @since 3.0.0\r\n * @param {Phaser.Scene} scene - The scene this group belongs to.\r\n * @param {(Phaser.GameObjects.GameObject[]|Phaser.Types.GameObjects.Group.GroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.\r\n * @param {Phaser.Types.GameObjects.Group.GroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig} [config] - Settings for this group. If `key` is set, Phaser.GameObjects.Group#createMultiple is also called with these settings.\r\n *\r\n * @see Phaser.Physics.Arcade.Group\r\n * @see Phaser.Physics.Arcade.StaticGroup\r\n */", "meta": { "filename": "Group.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "classdesc": "A Group is a way for you to create, manipulate, or recycle similar Game Objects.\r\rGroups are commonly used to implement object pools, where a fixed set of Game Objects\rare created up front and then recycled by toggling their `active` and `visible` states,\ravoiding the overhead of repeated construction and garbage collection. This pattern is\respecially useful for frequently spawned objects such as bullets, particles, or enemies.\r\rGroup membership is non-exclusive. A Game Object can belong to several groups, one group, or none.\r\rGroups themselves aren't displayable, and can't be positioned, rotated, scaled, or hidden.", "kind": "class", "name": "Group", "memberof": "Phaser.GameObjects", "augments": [ "Phaser.Events.EventEmitter" ], "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The scene this group belongs to.", "name": "scene" }, { "type": { "names": [ "Array.", "Phaser.Types.GameObjects.Group.GroupConfig", "Phaser.Types.GameObjects.Group.GroupCreateConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupConfig" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupConfig" }, { "type": "NameExpression", "name": "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", "___id": "T000002R011457", "___s": true }, { "comment": "/**\r\n * This scene this group belongs to.\r\n *\r\n * @name Phaser.GameObjects.Group#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Group.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "This scene this group belongs to.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#scene", "scope": "instance", "kind": "member", "___id": "T000002R011466", "___s": true }, { "comment": "/**\r\n * Members of this group.\r\n *\r\n * @name Phaser.GameObjects.Group#children\r\n * @type {Set.}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Group.js", "lineno": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Members of this group.", "name": "children", "type": { "names": [ "Set." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Set" }, "applications": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#children", "scope": "instance", "kind": "member", "___id": "T000002R011468", "___s": true }, { "comment": "/**\r\n * A flag identifying this object as a group.\r\n *\r\n * @name Phaser.GameObjects.Group#isParent\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Group.js", "lineno": 108, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "A flag identifying this object as a group.", "name": "isParent", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#isParent", "scope": "instance", "kind": "member", "___id": "T000002R011470", "___s": true }, { "comment": "/**\r\n * A textual representation of this Game Object.\r\n * Used internally by Phaser but is available for your own custom classes to populate.\r\n *\r\n * @name Phaser.GameObjects.Group#type\r\n * @type {string}\r\n * @default 'Group'\r\n * @since 3.21.0\r\n */", "meta": { "filename": "Group.js", "lineno": 118, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "A textual representation of this Game Object.\rUsed internally by Phaser but is available for your own custom classes to populate.", "name": "type", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "'Group'", "since": "3.21.0", "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#type", "scope": "instance", "kind": "member", "___id": "T000002R011472", "___s": true }, { "comment": "/**\r\n * The class to create new group members from.\r\n *\r\n * The constructor arguments must match `(scene, x, y, texture, frame)`.\r\n *\r\n * @name Phaser.GameObjects.Group#classType\r\n * @type {function}\r\n * @since 3.0.0\r\n * @default Phaser.GameObjects.Sprite\r\n * @see Phaser.Types.GameObjects.Group.GroupClassTypeConstructor\r\n */", "meta": { "filename": "Group.js", "lineno": 129, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "The class to create new group members from.\r\rThe constructor arguments must match `(scene, x, y, texture, frame)`.", "name": "classType", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.0.0", "defaultvalue": "Phaser.GameObjects.Sprite", "see": [ "Phaser.Types.GameObjects.Group.GroupClassTypeConstructor" ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#classType", "scope": "instance", "kind": "member", "___id": "T000002R011474", "___s": true }, { "comment": "/**\r\n * The name of this group.\r\n * Empty by default and never populated by Phaser, this is left for developers to use.\r\n *\r\n * @name Phaser.GameObjects.Group#name\r\n * @type {string}\r\n * @default ''\r\n * @since 3.18.0\r\n */", "meta": { "filename": "Group.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "The name of this group.\rEmpty by default and never populated by Phaser, this is left for developers to use.", "name": "name", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "''", "since": "3.18.0", "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#name", "scope": "instance", "kind": "member", "___id": "T000002R011476", "___s": true }, { "comment": "/**\r\n * Whether this group runs its {@link Phaser.GameObjects.Group#preUpdate} method (which may update any members).\r\n *\r\n * @name Phaser.GameObjects.Group#active\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Group.js", "lineno": 153, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Whether this group runs its {@link Phaser.GameObjects.Group#preUpdate} method (which may update any members).", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#active", "scope": "instance", "kind": "member", "___id": "T000002R011478", "___s": true }, { "comment": "/**\r\n * The maximum size of this group, if used as a pool. -1 is no limit.\r\n *\r\n * @name Phaser.GameObjects.Group#maxSize\r\n * @type {number}\r\n * @since 3.0.0\r\n * @default -1\r\n */", "meta": { "filename": "Group.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "The maximum size of this group, if used as a pool. -1 is no limit.", "name": "maxSize", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "defaultvalue": "-1", "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#maxSize", "scope": "instance", "kind": "member", "___id": "T000002R011480", "___s": true }, { "comment": "/**\r\n * A default texture key to use when creating new group members.\r\n *\r\n * This is used in {@link Phaser.GameObjects.Group#create}\r\n * but not in {@link Phaser.GameObjects.Group#createMultiple}.\r\n *\r\n * @name Phaser.GameObjects.Group#defaultKey\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Group.js", "lineno": 172, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "A default texture key to use when creating new group members.\r\rThis is used in {@link Phaser.GameObjects.Group#create}\rbut not in {@link Phaser.GameObjects.Group#createMultiple}.", "name": "defaultKey", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#defaultKey", "scope": "instance", "kind": "member", "___id": "T000002R011482", "___s": true }, { "comment": "/**\r\n * A default texture frame to use when creating new group members.\r\n *\r\n * @name Phaser.GameObjects.Group#defaultFrame\r\n * @type {(string|number)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Group.js", "lineno": 184, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "A default texture frame to use when creating new group members.", "name": "defaultFrame", "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#defaultFrame", "scope": "instance", "kind": "member", "___id": "T000002R011484", "___s": true }, { "comment": "/**\r\n * Whether to call the update method of any members.\r\n *\r\n * @name Phaser.GameObjects.Group#runChildUpdate\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n * @see Phaser.GameObjects.Group#preUpdate\r\n */", "meta": { "filename": "Group.js", "lineno": 193, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Whether to call the update method of any members.", "name": "runChildUpdate", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R011486", "___s": true }, { "comment": "/**\r\n * A function to be called when adding or creating group members.\r\n *\r\n * @name Phaser.GameObjects.Group#createCallback\r\n * @type {?Phaser.Types.GameObjects.Group.GroupCallback}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Group.js", "lineno": 204, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "A function to be called when adding or creating group members.", "name": "createCallback", "type": { "names": [ "Phaser.Types.GameObjects.Group.GroupCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupCallback", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#createCallback", "scope": "instance", "kind": "member", "___id": "T000002R011488", "___s": true }, { "comment": "/**\r\n * A function to be called when removing group members.\r\n *\r\n * @name Phaser.GameObjects.Group#removeCallback\r\n * @type {?Phaser.Types.GameObjects.Group.GroupCallback}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Group.js", "lineno": 213, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "A function to be called when removing group members.", "name": "removeCallback", "type": { "names": [ "Phaser.Types.GameObjects.Group.GroupCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupCallback", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#removeCallback", "scope": "instance", "kind": "member", "___id": "T000002R011490", "___s": true }, { "comment": "/**\r\n * A function to be called when creating several group members at once.\r\n *\r\n * @name Phaser.GameObjects.Group#createMultipleCallback\r\n * @type {?Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Group.js", "lineno": 222, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "A function to be called when creating several group members at once.", "name": "createMultipleCallback", "type": { "names": [ "Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#createMultipleCallback", "scope": "instance", "kind": "member", "___id": "T000002R011492", "___s": true }, { "comment": "/**\r\n * Called when this Group is added to a Scene. Registers this Group with the Scene's update list\r\n * so that its `preUpdate` method is called each game step.\r\n *\r\n * @method Phaser.GameObjects.Group#addedToScene\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Group.js", "lineno": 267, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Called when this Group is added to a Scene. Registers this Group with the Scene's update list\rso that its `preUpdate` method is called each game step.", "kind": "function", "name": "addedToScene", "since": "3.0.0", "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#addedToScene", "scope": "instance", "___id": "T000002R011498", "___s": true }, { "comment": "/**\r\n * Called when this Group is removed from a Scene. Unregisters this Group from the Scene's\r\n * update list so that its `preUpdate` method is no longer called each game step.\r\n *\r\n * @method Phaser.GameObjects.Group#removedFromScene\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Group.js", "lineno": 279, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Called when this Group is removed from a Scene. Unregisters this Group from the Scene's\rupdate list so that its `preUpdate` method is no longer called each game step.", "kind": "function", "name": "removedFromScene", "since": "3.0.0", "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#removedFromScene", "scope": "instance", "___id": "T000002R011500", "___s": true }, { "comment": "/**\r\n * Creates a new Game Object and adds it to this group, unless the group {@link Phaser.GameObjects.Group#isFull is full}.\r\n *\r\n * Calls {@link Phaser.GameObjects.Group#createCallback}.\r\n *\r\n * @method Phaser.GameObjects.Group#create\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of the new Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of the new Game Object in the world.\r\n * @param {string} [key=defaultKey] - The texture key of the new Game Object.\r\n * @param {(string|number)} [frame=defaultFrame] - The texture frame of the new Game Object.\r\n * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of the new Game Object.\r\n * @param {boolean} [active=true] - The {@link Phaser.GameObjects.GameObject#active} state of the new Game Object.\r\n *\r\n * @return {any} The new Game Object (usually a Sprite, etc.).\r\n */", "meta": { "filename": "Group.js", "lineno": 291, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Creates a new Game Object and adds it to this group, unless the group {@link Phaser.GameObjects.Group#isFull is full}.\r\rCalls {@link Phaser.GameObjects.Group#createCallback}.", "kind": "function", "name": "create", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the new Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the new Game Object in the world.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "defaultKey", "description": "The texture key of the new Game Object.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": "defaultFrame", "description": "The texture frame of the new Game Object.", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "The {@link Phaser.GameObjects.Components.Visible#visible} state of the new Game Object.", "name": "visible" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "The {@link Phaser.GameObjects.GameObject#active} state of the new Game Object.", "name": "active" } ], "returns": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The new Game Object (usually a Sprite, etc.)." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#create", "scope": "instance", "___id": "T000002R011502", "___s": true }, { "comment": "/**\r\n * Creates several Game Objects and adds them to this group.\r\n *\r\n * If the group becomes {@link Phaser.GameObjects.Group#isFull}, no further Game Objects are created.\r\n *\r\n * Calls {@link Phaser.GameObjects.Group#createMultipleCallback} and {@link Phaser.GameObjects.Group#createCallback}.\r\n *\r\n * @method Phaser.GameObjects.Group#createMultiple\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Group.GroupCreateConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig[]} config - Creation settings. This can be a single configuration object or an array of such objects, which will be applied in turn.\r\n *\r\n * @return {any[]} The newly created Game Objects.\r\n */", "meta": { "filename": "Group.js", "lineno": 336, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Creates several Game Objects and adds them to this group.\r\rIf the group becomes {@link Phaser.GameObjects.Group#isFull}, no further Game Objects are created.\r\rCalls {@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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupCreateConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.GameObjects.Group.GroupCreateConfig", "type": "NameExpression" } ] } ] } }, "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } }, "description": "The newly created Game Objects." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#createMultiple", "scope": "instance", "___id": "T000002R011512", "___s": true }, { "comment": "/**\r\n * A helper for {@link Phaser.GameObjects.Group#createMultiple}.\r\n *\r\n * @method Phaser.GameObjects.Group#createFromConfig\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Group.GroupCreateConfig} options - Creation settings.\r\n *\r\n * @return {any[]} The newly created Game Objects.\r\n */", "meta": { "filename": "Group.js", "lineno": 377, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupCreateConfig" } }, "description": "Creation settings.", "name": "options" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } }, "description": "The newly created Game Objects." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#createFromConfig", "scope": "instance", "___id": "T000002R011519", "___s": true }, { "comment": "/**\r\n * Updates any group members, if {@link Phaser.GameObjects.Group#runChildUpdate} is enabled.\r\n *\r\n * @method Phaser.GameObjects.Group#preUpdate\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current timestamp.\r\n * @param {number} delta - The delta time elapsed since the last frame.\r\n */", "meta": { "filename": "Group.js", "lineno": 563, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#preUpdate", "scope": "instance", "___id": "T000002R011574", "___s": true }, { "comment": "/**\r\n * Adds a Game Object to this group.\r\n *\r\n * Calls {@link Phaser.GameObjects.Group#createCallback}.\r\n *\r\n * @method Phaser.GameObjects.Group#add\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The Game Object to add.\r\n * @param {boolean} [addToScene=false] - Also add the Game Object to the scene.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 588, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Adds a Game Object to this group.\r\rCalls {@link Phaser.GameObjects.Group#createCallback}.", "kind": "function", "name": "add", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to add.", "name": "child" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Also add the Game Object to the scene.", "name": "addToScene" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#add", "scope": "instance", "___id": "T000002R011576", "___s": true }, { "comment": "/**\r\n * Adds several Game Objects to this group.\r\n *\r\n * Calls {@link Phaser.GameObjects.Group#createCallback}.\r\n *\r\n * @method Phaser.GameObjects.Group#addMultiple\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject[]} children - The Game Objects to add.\r\n * @param {boolean} [addToScene=false] - Also add the Game Objects to the scene.\r\n *\r\n * @return {this} This group.\r\n */", "meta": { "filename": "Group.js", "lineno": 633, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Adds several Game Objects to this group.\r\rCalls {@link Phaser.GameObjects.Group#createCallback}.", "kind": "function", "name": "addMultiple", "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "The Game Objects to add.", "name": "children" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Also add the Game Objects to the scene.", "name": "addToScene" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This group." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#addMultiple", "scope": "instance", "___id": "T000002R011579", "___s": true }, { "comment": "/**\r\n * Removes a member of this Group and optionally removes it from the Scene and / or destroys it.\r\n *\r\n * Calls {@link Phaser.GameObjects.Group#removeCallback}.\r\n *\r\n * @method Phaser.GameObjects.Group#remove\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The Game Object to remove.\r\n * @param {boolean} [removeFromScene=false] - Optionally remove the Group member from the Scene it belongs to.\r\n * @param {boolean} [destroyChild=false] - Optionally call destroy on the removed Group member.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 661, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Removes a member of this Group and optionally removes it from the Scene and / or destroys it.\r\rCalls {@link Phaser.GameObjects.Group#removeCallback}.", "kind": "function", "name": "remove", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to remove.", "name": "child" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optionally remove the Group member from the Scene it belongs to.", "name": "removeFromScene" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optionally call destroy on the removed Group member.", "name": "destroyChild" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#remove", "scope": "instance", "___id": "T000002R011583", "___s": true }, { "comment": "/**\r\n * Removes all members of this Group and optionally removes them from the Scene and / or destroys them.\r\n *\r\n * Does not call {@link Phaser.GameObjects.Group#removeCallback}.\r\n *\r\n * @method Phaser.GameObjects.Group#clear\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [removeFromScene=false] - Optionally remove each Group member from the Scene.\r\n * @param {boolean} [destroyChild=false] - Optionally call destroy on the removed Group members.\r\n *\r\n * @return {this} This group.\r\n */", "meta": { "filename": "Group.js", "lineno": 712, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Removes all members of this Group and optionally removes them from the Scene and / or destroys them.\r\rDoes not call {@link Phaser.GameObjects.Group#removeCallback}.", "kind": "function", "name": "clear", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optionally remove each Group member from the Scene.", "name": "removeFromScene" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optionally call destroy on the removed Group members.", "name": "destroyChild" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This group." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#clear", "scope": "instance", "___id": "T000002R011587", "___s": true }, { "comment": "/**\r\n * Tests if a Game Object is a member of this group.\r\n *\r\n * @method Phaser.GameObjects.Group#contains\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - A Game Object.\r\n *\r\n * @return {boolean} True if the Game Object is a member of this group.\r\n */", "meta": { "filename": "Group.js", "lineno": 752, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A Game Object.", "name": "child" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object is a member of this group." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#contains", "scope": "instance", "___id": "T000002R011592", "___s": true }, { "comment": "/**\r\n * All members of the group.\r\n *\r\n * @method Phaser.GameObjects.Group#getChildren\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.GameObjects.GameObject[]} The group members.\r\n */", "meta": { "filename": "Group.js", "lineno": 767, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "All members of the group.", "kind": "function", "name": "getChildren", "since": "3.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "The group members." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#getChildren", "scope": "instance", "___id": "T000002R011594", "___s": true }, { "comment": "/**\r\n * The number of members of the group.\r\n *\r\n * @method Phaser.GameObjects.Group#getLength\r\n * @since 3.0.0\r\n *\r\n * @return {number} The total number of members in this Group.\r\n */", "meta": { "filename": "Group.js", "lineno": 780, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "The number of members of the group.", "kind": "function", "name": "getLength", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of members in this Group." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#getLength", "scope": "instance", "___id": "T000002R011596", "___s": true }, { "comment": "/**\r\n * Returns all children in this Group that match the given criteria based on the `property` and `value` arguments.\r\n *\r\n * For example: `getMatching('visible', true)` would return only children that have their `visible` property set.\r\n *\r\n * Optionally, you can specify a start and end index. For example if the Group has 100 elements,\r\n * and you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\r\n * the first 50.\r\n *\r\n * @method Phaser.GameObjects.Group#getMatching\r\n * @since 3.50.0\r\n *\r\n * @param {string} [property] - The property to test on each array element.\r\n * @param {*} [value] - The value to test the property against. Must pass a strict (`===`) comparison check.\r\n * @param {number} [startIndex] - An optional start index to search from.\r\n * @param {number} [endIndex] - An optional end index to search to.\r\n *\r\n * @return {any[]} An array of matching Group members. The array will be empty if nothing matched.\r\n */", "meta": { "filename": "Group.js", "lineno": 793, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Returns all children in this Group that match the given criteria based on the `property` and `value` arguments.\r\rFor example: `getMatching('visible', true)` would return only children that have their `visible` property set.\r\rOptionally, you can specify a start and end index. For example if the Group has 100 elements,\rand you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\rthe first 50.", "kind": "function", "name": "getMatching", "since": "3.50.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The property to test on each array element.", "name": "property" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The value to test the property against. Must pass a strict (`===`) comparison check.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "An optional start index to search from.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "An optional end index to search to.", "name": "endIndex" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } }, "description": "An array of matching Group members. The array will be empty if nothing matched." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#getMatching", "scope": "instance", "___id": "T000002R011598", "___s": true }, { "comment": "/**\r\n * Scans the Group, from top to bottom, for the first member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\r\n * assigns `x` and `y`, and returns the member.\r\n *\r\n * If 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`.\r\n * Unless a new member is created, `key`, `frame`, and `visible` are ignored.\r\n *\r\n * @method Phaser.GameObjects.Group#getFirst\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [state=false] - The {@link Phaser.GameObjects.GameObject#active} value to match.\r\n * @param {boolean} [createIfNull=false] - Create a new Game Object if no matching members are found, using the following arguments.\r\n * @param {number} [x] - The horizontal position of the Game Object in the world.\r\n * @param {number} [y] - The vertical position of the Game Object in the world.\r\n * @param {string} [key=defaultKey] - The texture key assigned to a new Game Object (if one is created).\r\n * @param {(string|number)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).\r\n * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).\r\n *\r\n * @return {?any} The first matching group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 817, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Scans the Group, from top to bottom, for the first member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\rassigns `x` and `y`, and returns the member.\r\rIf 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`.\rUnless a new member is created, `key`, `frame`, and `visible` are ignored.", "kind": "function", "name": "getFirst", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "The {@link Phaser.GameObjects.GameObject#active} value to match.", "name": "state" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position of the Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical position of the Game Object in the world.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "defaultKey", "description": "The texture key assigned to a new Game Object (if one is created).", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": "defaultFrame", "description": "A texture frame assigned to a new Game Object (if one is created).", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "any", "nullable": true } }, "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", "___id": "T000002R011600", "___s": true }, { "comment": "/**\r\n * Scans the Group, from top to bottom, for the nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\r\n * assigns `x` and `y`, and returns the member.\r\n *\r\n * If 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`.\r\n * Unless a new member is created, `key`, `frame`, and `visible` are ignored.\r\n *\r\n * @method Phaser.GameObjects.Group#getFirstNth\r\n * @since 3.6.0\r\n *\r\n * @param {number} nth - The nth matching Group member to search for.\r\n * @param {boolean} [state=false] - The {@link Phaser.GameObjects.GameObject#active} value to match.\r\n * @param {boolean} [createIfNull=false] - Create a new Game Object if no matching members are found, using the following arguments.\r\n * @param {number} [x] - The horizontal position of the Game Object in the world.\r\n * @param {number} [y] - The vertical position of the Game Object in the world.\r\n * @param {string} [key=defaultKey] - The texture key assigned to a new Game Object (if one is created).\r\n * @param {(string|number)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).\r\n * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).\r\n *\r\n * @return {?any} The nth matching group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 842, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Scans the Group, from top to bottom, for the nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\rassigns `x` and `y`, and returns the member.\r\rIf 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`.\rUnless a new member is created, `key`, `frame`, and `visible` are ignored.", "kind": "function", "name": "getFirstNth", "since": "3.6.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The nth matching Group member to search for.", "name": "nth" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "The {@link Phaser.GameObjects.GameObject#active} value to match.", "name": "state" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position of the Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical position of the Game Object in the world.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "defaultKey", "description": "The texture key assigned to a new Game Object (if one is created).", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": "defaultFrame", "description": "A texture frame assigned to a new Game Object (if one is created).", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "any", "nullable": true } }, "nullable": true, "description": "The nth matching group member, or a newly created member, or null." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#getFirstNth", "scope": "instance", "___id": "T000002R011602", "___s": true }, { "comment": "/**\r\n * Scans the Group for the last member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\r\n * assigns `x` and `y`, and returns the member.\r\n *\r\n * If 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`.\r\n * Unless a new member is created, `key`, `frame`, and `visible` are ignored.\r\n *\r\n * @method Phaser.GameObjects.Group#getLast\r\n * @since 3.6.0\r\n *\r\n * @param {boolean} [state=false] - The {@link Phaser.GameObjects.GameObject#active} value to match.\r\n * @param {boolean} [createIfNull=false] - Create a new Game Object if no matching members are found, using the following arguments.\r\n * @param {number} [x] - The horizontal position of the Game Object in the world.\r\n * @param {number} [y] - The vertical position of the Game Object in the world.\r\n * @param {string} [key=defaultKey] - The texture key assigned to a new Game Object (if one is created).\r\n * @param {(string|number)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).\r\n * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).\r\n *\r\n * @return {?any} The last matching group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 868, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Scans the Group for the last member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\rassigns `x` and `y`, and returns the member.\r\rIf 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`.\rUnless a new member is created, `key`, `frame`, and `visible` are ignored.", "kind": "function", "name": "getLast", "since": "3.6.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "The {@link Phaser.GameObjects.GameObject#active} value to match.", "name": "state" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position of the Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical position of the Game Object in the world.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "defaultKey", "description": "The texture key assigned to a new Game Object (if one is created).", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": "defaultFrame", "description": "A texture frame assigned to a new Game Object (if one is created).", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "any", "nullable": true } }, "nullable": true, "description": "The last matching group member, or a newly created member, or null." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#getLast", "scope": "instance", "___id": "T000002R011604", "___s": true }, { "comment": "/**\r\n * Scans the Group for the last nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\r\n * assigns `x` and `y`, and returns the member.\r\n *\r\n * If 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`.\r\n * Unless a new member is created, `key`, `frame`, and `visible` are ignored.\r\n *\r\n * @method Phaser.GameObjects.Group#getLastNth\r\n * @since 3.6.0\r\n *\r\n * @param {number} nth - The nth matching Group member to search for.\r\n * @param {boolean} [state=false] - The {@link Phaser.GameObjects.GameObject#active} value to match.\r\n * @param {boolean} [createIfNull=false] - Create a new Game Object if no matching members are found, using the following arguments.\r\n * @param {number} [x] - The horizontal position of the Game Object in the world.\r\n * @param {number} [y] - The vertical position of the Game Object in the world.\r\n * @param {string} [key=defaultKey] - The texture key assigned to a new Game Object (if one is created).\r\n * @param {(string|number)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).\r\n * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).\r\n *\r\n * @return {?any} The nth matching group member (searching from the end), or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 893, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Scans the Group for the last nth member that has an {@link Phaser.GameObjects.GameObject#active} state matching the argument,\rassigns `x` and `y`, and returns the member.\r\rIf 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`.\rUnless a new member is created, `key`, `frame`, and `visible` are ignored.", "kind": "function", "name": "getLastNth", "since": "3.6.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The nth matching Group member to search for.", "name": "nth" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "The {@link Phaser.GameObjects.GameObject#active} value to match.", "name": "state" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position of the Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical position of the Game Object in the world.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "defaultKey", "description": "The texture key assigned to a new Game Object (if one is created).", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": "defaultFrame", "description": "A texture frame assigned to a new Game Object (if one is created).", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "any", "nullable": true } }, "nullable": true, "description": "The nth matching group member (searching from the end), or a newly created member, or null." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#getLastNth", "scope": "instance", "___id": "T000002R011606", "___s": true }, { "comment": "/**\r\n * Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\r\n * assigns `x` and `y`, and returns the member.\r\n *\r\n * If 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`.\r\n * The new Game Object will have its active state set to `true`.\r\n * Unless a new member is created, `key`, `frame`, and `visible` are ignored.\r\n *\r\n * @method Phaser.GameObjects.Group#get\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x] - The horizontal position of the Game Object in the world.\r\n * @param {number} [y] - The vertical position of the Game Object in the world.\r\n * @param {string} [key=defaultKey] - The texture key assigned to a new Game Object (if one is created).\r\n * @param {(string|number)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).\r\n * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).\r\n *\r\n * @return {?any} The first inactive group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 1022, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\rassigns `x` and `y`, and returns the member.\r\rIf 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`.\rThe new Game Object will have its active state set to `true`.\rUnless a new member is created, `key`, `frame`, and `visible` are ignored.", "kind": "function", "name": "get", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position of the Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical position of the Game Object in the world.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "defaultKey", "description": "The texture key assigned to a new Game Object (if one is created).", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": "defaultFrame", "description": "A texture frame assigned to a new Game Object (if one is created).", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "any", "nullable": true } }, "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", "___id": "T000002R011624", "___s": true }, { "comment": "/**\r\n * Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `true`,\r\n * assigns `x` and `y`, and returns the member.\r\n *\r\n * If 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`.\r\n * Unless a new member is created, `key`, `frame`, and `visible` are ignored.\r\n *\r\n * @method Phaser.GameObjects.Group#getFirstAlive\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [createIfNull=false] - Create a new Game Object if no matching members are found, using the following arguments.\r\n * @param {number} [x] - The horizontal position of the Game Object in the world.\r\n * @param {number} [y] - The vertical position of the Game Object in the world.\r\n * @param {string} [key=defaultKey] - The texture key assigned to a new Game Object (if one is created).\r\n * @param {(string|number)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).\r\n * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).\r\n *\r\n * @return {any} The first active group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 1046, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `true`,\rassigns `x` and `y`, and returns the member.\r\rIf 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`.\rUnless a new member is created, `key`, `frame`, and `visible` are ignored.", "kind": "function", "name": "getFirstAlive", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position of the Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical position of the Game Object in the world.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "defaultKey", "description": "The texture key assigned to a new Game Object (if one is created).", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": "defaultFrame", "description": "A texture frame assigned to a new Game Object (if one is created).", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R011626", "___s": true }, { "comment": "/**\r\n * Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\r\n * assigns `x` and `y`, and returns the member.\r\n *\r\n * If 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`.\r\n * The new Game Object will have an active state set to `true`.\r\n * Unless a new member is created, `key`, `frame`, and `visible` are ignored.\r\n *\r\n * @method Phaser.GameObjects.Group#getFirstDead\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [createIfNull=false] - Create a new Game Object if no matching members are found, using the following arguments.\r\n * @param {number} [x] - The horizontal position of the Game Object in the world.\r\n * @param {number} [y] - The vertical position of the Game Object in the world.\r\n * @param {string} [key=defaultKey] - The texture key assigned to a new Game Object (if one is created).\r\n * @param {(string|number)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).\r\n * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).\r\n *\r\n * @return {any} The first inactive group member, or a newly created member, or null.\r\n */", "meta": { "filename": "Group.js", "lineno": 1070, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Scans the group for the first member that has an {@link Phaser.GameObjects.GameObject#active} state set to `false`,\rassigns `x` and `y`, and returns the member.\r\rIf 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`.\rThe new Game Object will have an active state set to `true`.\rUnless a new member is created, `key`, `frame`, and `visible` are ignored.", "kind": "function", "name": "getFirstDead", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position of the Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical position of the Game Object in the world.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "defaultKey", "description": "The texture key assigned to a new Game Object (if one is created).", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "defaultvalue": "defaultFrame", "description": "A texture frame assigned to a new Game Object (if one is created).", "name": "frame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R011628", "___s": true }, { "comment": "/**\r\n * {@link Phaser.Animations.AnimationState#play Plays} an animation for all members of this group.\r\n *\r\n * @method Phaser.GameObjects.Group#playAnimation\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The string-based key of the animation to play.\r\n * @param {string} [startFrame=0] - Optionally start the animation playing from this frame index.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1095, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "{@link Phaser.Animations.AnimationState#play Plays} an animation for all members of this group.", "kind": "function", "name": "playAnimation", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based key of the animation to play.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": 0, "description": "Optionally start the animation playing from this frame index.", "name": "startFrame" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#playAnimation", "scope": "instance", "___id": "T000002R011630", "___s": true }, { "comment": "/**\r\n * Whether this group's size is at its {@link Phaser.GameObjects.Group#maxSize maximum}.\r\n *\r\n * @method Phaser.GameObjects.Group#isFull\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} True if the number of members equals {@link Phaser.GameObjects.Group#maxSize}.\r\n */", "meta": { "filename": "Group.js", "lineno": 1113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Whether this group's size is at its {@link Phaser.GameObjects.Group#maxSize maximum}.", "kind": "function", "name": "isFull", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R011632", "___s": true }, { "comment": "/**\r\n * Counts the number of active (or inactive) group members.\r\n *\r\n * @method Phaser.GameObjects.Group#countActive\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [value=true] - Count active (true) or inactive (false) group members.\r\n *\r\n * @return {number} The number of group members with an active state matching the `active` argument.\r\n */", "meta": { "filename": "Group.js", "lineno": 1133, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Counts the number of active (or inactive) group members.", "kind": "function", "name": "countActive", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Count active (true) or inactive (false) group members.", "name": "value" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R011634", "___s": true }, { "comment": "/**\r\n * Counts the number of in-use (active) group members.\r\n *\r\n * @method Phaser.GameObjects.Group#getTotalUsed\r\n * @since 3.0.0\r\n *\r\n * @return {number} The number of group members with an active state of true.\r\n */", "meta": { "filename": "Group.js", "lineno": 1160, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Counts the number of in-use (active) group members.", "kind": "function", "name": "getTotalUsed", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of group members with an active state of true." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#getTotalUsed", "scope": "instance", "___id": "T000002R011638", "___s": true }, { "comment": "/**\r\n * The difference of {@link Phaser.GameObjects.Group#maxSize} and the number of active group members.\r\n *\r\n * This represents the number of group members that could be created or reactivated before reaching the size limit.\r\n *\r\n * @method Phaser.GameObjects.Group#getTotalFree\r\n * @since 3.0.0\r\n *\r\n * @return {number} maxSize minus the number of active group members; or a large number (if maxSize is -1).\r\n */", "meta": { "filename": "Group.js", "lineno": 1173, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "The difference of {@link Phaser.GameObjects.Group#maxSize} and the number of active group members.\r\rThis 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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "maxSize minus the number of active group members; or a large number (if maxSize is -1)." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#getTotalFree", "scope": "instance", "___id": "T000002R011640", "___s": true }, { "comment": "/**\r\n * Sets the `active` property of this Group.\r\n * When active, this Group runs its `preUpdate` method.\r\n *\r\n * @method Phaser.GameObjects.Group#setActive\r\n * @since 3.24.0\r\n *\r\n * @param {boolean} value - True if this Group should be set as active, false if not.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the `active` property of this Group.\rWhen active, this Group runs its `preUpdate` method.", "kind": "function", "name": "setActive", "since": "3.24.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if this Group should be set as active, false if not.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#setActive", "scope": "instance", "___id": "T000002R011644", "___s": true }, { "comment": "/**\r\n * Sets the `name` property of this Group.\r\n * The `name` property is not populated by Phaser and is presented for your own use.\r\n *\r\n * @method Phaser.GameObjects.Group#setName\r\n * @since 3.24.0\r\n *\r\n * @param {string} value - The name to be given to this Group.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1209, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the `name` property of this Group.\rThe `name` property is not populated by Phaser and is presented for your own use.", "kind": "function", "name": "setName", "since": "3.24.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to be given to this Group.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#setName", "scope": "instance", "___id": "T000002R011647", "___s": true }, { "comment": "/**\r\n * Sets the property as defined in `key` of each group member to the given value.\r\n *\r\n * @method Phaser.GameObjects.Group#propertyValueSet\r\n * @since 3.21.0\r\n *\r\n * @param {string} key - The property to be updated.\r\n * @param {number} value - The amount to set the property to.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to be updated.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#propertyValueSet", "scope": "instance", "___id": "T000002R011650", "___s": true }, { "comment": "/**\r\n * Adds the given value to the property as defined in `key` of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#propertyValueInc\r\n * @since 3.21.0\r\n *\r\n * @param {string} key - The property to be updated.\r\n * @param {number} value - The amount to add to the property.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1248, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to be updated.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to add to the property.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#propertyValueInc", "scope": "instance", "___id": "T000002R011652", "___s": true }, { "comment": "/**\r\n * Sets the x of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#setX\r\n * @since 3.21.0\r\n *\r\n * @param {number} value - The amount to set the property to.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the x of each group member.", "kind": "function", "name": "setX", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#setX", "scope": "instance", "___id": "T000002R011654", "___s": true }, { "comment": "/**\r\n * Sets the y of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#setY\r\n * @since 3.21.0\r\n *\r\n * @param {number} value - The amount to set the property to.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the y of each group member.", "kind": "function", "name": "setY", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#setY", "scope": "instance", "___id": "T000002R011656", "___s": true }, { "comment": "/**\r\n * Sets the x, y of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#setXY\r\n * @since 3.21.0\r\n *\r\n * @param {number} x - The amount to set the `x` property to.\r\n * @param {number} [y=x] - The amount to set the `y` property to. If `undefined` or `null` it uses the `x` value.\r\n * @param {number} [stepX=0] - This is added to the `x` amount, multiplied by the iteration counter.\r\n * @param {number} [stepY=0] - This is added to the `y` amount, multiplied by the iteration counter.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1305, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the x, y of each group member.", "kind": "function", "name": "setXY", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the `x` property to.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `x` amount, multiplied by the iteration counter.", "name": "stepX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `y` amount, multiplied by the iteration counter.", "name": "stepY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#setXY", "scope": "instance", "___id": "T000002R011658", "___s": true }, { "comment": "/**\r\n * Adds the given value to the x of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#incX\r\n * @since 3.21.0\r\n *\r\n * @param {number} value - The amount to be added to the `x` property.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1325, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Adds the given value to the x of each group member.", "kind": "function", "name": "incX", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to be added to the `x` property.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#incX", "scope": "instance", "___id": "T000002R011660", "___s": true }, { "comment": "/**\r\n * Adds the given value to the y of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#incY\r\n * @since 3.21.0\r\n *\r\n * @param {number} value - The amount to be added to the `y` property.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1343, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Adds the given value to the y of each group member.", "kind": "function", "name": "incY", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to be added to the `y` property.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#incY", "scope": "instance", "___id": "T000002R011662", "___s": true }, { "comment": "/**\r\n * Adds the given value to the x, y of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#incXY\r\n * @since 3.21.0\r\n *\r\n * @param {number} x - The amount to be added to the `x` property.\r\n * @param {number} [y=x] - The amount to be added to the `y` property. If `undefined` or `null` it uses the `x` value.\r\n * @param {number} [stepX=0] - This is added to the `x` amount, multiplied by the iteration counter.\r\n * @param {number} [stepY=0] - This is added to the `y` amount, multiplied by the iteration counter.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1361, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to be added to the `x` property.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `x` amount, multiplied by the iteration counter.", "name": "stepX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `y` amount, multiplied by the iteration counter.", "name": "stepY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#incXY", "scope": "instance", "___id": "T000002R011664", "___s": true }, { "comment": "/**\r\n * Iterate through the group members changing the position of each element to be that of the element that came before\r\n * it in the array (or after it if direction = 1)\r\n *\r\n * The first group member position is set to x/y.\r\n *\r\n * @method Phaser.GameObjects.Group#shiftPosition\r\n * @since 3.21.0\r\n *\r\n * @param {number} x - The x coordinate to place the first item in the array at.\r\n * @param {number} y - The y coordinate to place the first item in the array at.\r\n * @param {number} [direction=0] - The iteration direction. 0 = first to last and 1 = last to first.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1381, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Iterate through the group members changing the position of each element to be that of the element that came before\rit in the array (or after it if direction = 1)\r\rThe first group member position is set to x/y.", "kind": "function", "name": "shiftPosition", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to place the first item in the array at.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to place the first item in the array at.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The iteration direction. 0 = first to last and 1 = last to first.", "name": "direction" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#shiftPosition", "scope": "instance", "___id": "T000002R011666", "___s": true }, { "comment": "/**\r\n * Adds the given value to the angle of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#angle\r\n * @since 3.21.0\r\n *\r\n * @param {number} value - The amount to add to the angle, in degrees.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1403, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Adds the given value to the angle of each group member.", "kind": "function", "name": "angle", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to add to the angle, in degrees.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#angle", "scope": "instance", "___id": "T000002R011668", "___s": true }, { "comment": "/**\r\n * Sets the rotation of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#rotate\r\n * @since 3.21.0\r\n *\r\n * @param {number} value - The amount to set the rotation to, in radians.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1421, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the rotation of each group member.", "kind": "function", "name": "rotate", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the rotation to, in radians.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#rotate", "scope": "instance", "___id": "T000002R011670", "___s": true }, { "comment": "/**\r\n * Rotates each group member around the given point by the given angle.\r\n *\r\n * @method Phaser.GameObjects.Group#rotateAround\r\n * @since 3.21.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} point - Any object with public `x` and `y` properties.\r\n * @param {number} angle - The angle to rotate by, in radians.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1439, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "Any object with public `x` and `y` properties.", "name": "point" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle to rotate by, in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#rotateAround", "scope": "instance", "___id": "T000002R011672", "___s": true }, { "comment": "/**\r\n * Rotates each group member around the given point by the given angle and distance.\r\n *\r\n * @method Phaser.GameObjects.Group#rotateAroundDistance\r\n * @since 3.21.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} point - Any object with public `x` and `y` properties.\r\n * @param {number} angle - The angle to rotate by, in radians.\r\n * @param {number} distance - The distance from the point of rotation in pixels.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1457, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "Any object with public `x` and `y` properties.", "name": "point" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle to rotate by, in radians.", "name": "angle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance from the point of rotation in pixels.", "name": "distance" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#rotateAroundDistance", "scope": "instance", "___id": "T000002R011674", "___s": true }, { "comment": "/**\r\n * Sets the alpha of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#setAlpha\r\n * @since 3.21.0\r\n *\r\n * @param {number} value - The amount to set the alpha to.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1476, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the alpha of each group member.", "kind": "function", "name": "setAlpha", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the alpha to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#setAlpha", "scope": "instance", "___id": "T000002R011676", "___s": true }, { "comment": "/**\r\n * Sets the tint of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#setTint\r\n * @since 3.21.0\r\n *\r\n * @param {number} topLeft - 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.\r\n * @param {number} [topRight] - The tint to be applied to top-right corner of item.\r\n * @param {number} [bottomLeft] - The tint to be applied to the bottom-left corner of item.\r\n * @param {number} [bottomRight] - The tint to be applied to the bottom-right corner of item.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the tint of each group member.", "kind": "function", "name": "setTint", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint to be applied to top-right corner of item.", "name": "topRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint to be applied to the bottom-left corner of item.", "name": "bottomLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The tint to be applied to the bottom-right corner of item.", "name": "bottomRight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#setTint", "scope": "instance", "___id": "T000002R011678", "___s": true }, { "comment": "/**\r\n * Sets the originX, originY of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#setOrigin\r\n * @since 3.21.0\r\n *\r\n * @param {number} originX - The amount to set the `originX` property to.\r\n * @param {number} [originY] - The amount to set the `originY` property to. If `undefined` or `null` it uses the `originX` value.\r\n * @param {number} [stepX=0] - This is added to the `originX` amount, multiplied by the iteration counter.\r\n * @param {number} [stepY=0] - This is added to the `originY` amount, multiplied by the iteration counter.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1514, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the originX, originY of each group member.", "kind": "function", "name": "setOrigin", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the `originX` property to.", "name": "originX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `originX` amount, multiplied by the iteration counter.", "name": "stepX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `originY` amount, multiplied by the iteration counter.", "name": "stepY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#setOrigin", "scope": "instance", "___id": "T000002R011680", "___s": true }, { "comment": "/**\r\n * Sets the scaleX of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#scaleX\r\n * @since 3.21.0\r\n *\r\n * @param {number} value - The amount to set the property to.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1534, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the scaleX of each group member.", "kind": "function", "name": "scaleX", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#scaleX", "scope": "instance", "___id": "T000002R011682", "___s": true }, { "comment": "/**\r\n * Sets the scaleY of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#scaleY\r\n * @since 3.21.0\r\n *\r\n * @param {number} value - The amount to set the property to.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1552, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the scaleY of each group member.", "kind": "function", "name": "scaleY", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#scaleY", "scope": "instance", "___id": "T000002R011684", "___s": true }, { "comment": "/**\r\n * Sets the scaleX, scaleY of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#scaleXY\r\n * @since 3.21.0\r\n *\r\n * @param {number} scaleX - The amount to set the `scaleX` property to.\r\n * @param {number} [scaleY] - The amount to set the `scaleY` property to. If `undefined` or `null` it uses the `scaleX` value.\r\n * @param {number} [stepX=0] - This is added to the `scaleX` amount, multiplied by the iteration counter.\r\n * @param {number} [stepY=0] - This is added to the `scaleY` amount, multiplied by the iteration counter.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1570, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the scaleX, scaleY of each group member.", "kind": "function", "name": "scaleXY", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the `scaleX` property to.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `scaleX` amount, multiplied by the iteration counter.", "name": "stepX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `scaleY` amount, multiplied by the iteration counter.", "name": "stepY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#scaleXY", "scope": "instance", "___id": "T000002R011686", "___s": true }, { "comment": "/**\r\n * Sets the depth of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#setDepth\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount to set the property to.\r\n * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1590, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the depth of each group member.", "kind": "function", "name": "setDepth", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to set the property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "This is added to the `value` amount, multiplied by the iteration counter.", "name": "step" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#setDepth", "scope": "instance", "___id": "T000002R011688", "___s": true }, { "comment": "/**\r\n * Sets the blendMode of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#setBlendMode\r\n * @since 3.21.0\r\n *\r\n * @param {number} value - The blend mode value to set. See `Phaser.BlendModes` for valid values.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1608, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the blendMode of each group member.", "kind": "function", "name": "setBlendMode", "since": "3.21.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blend mode value to set. See `Phaser.BlendModes` for valid values.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#setBlendMode", "scope": "instance", "___id": "T000002R011690", "___s": true }, { "comment": "/**\r\n * Passes all group members to the Input Manager to enable them for input with identical areas and callbacks.\r\n *\r\n * @method Phaser.GameObjects.Group#setHitArea\r\n * @since 3.21.0\r\n *\r\n * @param {*} hitArea - 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.\r\n * @param {Phaser.Types.Input.HitAreaCallback} hitAreaCallback - A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1625, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "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": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#setHitArea", "scope": "instance", "___id": "T000002R011692", "___s": true }, { "comment": "/**\r\n * Shuffles the group members in place.\r\n *\r\n * @method Phaser.GameObjects.Group#shuffle\r\n * @since 3.21.0\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1643, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Shuffles the group members in place.", "kind": "function", "name": "shuffle", "since": "3.21.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#shuffle", "scope": "instance", "___id": "T000002R011694", "___s": true }, { "comment": "/**\r\n * Deactivates a member of this group.\r\n *\r\n * @method Phaser.GameObjects.Group#kill\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A member of this group.\r\n */", "meta": { "filename": "Group.js", "lineno": 1658, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Deactivates a member of this group.", "kind": "function", "name": "kill", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A member of this group.", "name": "gameObject" } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#kill", "scope": "instance", "___id": "T000002R011696", "___s": true }, { "comment": "/**\r\n * Deactivates and hides a member of this group.\r\n *\r\n * @method Phaser.GameObjects.Group#killAndHide\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - A member of this group.\r\n */", "meta": { "filename": "Group.js", "lineno": 1674, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Deactivates and hides a member of this group.", "kind": "function", "name": "killAndHide", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A member of this group.", "name": "gameObject" } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#killAndHide", "scope": "instance", "___id": "T000002R011698", "___s": true }, { "comment": "/**\r\n * Sets the visibility of each group member.\r\n *\r\n * @method Phaser.GameObjects.Group#setVisible\r\n * @since 3.21.0\r\n *\r\n * @param {boolean} value - The value to set the property to.\r\n * @param {number} [index=0] - An optional offset to start searching from within the items array.\r\n * @param {number} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1691, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Sets the visibility of each group member.", "kind": "function", "name": "setVisible", "since": "3.21.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The value to set the property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional offset to start searching from within the items array.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#setVisible", "scope": "instance", "___id": "T000002R011700", "___s": true }, { "comment": "/**\r\n * Toggles (flips) the visible state of each member of this group.\r\n *\r\n * @method Phaser.GameObjects.Group#toggleVisible\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Group object.\r\n */", "meta": { "filename": "Group.js", "lineno": 1710, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Toggles (flips) the visible state of each member of this group.", "kind": "function", "name": "toggleVisible", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Group object." } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#toggleVisible", "scope": "instance", "___id": "T000002R011702", "___s": true }, { "comment": "/**\r\n * Empties this Group of all children and removes it from the Scene.\r\n *\r\n * Does not call {@link Phaser.GameObjects.Group#removeCallback}.\r\n *\r\n * Children of this Group will _not_ be removed from the Scene by calling this method\r\n * unless you specify the `removeFromScene` parameter.\r\n *\r\n * Children of this Group will also _not_ be destroyed by calling this method\r\n * unless you specify the `destroyChildren` parameter.\r\n *\r\n * @method Phaser.GameObjects.Group#destroy\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [destroyChildren=false] - Also {@link Phaser.GameObjects.GameObject#destroy} each Group member.\r\n * @param {boolean} [removeFromScene=false] - Optionally remove each Group member from the Scene.\r\n */", "meta": { "filename": "Group.js", "lineno": 1725, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Empties this Group of all children and removes it from the Scene.\r\rDoes not call {@link Phaser.GameObjects.Group#removeCallback}.\r\rChildren of this Group will _not_ be removed from the Scene by calling this method\runless you specify the `removeFromScene` parameter.\r\rChildren of this Group will also _not_ be destroyed by calling this method\runless you specify the `destroyChildren` parameter.", "kind": "function", "name": "destroy", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Also {@link Phaser.GameObjects.GameObject#destroy} each Group member.", "name": "destroyChildren" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Optionally remove each Group member from the Scene.", "name": "removeFromScene" } ], "memberof": "Phaser.GameObjects.Group", "longname": "Phaser.GameObjects.Group#destroy", "scope": "instance", "overrides": "Phaser.Events.EventEmitter#destroy", "___id": "T000002R011704", "___s": true }, { "comment": "/**\r\n * Creates a new Group Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Group Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#group\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Group.GroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig} config - The configuration object this Game Object will use to create itself.\r\n *\r\n * @return {Phaser.GameObjects.Group} The Game Object that was created.\r\n */", "meta": { "filename": "GroupCreator.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Creates a new Group Game Object and returns it.\r\rNote: 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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupConfig" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Group" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#group", "scope": "instance", "___id": "T000002R011713", "___s": true }, { "comment": "/**\r\n * Creates a new Group Game Object and adds it to the Scene.\r\n *\r\n * A Group is a way of grouping together Game Objects so they can be managed as a single unit.\r\n * Groups have no position or visual representation of their own; they are purely an organizational\r\n * tool. A common use-case is object pooling: pre-creating a fixed set of identical Game Objects\r\n * and recycling them rather than creating and destroying them at runtime. Groups can also apply\r\n * bulk operations (such as setting visibility or enabling physics) to all of their members at once.\r\n *\r\n * Note: This method will only be available if the Group Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#group\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject[]|Phaser.Types.GameObjects.Group.GroupConfig|Phaser.Types.GameObjects.Group.GroupConfig[]|Phaser.Types.GameObjects.Group.GroupCreateConfig)} [children] - Game Objects to add to this Group; or the `config` argument.\r\n * @param {Phaser.Types.GameObjects.Group.GroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig} [config] - A Group Configuration object.\r\n *\r\n * @return {Phaser.GameObjects.Group} The Game Object that was created.\r\n */", "meta": { "filename": "GroupFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group", "code": {} }, "description": "Creates a new Group Game Object and adds it to the Scene.\r\rA Group is a way of grouping together Game Objects so they can be managed as a single unit.\rGroups have no position or visual representation of their own; they are purely an organizational\rtool. A common use-case is object pooling: pre-creating a fixed set of identical Game Objects\rand recycling them rather than creating and destroying them at runtime. Groups can also apply\rbulk operations (such as setting visibility or enabling physics) to all of their members at once.\r\rNote: 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.", "Phaser.Types.GameObjects.Group.GroupCreateConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.GameObjects.Group.GroupConfig", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupConfig" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupCreateConfig" } ] } }, "optional": true, "description": "A Group Configuration object.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Group" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Group" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#group", "scope": "instance", "___id": "T000002R011716", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.GameObjects.Group.GroupCallback\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} item - A group member\r\n */", "meta": { "filename": "GroupCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group\\typedefs", "code": {} }, "kind": "typedef", "name": "GroupCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "A group member", "name": "item" } ], "memberof": "Phaser.Types.GameObjects.Group", "longname": "Phaser.Types.GameObjects.Group.GroupCallback", "scope": "static", "___id": "T000002R011717", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.GameObjects.Group.GroupClassTypeConstructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n */", "meta": { "filename": "GroupClassTypeConstructor.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group\\typedefs", "code": {} }, "kind": "typedef", "name": "GroupClassTypeConstructor", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "memberof": "Phaser.Types.GameObjects.Group", "longname": "Phaser.Types.GameObjects.Group.GroupClassTypeConstructor", "scope": "static", "___id": "T000002R011718", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Group.GroupConfig\r\n * @since 3.0.0\r\n *\r\n * @property {?Function} [classType=Sprite] - Sets {@link Phaser.GameObjects.Group#classType}.\r\n * @property {?string} [name=''] - Sets {@link Phaser.GameObjects.Group#name}.\r\n * @property {?boolean} [active=true] - Sets {@link Phaser.GameObjects.Group#active}.\r\n * @property {?number} [maxSize=-1] - Sets {@link Phaser.GameObjects.Group#maxSize}.\r\n * @property {?string} [defaultKey=null] - Sets {@link Phaser.GameObjects.Group#defaultKey}.\r\n * @property {?(string|number)} [defaultFrame=null] - Sets {@link Phaser.GameObjects.Group#defaultFrame}.\r\n * @property {?boolean} [runChildUpdate=false] - Sets {@link Phaser.GameObjects.Group#runChildUpdate}.\r\n * @property {?Phaser.Types.GameObjects.Group.GroupCallback} [createCallback=null] - Sets {@link Phaser.GameObjects.Group#createCallback}.\r\n * @property {?Phaser.Types.GameObjects.Group.GroupCallback} [removeCallback=null] - Sets {@link Phaser.GameObjects.Group#removeCallback}.\r\n * @property {?Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback} [createMultipleCallback=null] - Sets {@link Phaser.GameObjects.Group#createMultipleCallback}.\r\n */", "meta": { "filename": "GroupConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group\\typedefs", "code": {} }, "kind": "typedef", "name": "GroupConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [], "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": "Sprite", "description": "Sets {@link Phaser.GameObjects.Group#classType}.", "name": "classType" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": "''", "description": "Sets {@link Phaser.GameObjects.Group#name}.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": true, "description": "Sets {@link Phaser.GameObjects.Group#active}.", "name": "active" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": -1, "description": "Sets {@link Phaser.GameObjects.Group#maxSize}.", "name": "maxSize" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": null, "description": "Sets {@link Phaser.GameObjects.Group#defaultKey}.", "name": "defaultKey" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ], "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": null, "description": "Sets {@link Phaser.GameObjects.Group#defaultFrame}.", "name": "defaultFrame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": false, "description": "Sets {@link Phaser.GameObjects.Group#runChildUpdate}.", "name": "runChildUpdate" }, { "type": { "names": [ "Phaser.Types.GameObjects.Group.GroupCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupCallback", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": null, "description": "Sets {@link Phaser.GameObjects.Group#createCallback}.", "name": "createCallback" }, { "type": { "names": [ "Phaser.Types.GameObjects.Group.GroupCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupCallback", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": null, "description": "Sets {@link Phaser.GameObjects.Group#removeCallback}.", "name": "removeCallback" }, { "type": { "names": [ "Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback", "nullable": true } }, "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", "___id": "T000002R011719", "___s": true }, { "comment": "/**\r\n * The total number of objects created will be\r\n *\r\n * key.length * frame.length * frameQuantity * (yoyo ? 2 : 1) * (1 + repeat)\r\n *\r\n * If `max` is nonzero, then the total created will not exceed `max`.\r\n *\r\n * `key` is required. {@link Phaser.GameObjects.Group#defaultKey} is not used.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.Group.GroupCreateConfig\r\n * @since 3.0.0\r\n *\r\n * @property {(string|string[])} key - The texture key of each new Game Object. Must be provided or not objects will be created.\r\n * @property {?Function} [classType] - The class of each new Game Object.\r\n * @property {?(string|string[]|number|number[])} [frame=null] - The texture frame of each new Game Object.\r\n * @property {?number} [quantity=false] - The number of Game Objects to create. If set, this overrides the `frameQuantity` value. Use `frameQuantity` for more advanced control.\r\n * @property {?boolean} [visible=true] - The visible state of each new Game Object.\r\n * @property {?boolean} [active=true] - The active state of each new Game Object.\r\n * @property {?number} [repeat=0] - The number of times each `key` × `frame` combination will be *repeated* (after the first combination).\r\n * @property {?boolean} [randomKey=false] - Select a `key` at random.\r\n * @property {?boolean} [randomFrame=false] - Select a `frame` at random.\r\n * @property {?boolean} [yoyo=false] - Select keys and frames by moving forward then backward through `key` and `frame`.\r\n * @property {?number} [frameQuantity=1] - The number of times each `frame` should be combined with one `key`.\r\n * @property {?number} [max=0] - The maximum number of new Game Objects to create. 0 is no maximum.\r\n * @property {?object} [setXY] - Options as named in {@link Phaser.Actions.SetXY}.\r\n * @property {?object} [setRotation] - Options as named in {@link Phaser.Actions.SetRotation}.\r\n * @property {?object} [setScale] - Options as named in {@link Phaser.Actions.SetScale}.\r\n * @property {?object} [setOrigin] - Options as named in {@link Phaser.Actions.SetOrigin}.\r\n * @property {?object} [setAlpha] - Options as named in {@link Phaser.Actions.SetAlpha}.\r\n * @property {?object} [setDepth] - Options as named in {@link Phaser.Actions.SetDepth}.\r\n * @property {?object} [setScrollFactor] - Options as named in {@link Phaser.Actions.SetScrollFactor}.\r\n * @property {?*} [hitArea] - A geometric shape that defines the hit area for the Game Object.\r\n * @property {?Phaser.Types.Input.HitAreaCallback} [hitAreaCallback] - A callback to be invoked when the Game Object is interacted with.\r\n * @property {?(false|Phaser.Types.Actions.GridAlignConfig)} [gridAlign=false] - Align the new Game Objects in a grid using these settings.\r\n *\r\n * @see Phaser.GameObjects.Group#createFromConfig\r\n * @see Phaser.Utils.Array.Range\r\n */", "meta": { "filename": "GroupCreateConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group\\typedefs", "code": {} }, "description": "The total number of objects created will be\r\r key.length * frame.length * frameQuantity * (yoyo ? 2 : 1) * (1 + repeat)\r\rIf `max` is nonzero, then the total created will not exceed `max`.\r\r`key` is required. {@link Phaser.GameObjects.Group#defaultKey} is not used.", "kind": "typedef", "name": "GroupCreateConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "description": "The texture key of each new Game Object. Must be provided or not objects will be created.", "name": "key" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [], "nullable": true } }, "optional": true, "nullable": true, "description": "The class of each new Game Object.", "name": "classType" }, { "type": { "names": [ "string", "Array.", "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ], "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": null, "description": "The texture frame of each new Game Object.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": true, "description": "The visible state of each new Game Object.", "name": "visible" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": true, "description": "The active state of each new Game Object.", "name": "active" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": false, "description": "Select a `key` at random.", "name": "randomKey" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": false, "description": "Select a `frame` at random.", "name": "randomFrame" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": false, "description": "Select keys and frames by moving forward then backward through `key` and `frame`.", "name": "yoyo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": 1, "description": "The number of times each `frame` should be combined with one `key`.", "name": "frameQuantity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number", "nullable": true } }, "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" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "optional": true, "nullable": true, "description": "Options as named in {@link Phaser.Actions.SetXY}.", "name": "setXY" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "optional": true, "nullable": true, "description": "Options as named in {@link Phaser.Actions.SetRotation}.", "name": "setRotation" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "optional": true, "nullable": true, "description": "Options as named in {@link Phaser.Actions.SetScale}.", "name": "setScale" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "optional": true, "nullable": true, "description": "Options as named in {@link Phaser.Actions.SetOrigin}.", "name": "setOrigin" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "optional": true, "nullable": true, "description": "Options as named in {@link Phaser.Actions.SetAlpha}.", "name": "setAlpha" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "optional": true, "nullable": true, "description": "Options as named in {@link Phaser.Actions.SetDepth}.", "name": "setDepth" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object", "nullable": true } }, "optional": true, "nullable": true, "description": "Options as named in {@link Phaser.Actions.SetScrollFactor}.", "name": "setScrollFactor" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "nullable": true } }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.HitAreaCallback", "nullable": true } }, "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "false", "reservedWord": true }, { "type": "NameExpression", "name": "Phaser.Types.Actions.GridAlignConfig" } ], "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": false, "description": "Align the new Game Objects in a grid using these settings.", "name": "gridAlign" } ], "see": [ "Phaser.GameObjects.Group#createFromConfig", "Phaser.Utils.Array.Range" ], "memberof": "Phaser.Types.GameObjects.Group", "longname": "Phaser.Types.GameObjects.Group.GroupCreateConfig", "scope": "static", "___id": "T000002R011720", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject[]} items - The newly created group members\r\n */", "meta": { "filename": "GroupMultipleCreateCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group\\typedefs", "code": {} }, "kind": "typedef", "name": "GroupMultipleCreateCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "The newly created group members", "name": "items" } ], "memberof": "Phaser.Types.GameObjects.Group", "longname": "Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback", "scope": "static", "___id": "T000002R011721", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Group\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\group\\typedefs", "code": {} }, "kind": "namespace", "name": "Group", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Group", "scope": "static", "___id": "T000002R011722", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An Image Game Object.\r\n *\r\n * An Image is a light-weight Game Object useful for the display of static images in your game,\r\n * such as logos, backgrounds, scenery or other non-animated elements. Images can have input\r\n * events and physics bodies, or be tweened, tinted or scrolled. The main difference between an\r\n * Image and a Sprite is that you cannot animate an Image as they do not have the Animation component.\r\n *\r\n * @class Image\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.GameObjects.Components.Alpha\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Flip\r\n * @extends Phaser.GameObjects.Components.GetBounds\r\n * @extends Phaser.GameObjects.Components.Lighting\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Size\r\n * @extends Phaser.GameObjects.Components.TextureCrop\r\n * @extends Phaser.GameObjects.Components.Tint\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n */", "meta": { "filename": "Image.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\image", "code": {} }, "classdesc": "An Image Game Object.\r\rAn Image is a light-weight Game Object useful for the display of static images in your game,\rsuch as logos, backgrounds, scenery or other non-animated elements. Images can have input\revents and physics bodies, or be tweened, tinted or scrolled. The main difference between an\rImage 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.Lighting", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.RenderNodes", "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "scope": "static", "longname": "Phaser.GameObjects.Image", "___id": "T000002R011728", "___s": true }, { "comment": "/**\r\n * Creates a new Image Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Image Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#image\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.GameObjectConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Image} The Game Object that was created.\r\n */", "meta": { "filename": "ImageCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\image", "code": {} }, "description": "Creates a new Image Game Object and returns it.\r\rNote: 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": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.GameObjectConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Image" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#image", "scope": "instance", "___id": "T000002R011746", "___s": true }, { "comment": "/**\r\n * Creates a new Image Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Image Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#image\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.GameObjects.Image} The Game Object that was created.\r\n */", "meta": { "filename": "ImageFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\image", "code": {} }, "description": "Creates a new Image Game Object and adds it to the Scene.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Image" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Image" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#image", "scope": "instance", "___id": "T000002R011754", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.GameObjects\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "kind": "namespace", "name": "GameObjects", "memberof": "Phaser", "longname": "Phaser.GameObjects", "scope": "static", "___id": "T000002R011768", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Layer Game Object.\r\n *\r\n * A Layer is a special type of Game Object that acts as a Display List. You can add any type of Game Object\r\n * to a Layer, just as you would to a Scene. Layers can be used to visually group together 'layers' of Game\r\n * Objects:\r\n *\r\n * ```javascript\r\n * const spaceman = this.add.sprite(150, 300, 'spaceman');\r\n * const bunny = this.add.sprite(400, 300, 'bunny');\r\n * const elephant = this.add.sprite(650, 300, 'elephant');\r\n *\r\n * const layer = this.add.layer();\r\n *\r\n * layer.add([ spaceman, bunny, elephant ]);\r\n * ```\r\n *\r\n * The 3 sprites in the example above will now be managed by the Layer they were added to. Therefore,\r\n * if you then set `layer.setVisible(false)` they would all vanish from the display.\r\n *\r\n * You can also control the depth of the Game Objects within the Layer. For example, calling the\r\n * `setDepth` method of a child of a Layer will allow you to adjust the depth of that child _within the\r\n * Layer itself_, rather than the whole Scene. The Layer, too, can have its depth set as well.\r\n *\r\n * The Layer class also offers many different methods for manipulating the list, such as the\r\n * methods `moveUp`, `moveDown`, `sendToBack`, `bringToTop` and so on. These allow you to change the\r\n * display list position of the Layers children, causing it to adjust the order in which they are\r\n * rendered. Using `setDepth` on a child allows you to override this.\r\n *\r\n * Layers have no position or size within the Scene. This means you cannot enable a Layer for\r\n * physics or input, or change the position, rotation or scale of a Layer. They also have no scroll\r\n * factor, texture, tint, origin, crop or bounds.\r\n *\r\n * If you need those kind of features then you should use a Container instead. Containers can be added\r\n * to Layers, but Layers cannot be added to Containers.\r\n *\r\n * However, you can set the Alpha, Blend Mode, Depth, Mask and Visible state of a Layer. These settings\r\n * will impact all children being rendered by the Layer.\r\n *\r\n * Layers should always be the topmost elements of any scene hierarchy.\r\n * They can be children of layers, but not of anything else.\r\n *\r\n * Until Phaser version 4.1.0, Layer was not a true GameObject.\r\n * It is now a true GameObject.\r\n *\r\n * @class Layer\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @extends Phaser.GameObjects.Components.AlphaSingle\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {Phaser.GameObjects.GameObject[]} [children] - An optional array of Game Objects to add to this Layer.\r\n */", "meta": { "filename": "Layer.js", "lineno": 18, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "classdesc": "A Layer Game Object.\r\rA Layer is a special type of Game Object that acts as a Display List. You can add any type of Game Object\rto a Layer, just as you would to a Scene. Layers can be used to visually group together 'layers' of Game\rObjects:\r\r```javascript\rconst spaceman = this.add.sprite(150, 300, 'spaceman');\rconst bunny = this.add.sprite(400, 300, 'bunny');\rconst elephant = this.add.sprite(650, 300, 'elephant');\r\rconst layer = this.add.layer();\r\rlayer.add([ spaceman, bunny, elephant ]);\r```\r\rThe 3 sprites in the example above will now be managed by the Layer they were added to. Therefore,\rif you then set `layer.setVisible(false)` they would all vanish from the display.\r\rYou can also control the depth of the Game Objects within the Layer. For example, calling the\r`setDepth` method of a child of a Layer will allow you to adjust the depth of that child _within the\rLayer itself_, rather than the whole Scene. The Layer, too, can have its depth set as well.\r\rThe Layer class also offers many different methods for manipulating the list, such as the\rmethods `moveUp`, `moveDown`, `sendToBack`, `bringToTop` and so on. These allow you to change the\rdisplay list position of the Layers children, causing it to adjust the order in which they are\rrendered. Using `setDepth` on a child allows you to override this.\r\rLayers have no position or size within the Scene. This means you cannot enable a Layer for\rphysics or input, or change the position, rotation or scale of a Layer. They also have no scroll\rfactor, texture, tint, origin, crop or bounds.\r\rIf you need those kind of features then you should use a Container instead. Containers can be added\rto Layers, but Layers cannot be added to Containers.\r\rHowever, you can set the Alpha, Blend Mode, Depth, Mask and Visible state of a Layer. These settings\rwill impact all children being rendered by the Layer.\r\rLayers should always be the topmost elements of any scene hierarchy.\rThey can be children of layers, but not of anything else.\r\rUntil Phaser version 4.1.0, Layer was not a true GameObject.\rIt is now a true GameObject.", "kind": "class", "name": "Layer", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.AlphaSingle", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.GameObjects", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "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": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of Game Objects to add to this Layer.", "name": "children" } ], "scope": "static", "longname": "Phaser.GameObjects.Layer", "___id": "T000002R011929", "___s": true }, { "comment": "/**\r\n * A reference to the Scene to which this Game Object belongs.\r\n *\r\n * Game Objects can only belong to one Scene.\r\n *\r\n * You should consider this property as being read-only. You cannot move a\r\n * Game Object to another Scene by simply changing it.\r\n *\r\n * @name Phaser.GameObjects.Layer#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "A reference to the Scene to which this Game Object belongs.\r\rGame Objects can only belong to one Scene.\r\rYou should consider this property as being read-only. You cannot move a\rGame Object to another Scene by simply changing it.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#scene", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.GameObject#scene", "___id": "T000002R011934", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Systems.\r\n *\r\n * @name Phaser.GameObjects.Layer#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "A reference to the Scene Systems.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#systems", "scope": "instance", "kind": "member", "___id": "T000002R011936", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Event Emitter.\r\n *\r\n * @name Phaser.GameObjects.Layer#events\r\n * @type {Phaser.Events.EventEmitter}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "A reference to the Scene Event Emitter.", "name": "events", "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#events", "scope": "instance", "kind": "member", "___id": "T000002R011938", "___s": true }, { "comment": "/**\r\n * The flag that determines whether Game Objects should be sorted when `depthSort()` is called.\r\n *\r\n * @name Phaser.GameObjects.Layer#sortChildrenFlag\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 134, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "The flag that determines whether Game Objects should be sorted when `depthSort()` is called.", "name": "sortChildrenFlag", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.50.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#sortChildrenFlag", "scope": "instance", "kind": "member", "___id": "T000002R011940", "___s": true }, { "comment": "/**\r\n * A Layer cannot be enabled for input.\r\n *\r\n * This method does nothing and is kept to ensure\r\n * the Layer has the same shape as a Game Object.\r\n *\r\n * @method Phaser.GameObjects.Layer#setInteractive\r\n * @since 3.51.0\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "Layer.js", "lineno": 161, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "A Layer cannot be enabled for input.\r\rThis method does nothing and is kept to ensure\rthe Layer has the same shape as a Game Object.", "kind": "function", "name": "setInteractive", "since": "3.51.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#setInteractive", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#setInteractive", "___id": "T000002R011944", "___s": true }, { "comment": "/**\r\n * A Layer cannot be enabled for input.\r\n *\r\n * This method does nothing and is kept to ensure\r\n * the Layer has the same shape as a Game Object.\r\n *\r\n * @method Phaser.GameObjects.Layer#disableInteractive\r\n * @since 3.51.0\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "Layer.js", "lineno": 177, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "A Layer cannot be enabled for input.\r\rThis method does nothing and is kept to ensure\rthe Layer has the same shape as a Game Object.", "kind": "function", "name": "disableInteractive", "since": "3.51.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#disableInteractive", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#disableInteractive", "___id": "T000002R011946", "___s": true }, { "comment": "/**\r\n * A Layer cannot be enabled for input.\r\n *\r\n * This method does nothing and is kept to ensure\r\n * the Layer has the same shape as a Game Object.\r\n *\r\n * @method Phaser.GameObjects.Layer#removeInteractive\r\n * @since 3.51.0\r\n *\r\n * @return {this} This GameObject.\r\n */", "meta": { "filename": "Layer.js", "lineno": 193, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "A Layer cannot be enabled for input.\r\rThis method does nothing and is kept to ensure\rthe Layer has the same shape as a Game Object.", "kind": "function", "name": "removeInteractive", "since": "3.51.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This GameObject." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#removeInteractive", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#removeInteractive", "___id": "T000002R011948", "___s": true }, { "comment": "/**\r\n * Compares the renderMask with the renderFlags to see if this Game Object will render or not.\r\n * Also checks the Game Object against the given Cameras exclusion list.\r\n *\r\n * @method Phaser.GameObjects.Layer#willRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to check against this Game Object.\r\n *\r\n * @return {boolean} True if the Game Object should be rendered, otherwise false.\r\n */", "meta": { "filename": "Layer.js", "lineno": 209, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Compares the renderMask with the renderFlags to see if this Game Object will render or not.\rAlso checks the Game Object against the given Cameras exclusion list.", "kind": "function", "name": "willRender", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to check against this Game Object.", "name": "camera" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#willRender", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#willRender", "___id": "T000002R011950", "___s": true }, { "comment": "/**\r\n * Force a sort of the display list on the next call to depthSort.\r\n *\r\n * @method Phaser.GameObjects.Layer#queueDepthSort\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 279, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Force a sort of the display list on the next call to depthSort.", "kind": "function", "name": "queueDepthSort", "since": "3.50.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#queueDepthSort", "scope": "instance", "___id": "T000002R011959", "___s": true }, { "comment": "/**\r\n * Immediately sorts the display list if the flag is set.\r\n *\r\n * @method Phaser.GameObjects.Layer#depthSort\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 290, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Immediately sorts the display list if the flag is set.", "kind": "function", "name": "depthSort", "since": "3.50.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#depthSort", "scope": "instance", "___id": "T000002R011962", "___s": true }, { "comment": "/**\r\n * Compare the depth of two Game Objects.\r\n *\r\n * @method Phaser.GameObjects.Layer#sortByDepth\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} childA - The first Game Object.\r\n * @param {Phaser.GameObjects.GameObject} childB - The second Game Object.\r\n *\r\n * @return {number} The difference between the depths of each Game Object.\r\n */", "meta": { "filename": "Layer.js", "lineno": 306, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Compare the depth of two Game Objects.", "kind": "function", "name": "sortByDepth", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The first Game Object.", "name": "childA" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The second Game Object.", "name": "childB" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The difference between the depths of each Game Object." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#sortByDepth", "scope": "instance", "___id": "T000002R011965", "___s": true }, { "comment": "/**\r\n * Returns a reference to the array which contains all Game Objects in this Layer.\r\n *\r\n * This is a reference, not a copy of it, so be very careful not to mutate it.\r\n *\r\n * @method Phaser.GameObjects.Layer#getChildren\r\n * @since 3.50.0\r\n *\r\n * @return {Phaser.GameObjects.GameObject[]} An array of Game Objects within this Layer.\r\n */", "meta": { "filename": "Layer.js", "lineno": 322, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Returns a reference to the array which contains all Game Objects in this Layer.\r\rThis is a reference, not a copy of it, so be very careful not to mutate it.", "kind": "function", "name": "getChildren", "since": "3.50.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "An array of Game Objects within this Layer." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#getChildren", "scope": "instance", "___id": "T000002R011967", "___s": true }, { "comment": "/**\r\n * Return an array listing the events for which the emitter has registered listeners.\r\n *\r\n * @method Phaser.GameObjects.Layer#eventNames\r\n * @since 3.50.0\r\n *\r\n * @return {Array.}\r\n */", "meta": { "filename": "Layer.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Return an array listing the events for which the emitter has registered listeners.", "kind": "function", "name": "eventNames", "since": "3.50.0", "returns": [ { "type": { "names": [ "Array.<(string|symbol)>" ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } ] } } } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#eventNames", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#eventNames", "___id": "T000002R011969", "___s": true }, { "comment": "/**\r\n * Return the listeners registered for a given event.\r\n *\r\n * @method Phaser.GameObjects.Layer#listeners\r\n * @since 3.50.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n *\r\n * @return {Function[]} The registered listeners.\r\n */", "meta": { "filename": "Layer.js", "lineno": 346, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Return the listeners registered for a given event.", "kind": "function", "name": "listeners", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "FunctionType", "params": [] } ] } }, "description": "The registered listeners." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#listeners", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#listeners", "___id": "T000002R011970", "___s": true }, { "comment": "/**\r\n * Return the number of listeners listening to a given event.\r\n *\r\n * @method Phaser.GameObjects.Layer#listenerCount\r\n * @since 3.50.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n *\r\n * @return {number} The number of listeners.\r\n */", "meta": { "filename": "Layer.js", "lineno": 357, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Return the number of listeners listening to a given event.", "kind": "function", "name": "listenerCount", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of listeners." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#listenerCount", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#listenerCount", "___id": "T000002R011971", "___s": true }, { "comment": "/**\r\n * Calls each of the listeners registered for a given event.\r\n *\r\n * @method Phaser.GameObjects.Layer#emit\r\n * @since 3.50.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n * @param {...*} [args] - Additional arguments that will be passed to the event handler.\r\n *\r\n * @return {boolean} `true` if the event had listeners, else `false`.\r\n */", "meta": { "filename": "Layer.js", "lineno": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Calls each of the listeners registered for a given event.", "kind": "function", "name": "emit", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "repeatable": true } }, "optional": true, "variable": true, "description": "Additional arguments that will be passed to the event handler.", "name": "args" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#emit", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#emit", "___id": "T000002R011972", "___s": true }, { "comment": "/**\r\n * Add a listener for a given event.\r\n *\r\n * @method Phaser.GameObjects.Layer#on\r\n * @since 3.50.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n * @param {function} fn - The listener function.\r\n * @param {*} [context=this] - The context to invoke the listener with.\r\n *\r\n * @return {this} This Layer instance.\r\n */", "meta": { "filename": "Layer.js", "lineno": 380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Add a listener for a given event.", "kind": "function", "name": "on", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The listener function.", "name": "fn" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "defaultvalue": "this", "description": "The context to invoke the listener with.", "name": "context" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Layer instance." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#on", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#on", "___id": "T000002R011973", "___s": true }, { "comment": "/**\r\n * Add a listener for a given event.\r\n *\r\n * @method Phaser.GameObjects.Layer#addListener\r\n * @since 3.50.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n * @param {function} fn - The listener function.\r\n * @param {*} [context=this] - The context to invoke the listener with.\r\n *\r\n * @return {this} This Layer instance.\r\n */", "meta": { "filename": "Layer.js", "lineno": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Add a listener for a given event.", "kind": "function", "name": "addListener", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The listener function.", "name": "fn" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "defaultvalue": "this", "description": "The context to invoke the listener with.", "name": "context" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Layer instance." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#addListener", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#addListener", "___id": "T000002R011974", "___s": true }, { "comment": "/**\r\n * Add a one-time listener for a given event.\r\n *\r\n * @method Phaser.GameObjects.Layer#once\r\n * @since 3.50.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n * @param {function} fn - The listener function.\r\n * @param {*} [context=this] - The context to invoke the listener with.\r\n *\r\n * @return {this} This Layer instance.\r\n */", "meta": { "filename": "Layer.js", "lineno": 406, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Add a one-time listener for a given event.", "kind": "function", "name": "once", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The listener function.", "name": "fn" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "defaultvalue": "this", "description": "The context to invoke the listener with.", "name": "context" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Layer instance." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#once", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#once", "___id": "T000002R011975", "___s": true }, { "comment": "/**\r\n * Remove the listeners of a given event.\r\n *\r\n * @method Phaser.GameObjects.Layer#removeListener\r\n * @since 3.50.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n * @param {function} [fn] - Only remove the listeners that match this function.\r\n * @param {*} [context] - Only remove the listeners that have this context.\r\n * @param {boolean} [once] - Only remove one-time listeners.\r\n *\r\n * @return {this} This Layer instance.\r\n */", "meta": { "filename": "Layer.js", "lineno": 419, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Remove the listeners of a given event.", "kind": "function", "name": "removeListener", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "Only remove the listeners that match this function.", "name": "fn" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "Only remove the listeners that have this context.", "name": "context" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Only remove one-time listeners.", "name": "once" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Layer instance." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#removeListener", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#removeListener", "___id": "T000002R011976", "___s": true }, { "comment": "/**\r\n * Remove the listeners of a given event.\r\n *\r\n * @method Phaser.GameObjects.Layer#off\r\n * @since 3.50.0\r\n *\r\n * @param {(string|symbol)} event - The event name.\r\n * @param {function} [fn] - Only remove the listeners that match this function.\r\n * @param {*} [context] - Only remove the listeners that have this context.\r\n * @param {boolean} [once] - Only remove one-time listeners.\r\n *\r\n * @return {this} This Layer instance.\r\n */", "meta": { "filename": "Layer.js", "lineno": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Remove the listeners of a given event.", "kind": "function", "name": "off", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "description": "The event name.", "name": "event" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "Only remove the listeners that match this function.", "name": "fn" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "Only remove the listeners that have this context.", "name": "context" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Only remove one-time listeners.", "name": "once" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Layer instance." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#off", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#off", "___id": "T000002R011977", "___s": true }, { "comment": "/**\r\n * Remove all listeners, or those of the specified event.\r\n *\r\n * @method Phaser.GameObjects.Layer#removeAllListeners\r\n * @since 3.50.0\r\n *\r\n * @param {(string|symbol)} [event] - The event name.\r\n *\r\n * @return {this} This Layer instance.\r\n */", "meta": { "filename": "Layer.js", "lineno": 447, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Remove all listeners, or those of the specified event.", "kind": "function", "name": "removeAllListeners", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "symbol" } ] } }, "optional": true, "description": "The event name.", "name": "event" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Layer instance." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#removeAllListeners", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#removeAllListeners", "___id": "T000002R011978", "___s": true }, { "comment": "/**\r\n * The parent of this list.\r\n *\r\n * @name Phaser.GameObjects.Layer#parent\r\n * @type {*}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 462, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "The parent of this list.", "name": "parent", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#parent", "scope": "instance", "kind": "member", "___id": "T000002R011979", "___s": true }, { "comment": "/**\r\n * The objects that belong to this collection.\r\n *\r\n * @name Phaser.GameObjects.Layer#list\r\n * @type {Array.}\r\n * @default []\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 470, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "The objects that belong to this collection.", "name": "list", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#list", "scope": "instance", "kind": "member", "___id": "T000002R011980", "___s": true }, { "comment": "/**\r\n * The index of the current element.\r\n *\r\n * This is used internally when iterating through the list with the {@link #first}, {@link #last}, {@link #next}, and {@link #previous} properties.\r\n *\r\n * @name Phaser.GameObjects.Layer#position\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 479, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "The index of the current element.\r\rThis is used internally when iterating through the list with the {@link #first}, {@link #last}, {@link #next}, and {@link #previous} properties.", "name": "position", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#position", "scope": "instance", "kind": "member", "___id": "T000002R011981", "___s": true }, { "comment": "/**\r\n * A callback that is invoked every time a child is added to this list.\r\n *\r\n * @name Phaser.GameObjects.Layer#addCallback\r\n * @type {function}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 490, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "A callback that is invoked every time a child is added to this list.", "name": "addCallback", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#addCallback", "scope": "instance", "kind": "member", "___id": "T000002R011982", "___s": true }, { "comment": "/**\r\n * A callback that is invoked every time a child is removed from this list.\r\n *\r\n * @name Phaser.GameObjects.Layer#removeCallback\r\n * @type {function}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 498, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "A callback that is invoked every time a child is removed from this list.", "name": "removeCallback", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#removeCallback", "scope": "instance", "kind": "member", "___id": "T000002R011983", "___s": true }, { "comment": "/**\r\n * The property key to sort by.\r\n *\r\n * @name Phaser.GameObjects.Layer#_sortKey\r\n * @type {string}\r\n * @since 3.4.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 506, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "The property key to sort by.", "name": "_sortKey", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.4.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#_sortKey", "scope": "instance", "kind": "member", "___id": "T000002R011984", "___s": true }, { "comment": "/**\r\n * Adds the given item to the end of the list. Each item must be unique.\r\n *\r\n * @method Phaser.GameObjects.Layer#add\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject|Array.} child - The item, or array of items, to add to the list.\r\n * @param {boolean} [skipCallback=false] - Skip calling the List.addCallback if this child is added successfully.\r\n *\r\n * @return {*} The list's underlying array.\r\n */", "meta": { "filename": "Layer.js", "lineno": 514, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "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": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } ] } }, "description": "The item, or array of items, to add to the list.", "name": "child" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip calling the List.addCallback if this child is added successfully.", "name": "skipCallback" } ], "returns": [ { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The list's underlying array." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#add", "scope": "instance", "___id": "T000002R011985", "___s": true }, { "comment": "/**\r\n * Adds an item to list, starting at a specified index. Each item must be unique within the list.\r\n *\r\n * @method Phaser.GameObjects.Layer#addAt\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject|Array.} child - The item, or array of items, to add to the list.\r\n * @param {number} [index=0] - The index in the list at which the element(s) will be inserted.\r\n * @param {boolean} [skipCallback=false] - Skip calling the List.addCallback if this child is added successfully.\r\n *\r\n * @return {Array.} The List's underlying array.\r\n */", "meta": { "filename": "Layer.js", "lineno": 526, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "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": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } ] } }, "description": "The item, or array of items, to add to the list.", "name": "child" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The index in the list at which the element(s) will be inserted.", "name": "index" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip calling the List.addCallback if this child is added successfully.", "name": "skipCallback" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "description": "The List's underlying array." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#addAt", "scope": "instance", "___id": "T000002R011986", "___s": true }, { "comment": "/**\r\n * Retrieves the item at a given position inside the List.\r\n *\r\n * @method Phaser.GameObjects.Layer#getAt\r\n * @since 3.0.0\r\n *\r\n * @param {number} index - The index of the item.\r\n *\r\n * @return {Phaser.GameObjects.GameObject|undefined} The retrieved item, or `undefined` if it's outside the List's bounds.\r\n */", "meta": { "filename": "Layer.js", "lineno": 539, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Retrieves the item at a given position inside the List.", "kind": "function", "name": "getAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the item.", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "UndefinedLiteral" } ] } }, "description": "The retrieved item, or `undefined` if it's outside the List's bounds." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#getAt", "scope": "instance", "___id": "T000002R011987", "___s": true }, { "comment": "/**\r\n * Locates an item within the List and returns its index.\r\n *\r\n * @method Phaser.GameObjects.Layer#getIndex\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The item to locate.\r\n *\r\n * @return {number} The index of the item within the List, or -1 if it's not in the List.\r\n */", "meta": { "filename": "Layer.js", "lineno": 550, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Locates an item within the List and returns its index.", "kind": "function", "name": "getIndex", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The item to locate.", "name": "child" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the item within the List, or -1 if it's not in the List." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#getIndex", "scope": "instance", "___id": "T000002R011988", "___s": true }, { "comment": "/**\r\n * Sort the contents of this List so the items are in order based on the given property.\r\n * For example, `sort('alpha')` would sort the List contents based on the value of their `alpha` property.\r\n *\r\n * @method Phaser.GameObjects.Layer#sort\r\n * @since 3.0.0\r\n *\r\n * @param {string} property - The property to lexically sort by.\r\n * @param {function} [handler] - Provide your own custom handler function. Will receive 2 children which it should compare and return a number (negative if the first should come before the second, positive if after, zero if equal).\r\n *\r\n * @return {Phaser.GameObjects.Layer} This List object.\r\n */", "meta": { "filename": "Layer.js", "lineno": 561, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Sort the contents of this List so the items are in order based on the given property.\rFor 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to lexically sort by.", "name": "property" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "Provide your own custom handler function. Will receive 2 children which it should compare and return a number (negative if the first should come before the second, positive if after, zero if equal).", "name": "handler" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Layer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Layer" } }, "description": "This List object." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#sort", "scope": "instance", "___id": "T000002R011989", "___s": true }, { "comment": "/**\r\n * Searches for the first instance of a child with its `name`\r\n * property matching the given argument. Should more than one child have\r\n * the same name only the first is returned.\r\n *\r\n * @method Phaser.GameObjects.Layer#getByName\r\n * @since 3.0.0\r\n *\r\n * @param {string} name - The name to search for.\r\n *\r\n * @return {?Phaser.GameObjects.GameObject} The first child with a matching name, or null if none were found.\r\n */", "meta": { "filename": "Layer.js", "lineno": 574, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Searches for the first instance of a child with its `name`\rproperty matching the given argument. Should more than one child have\rthe same name only the first is returned.", "kind": "function", "name": "getByName", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name to search for.", "name": "name" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "nullable": true, "description": "The first child with a matching name, or null if none were found." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#getByName", "scope": "instance", "___id": "T000002R011990", "___s": true }, { "comment": "/**\r\n * Returns a random child from the list.\r\n *\r\n * @method Phaser.GameObjects.Layer#getRandom\r\n * @since 3.0.0\r\n *\r\n * @param {number} [startIndex=0] - Offset from the front of the list (lowest child).\r\n * @param {number} [length=(to top)] - Restriction on the number of values you want to randomly select from.\r\n *\r\n * @return {?Phaser.GameObjects.GameObject} A random child of this List.\r\n */", "meta": { "filename": "Layer.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Returns a random child from the list.", "kind": "function", "name": "getRandom", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Offset from the front of the list (lowest child).", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "(to top)", "description": "Restriction on the number of values you want to randomly select from.", "name": "length" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "nullable": true, "description": "A random child of this List." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#getRandom", "scope": "instance", "___id": "T000002R011991", "___s": true }, { "comment": "/**\r\n * Returns the first element in a given part of the List which matches a specific criterion.\r\n *\r\n * @method Phaser.GameObjects.Layer#getFirst\r\n * @since 3.0.0\r\n *\r\n * @param {string} property - The name of the property to test or a falsey value to have no criterion.\r\n * @param {Phaser.GameObjects.GameObject|undefined} value - The value to test the `property` against, or `undefined` to allow any value and only check for existence.\r\n * @param {number} [startIndex=0] - The position in the List to start the search at.\r\n * @param {number} [endIndex] - The position in the List to optionally stop the search at. It won't be checked.\r\n *\r\n * @return {?Phaser.GameObjects.GameObject} The first item which matches the given criterion, or `null` if no such item exists.\r\n */", "meta": { "filename": "Layer.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property to test or a falsey value to have no criterion.", "name": "property" }, { "type": { "names": [ "Phaser.GameObjects.GameObject", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "UndefinedLiteral" } ] } }, "description": "The value to test the `property` against, or `undefined` to allow any value and only check for existence.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The position in the List to start the search at.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "nullable": true, "description": "The first item which matches the given criterion, or `null` if no such item exists." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#getFirst", "scope": "instance", "___id": "T000002R011992", "___s": true }, { "comment": "/**\r\n * Returns all children in this List.\r\n *\r\n * You can optionally specify a matching criteria using the `property` and `value` arguments.\r\n *\r\n * For example: `getAll('parent')` would return only children that have a property called `parent`.\r\n *\r\n * You can also specify a value to compare the property to:\r\n *\r\n * `getAll('visible', true)` would return only children that have their visible property set to `true`.\r\n *\r\n * Optionally you can specify a start and end index. For example if this List had 100 children,\r\n * and you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\r\n * the first 50 children in the List.\r\n *\r\n * @method Phaser.GameObjects.Layer#getAll\r\n * @since 3.0.0\r\n *\r\n * @param {string} [property] - An optional property to test against the value argument.\r\n * @param {any} [value] - If property is set then Child.property must strictly equal this value to be included in the results.\r\n * @param {number} [startIndex] - The first child index to start the search from.\r\n * @param {number} [endIndex] - The last child index to search up until.\r\n *\r\n * @return {Array.} All items of the List which match the given criterion, if any.\r\n */", "meta": { "filename": "Layer.js", "lineno": 613, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Returns all children in this List.\r\rYou can optionally specify a matching criteria using the `property` and `value` arguments.\r\rFor example: `getAll('parent')` would return only children that have a property called `parent`.\r\rYou can also specify a value to compare the property to:\r\r`getAll('visible', true)` would return only children that have their visible property set to `true`.\r\rOptionally you can specify a start and end index. For example if this List had 100 children,\rand you set `startIndex` to 0 and `endIndex` to 50, it would return matches from only\rthe first 50 children in the List.", "kind": "function", "name": "getAll", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "An optional property to test against the value argument.", "name": "property" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The first child index to start the search from.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The last child index to search up until.", "name": "endIndex" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "description": "All items of the List which match the given criterion, if any." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#getAll", "scope": "instance", "___id": "T000002R011993", "___s": true }, { "comment": "/**\r\n * Returns the total number of items in the List which have a property matching the given value.\r\n *\r\n * @method Phaser.GameObjects.Layer#count\r\n * @since 3.0.0\r\n *\r\n * @param {string} property - The property to test on each item.\r\n * @param {Phaser.GameObjects.GameObject} value - The value to test the property against.\r\n *\r\n * @return {number} The total number of matching elements.\r\n */", "meta": { "filename": "Layer.js", "lineno": 639, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The property to test on each item.", "name": "property" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The value to test the property against.", "name": "value" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of matching elements." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#count", "scope": "instance", "___id": "T000002R011994", "___s": true }, { "comment": "/**\r\n * Swaps the positions of two items in the list.\r\n *\r\n * @method Phaser.GameObjects.Layer#swap\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child1 - The first item to swap.\r\n * @param {Phaser.GameObjects.GameObject} child2 - The second item to swap.\r\n */", "meta": { "filename": "Layer.js", "lineno": 651, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Swaps the positions of two items in the list.", "kind": "function", "name": "swap", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The first item to swap.", "name": "child1" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The second item to swap.", "name": "child2" } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#swap", "scope": "instance", "___id": "T000002R011995", "___s": true }, { "comment": "/**\r\n * Moves an item in the List to a new position.\r\n *\r\n * @method Phaser.GameObjects.Layer#moveTo\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The item to move.\r\n * @param {number} index - The new position to move the item to.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The item that was moved.\r\n */", "meta": { "filename": "Layer.js", "lineno": 661, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Moves an item in the List to a new position.", "kind": "function", "name": "moveTo", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The item to move.", "name": "child" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new position to move the item to.", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The item that was moved." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#moveTo", "scope": "instance", "___id": "T000002R011996", "___s": true }, { "comment": "/**\r\n * Moves an item above another one in the List.\r\n * If the given item is already above the other, it isn't moved.\r\n * Above means toward the end of the List.\r\n *\r\n * @method Phaser.GameObjects.Layer#moveAbove\r\n * @since 3.55.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child1 - The element to move above base element.\r\n * @param {Phaser.GameObjects.GameObject} child2 - The base element.\r\n */", "meta": { "filename": "Layer.js", "lineno": 673, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Moves an item above another one in the List.\rIf the given item is already above the other, it isn't moved.\rAbove means toward the end of the List.", "kind": "function", "name": "moveAbove", "since": "3.55.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The element to move above base element.", "name": "child1" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The base element.", "name": "child2" } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#moveAbove", "scope": "instance", "___id": "T000002R011997", "___s": true }, { "comment": "/**\r\n * Moves an item below another one in the List.\r\n * If the given item is already below the other, it isn't moved.\r\n * Below means toward the start of the List.\r\n *\r\n * @method Phaser.GameObjects.Layer#moveBelow\r\n * @since 3.55.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child1 - The element to move below base element.\r\n * @param {Phaser.GameObjects.GameObject} child2 - The base element.\r\n */", "meta": { "filename": "Layer.js", "lineno": 685, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Moves an item below another one in the List.\rIf the given item is already below the other, it isn't moved.\rBelow means toward the start of the List.", "kind": "function", "name": "moveBelow", "since": "3.55.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The element to move below base element.", "name": "child1" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The base element.", "name": "child2" } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#moveBelow", "scope": "instance", "___id": "T000002R011998", "___s": true }, { "comment": "/**\r\n * Removes one or many items from the List.\r\n *\r\n * @method Phaser.GameObjects.Layer#remove\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject|Array.} child - The item, or array of items, to remove.\r\n * @param {boolean} [skipCallback=false] - Skip calling the List.removeCallback.\r\n *\r\n * @return {Phaser.GameObjects.GameObject|Array.} The item, or array of items, which were successfully removed from the List.\r\n */", "meta": { "filename": "Layer.js", "lineno": 697, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Removes one or many items from the List.", "kind": "function", "name": "remove", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } ] } }, "description": "The item, or array of items, to remove.", "name": "child" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip calling the List.removeCallback.", "name": "skipCallback" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } ] } }, "description": "The item, or array of items, which were successfully removed from the List." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#remove", "scope": "instance", "___id": "T000002R011999", "___s": true }, { "comment": "/**\r\n * Removes the item at the given position in the List.\r\n *\r\n * @method Phaser.GameObjects.Layer#removeAt\r\n * @since 3.0.0\r\n *\r\n * @param {number} index - The position to remove the item from.\r\n * @param {boolean} [skipCallback=false] - Skip calling the List.removeCallback.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The item that was removed.\r\n */", "meta": { "filename": "Layer.js", "lineno": 709, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Removes the item at the given position in the List.", "kind": "function", "name": "removeAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The position to remove the item from.", "name": "index" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip calling the List.removeCallback.", "name": "skipCallback" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The item that was removed." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#removeAt", "scope": "instance", "___id": "T000002R012000", "___s": true }, { "comment": "/**\r\n * Removes the items within the given range in the List.\r\n *\r\n * @method Phaser.GameObjects.Layer#removeBetween\r\n * @since 3.0.0\r\n *\r\n * @param {number} [startIndex=0] - The index to start removing from.\r\n * @param {number} [endIndex] - The position to stop removing at. The item at this position won't be removed.\r\n * @param {boolean} [skipCallback=false] - Skip calling the List.removeCallback.\r\n *\r\n * @return {Array.} An array of the items which were removed.\r\n */", "meta": { "filename": "Layer.js", "lineno": 721, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Removes the items within the given range in the List.", "kind": "function", "name": "removeBetween", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The index to start removing from.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The position to stop removing at. The item at this position won't be removed.", "name": "endIndex" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip calling the List.removeCallback.", "name": "skipCallback" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "description": "An array of the items which were removed." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#removeBetween", "scope": "instance", "___id": "T000002R012001", "___s": true }, { "comment": "/**\r\n * Removes all the items.\r\n *\r\n * @method Phaser.GameObjects.Layer#removeAll\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [skipCallback=false] - Skip calling the List.removeCallback.\r\n *\r\n * @return {this} This List object.\r\n */", "meta": { "filename": "Layer.js", "lineno": 734, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Removes all the items.", "kind": "function", "name": "removeAll", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip calling the List.removeCallback.", "name": "skipCallback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This List object." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#removeAll", "scope": "instance", "___id": "T000002R012002", "___s": true }, { "comment": "/**\r\n * Brings the given child to the top of this List.\r\n *\r\n * @method Phaser.GameObjects.Layer#bringToTop\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The item to bring to the top of the List.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The item which was moved.\r\n */", "meta": { "filename": "Layer.js", "lineno": 745, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Brings the given child to the top of this List.", "kind": "function", "name": "bringToTop", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The item to bring to the top of the List.", "name": "child" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The item which was moved." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#bringToTop", "scope": "instance", "___id": "T000002R012003", "___s": true }, { "comment": "/**\r\n * Sends the given child to the bottom of this List.\r\n *\r\n * @method Phaser.GameObjects.Layer#sendToBack\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The item to send to the back of the list.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The item which was moved.\r\n */", "meta": { "filename": "Layer.js", "lineno": 756, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Sends the given child to the bottom of this List.", "kind": "function", "name": "sendToBack", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The item to send to the back of the list.", "name": "child" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The item which was moved." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#sendToBack", "scope": "instance", "___id": "T000002R012004", "___s": true }, { "comment": "/**\r\n * Moves the given child up one place in this List unless it's already at the top.\r\n *\r\n * @method Phaser.GameObjects.Layer#moveUp\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The item to move up.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The item which was moved.\r\n */", "meta": { "filename": "Layer.js", "lineno": 767, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Moves the given child up one place in this List unless it's already at the top.", "kind": "function", "name": "moveUp", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The item to move up.", "name": "child" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The item which was moved." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#moveUp", "scope": "instance", "___id": "T000002R012005", "___s": true }, { "comment": "/**\r\n * Moves the given child down one place in this List unless it's already at the bottom.\r\n *\r\n * @method Phaser.GameObjects.Layer#moveDown\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The item to move down.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The item which was moved.\r\n */", "meta": { "filename": "Layer.js", "lineno": 778, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Moves the given child down one place in this List unless it's already at the bottom.", "kind": "function", "name": "moveDown", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The item to move down.", "name": "child" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The item which was moved." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#moveDown", "scope": "instance", "___id": "T000002R012006", "___s": true }, { "comment": "/**\r\n * Reverses the order of all children in this List.\r\n *\r\n * @method Phaser.GameObjects.Layer#reverse\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.GameObjects.Layer} This List object.\r\n */", "meta": { "filename": "Layer.js", "lineno": 789, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Reverses the order of all children in this List.", "kind": "function", "name": "reverse", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Layer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Layer" } }, "description": "This List object." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#reverse", "scope": "instance", "___id": "T000002R012007", "___s": true }, { "comment": "/**\r\n * Shuffles the items in the list.\r\n *\r\n * @method Phaser.GameObjects.Layer#shuffle\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.GameObjects.Layer} This List object.\r\n */", "meta": { "filename": "Layer.js", "lineno": 798, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Shuffles the items in the list.", "kind": "function", "name": "shuffle", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.GameObjects.Layer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Layer" } }, "description": "This List object." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#shuffle", "scope": "instance", "___id": "T000002R012008", "___s": true }, { "comment": "/**\r\n * Replaces a child of this List with the given newChild. The newChild cannot be a member of this List.\r\n *\r\n * @method Phaser.GameObjects.Layer#replace\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} oldChild - The child in this List that will be replaced.\r\n * @param {Phaser.GameObjects.GameObject} newChild - The child to be inserted into this List.\r\n *\r\n * @return {Phaser.GameObjects.GameObject} Returns the oldChild that was replaced within this List.\r\n */", "meta": { "filename": "Layer.js", "lineno": 807, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "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": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The child in this List that will be replaced.", "name": "oldChild" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The child to be inserted into this List.", "name": "newChild" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "Returns the oldChild that was replaced within this List." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#replace", "scope": "instance", "___id": "T000002R012009", "___s": true }, { "comment": "/**\r\n * Checks if an item exists within the List.\r\n *\r\n * @method Phaser.GameObjects.Layer#exists\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} child - The item to check for the existence of.\r\n *\r\n * @return {boolean} `true` if the item is found in the list, otherwise `false`.\r\n */", "meta": { "filename": "Layer.js", "lineno": 819, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Checks if an item exists within the List.", "kind": "function", "name": "exists", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The item to check for the existence of.", "name": "child" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the item is found in the list, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#exists", "scope": "instance", "___id": "T000002R012010", "___s": true }, { "comment": "/**\r\n * Sets the property `key` to the given value on all members of this List.\r\n *\r\n * @method Phaser.GameObjects.Layer#setAll\r\n * @since 3.0.0\r\n *\r\n * @param {string} property - The name of the property to set.\r\n * @param {any} value - The value to set the property to.\r\n * @param {number} [startIndex] - The first child index to start the search from.\r\n * @param {number} [endIndex] - The last child index to search up until.\r\n */", "meta": { "filename": "Layer.js", "lineno": 830, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property to set.", "name": "property" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The value to set the property to.", "name": "value" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The first child index to start the search from.", "name": "startIndex" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The last child index to search up until.", "name": "endIndex" } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#setAll", "scope": "instance", "___id": "T000002R012011", "___s": true }, { "comment": "/**\r\n * Passes all children to the given callback.\r\n *\r\n * @method Phaser.GameObjects.Layer#each\r\n * @since 3.0.0\r\n *\r\n * @param {EachListCallback.} callback - The function to call.\r\n * @param {any} [context] - Value to use as `this` when executing callback.\r\n * @param {...any} [args] - Additional arguments that will be passed to the callback, after the child.\r\n */", "meta": { "filename": "Layer.js", "lineno": 842, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Passes all children to the given callback.", "kind": "function", "name": "each", "since": "3.0.0", "params": [ { "type": { "names": [ "EachListCallback." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "EachListCallback" }, "applications": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } ] } }, "description": "The function to call.", "name": "callback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Value to use as `this` when executing callback.", "name": "context" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any", "repeatable": true } }, "optional": true, "variable": true, "description": "Additional arguments that will be passed to the callback, after the child.", "name": "args" } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#each", "scope": "instance", "___id": "T000002R012012", "___s": true }, { "comment": "/**\r\n * Clears the List and recreates its internal array.\r\n *\r\n * @method Phaser.GameObjects.Layer#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 853, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Clears the List and recreates its internal array.", "kind": "function", "name": "shutdown", "since": "3.0.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#shutdown", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#shutdown", "___id": "T000002R012013", "___s": true }, { "comment": "/**\r\n * The number of items inside the List.\r\n *\r\n * @name Phaser.GameObjects.Layer#length\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 860, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "The number of items inside the List.", "name": "length", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#length", "scope": "instance", "kind": "member", "___id": "T000002R012014", "___s": true }, { "comment": "/**\r\n * The first item in the List or `null` for an empty List.\r\n *\r\n * @name Phaser.GameObjects.Layer#first\r\n * @type {?Phaser.GameObjects.GameObject}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 869, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "The first item in the List or `null` for an empty List.", "name": "first", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "nullable": true, "readonly": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#first", "scope": "instance", "kind": "member", "___id": "T000002R012015", "___s": true }, { "comment": "/**\r\n * The last item in the List, or `null` for an empty List.\r\n *\r\n * @name Phaser.GameObjects.Layer#last\r\n * @type {?Phaser.GameObjects.GameObject}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 878, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "The last item in the List, or `null` for an empty List.", "name": "last", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "nullable": true, "readonly": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#last", "scope": "instance", "kind": "member", "___id": "T000002R012016", "___s": true }, { "comment": "/**\r\n * The next item in the List, or `null` if the entire List has been traversed.\r\n *\r\n * This property can be read successively after reading {@link #first} or manually setting the {@link #position} to iterate the List.\r\n *\r\n * @name Phaser.GameObjects.Layer#next\r\n * @type {?Phaser.GameObjects.GameObject}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 887, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "The next item in the List, or `null` if the entire List has been traversed.\r\rThis property can be read successively after reading {@link #first} or manually setting the {@link #position} to iterate the List.", "name": "next", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "nullable": true, "readonly": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#next", "scope": "instance", "kind": "member", "___id": "T000002R012017", "___s": true }, { "comment": "/**\r\n * The previous item in the List, or `null` if the entire List has been traversed.\r\n *\r\n * This property can be read successively after reading {@link #last} or manually setting the {@link #position} to iterate the List backwards.\r\n *\r\n * @name Phaser.GameObjects.Layer#previous\r\n * @type {?Phaser.GameObjects.GameObject}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Layer.js", "lineno": 898, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "The previous item in the List, or `null` if the entire List has been traversed.\r\rThis property can be read successively after reading {@link #last} or manually setting the {@link #position} to iterate the List backwards.", "name": "previous", "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "nullable": true, "readonly": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#previous", "scope": "instance", "kind": "member", "___id": "T000002R012018", "___s": true }, { "comment": "/**\r\n * Destroys this Layer removing it from the Display List and Update List and\r\n * severing all ties to parent resources.\r\n *\r\n * Also destroys all children of this Layer. If you do not wish for the\r\n * children to be destroyed, you should move them from this Layer first.\r\n *\r\n * Use this to remove this Layer from your game if you don't ever plan to use it again.\r\n * As long as no reference to it exists within your own code it should become free for\r\n * garbage collection by the browser.\r\n *\r\n * If you just want to temporarily disable an object then look at using the\r\n * Game Object Pool instead of destroying it, as destroyed objects cannot be resurrected.\r\n *\r\n * @method Phaser.GameObjects.Layer#destroy\r\n * @fires Phaser.GameObjects.Events#DESTROY\r\n * @since 3.50.0\r\n *\r\n * @param {boolean} [fromScene=false] - `True` if this Game Object is being destroyed by the Scene, `false` if not.\r\n */", "meta": { "filename": "Layer.js", "lineno": 909, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Destroys this Layer removing it from the Display List and Update List and\rsevering all ties to parent resources.\r\rAlso destroys all children of this Layer. If you do not wish for the\rchildren to be destroyed, you should move them from this Layer first.\r\rUse this to remove this Layer from your game if you don't ever plan to use it again.\rAs long as no reference to it exists within your own code it should become free for\rgarbage collection by the browser.\r\rIf you just want to temporarily disable an object then look at using the\rGame Object Pool instead of destroying it, as destroyed objects cannot be resurrected.", "kind": "function", "name": "destroy", "fires": [ "Phaser.GameObjects.Events#event:DESTROY" ], "since": "3.50.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "`True` if this Game Object is being destroyed by the Scene, `false` if not.", "name": "fromScene" } ], "memberof": "Phaser.GameObjects.Layer", "longname": "Phaser.GameObjects.Layer#destroy", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#destroy", "___id": "T000002R012019", "___s": true }, { "comment": "/**\r\n * Creates a new Layer Game Object and returns it.\r\n *\r\n * A Layer is a special type of Game Object that groups other Game Objects together. Unlike a Container,\r\n * a Layer does not apply any transform to its children. Instead, it provides a way to manage rendering\r\n * order and apply post-pipelines or effects to a collection of Game Objects as a single unit.\r\n * The `children` property of the config object can be used to pass an array of Game Objects to add\r\n * to the Layer immediately upon creation.\r\n *\r\n * Note: This method will only be available if the Layer Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#layer\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Sprite.SpriteConfig} config - The configuration object this Game Object will use to create itself. The `children` key can be set to an array of Game Objects to add to the Layer.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Layer} The Game Object that was created.\r\n */", "meta": { "filename": "LayerCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Creates a new Layer Game Object and returns it.\r\rA Layer is a special type of Game Object that groups other Game Objects together. Unlike a Container,\ra Layer does not apply any transform to its children. Instead, it provides a way to manage rendering\rorder and apply post-pipelines or effects to a collection of Game Objects as a single unit.\rThe `children` property of the config object can be used to pass an array of Game Objects to add\rto the Layer immediately upon creation.\r\rNote: This method will only be available if the Layer Game Object has been built into Phaser.", "kind": "function", "name": "layer", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Sprite.SpriteConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Sprite.SpriteConfig" } }, "description": "The configuration object this Game Object will use to create itself. The `children` key can be set to an array of Game Objects to add to the Layer.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.Layer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Layer" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#layer", "scope": "instance", "___id": "T000002R012039", "___s": true }, { "comment": "/**\r\n * Creates a new Layer Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Layer Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#layer\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} [children] - An optional array of Game Objects to add to this Layer.\r\n *\r\n * @return {Phaser.GameObjects.Layer} The Game Object that was created.\r\n */", "meta": { "filename": "LayerFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\layer", "code": {} }, "description": "Creates a new Layer Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Layer Game Object has been built into Phaser.", "kind": "function", "name": "layer", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An optional array of Game Objects to add to this Layer.", "name": "children" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Layer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Layer" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#layer", "scope": "instance", "___id": "T000002R012046", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A 2D Light.\r\n *\r\n * These are created by the {@link Phaser.GameObjects.LightsManager}, available from within a scene via `this.lights`.\r\n *\r\n * Any Game Objects with the Lighting Component, and `setLighting(true)`,\r\n * will then be affected by these Lights.\r\n * If they have a normal map, it will be used.\r\n * If they don't, the Lights will use the default normal map, a flat surface.\r\n *\r\n * They can also simply be used to represent a point light for your own purposes.\r\n *\r\n * Lights cannot be added to Containers. They are designed to exist in the root of a Scene.\r\n *\r\n * @class Light\r\n * @extends Phaser.Geom.Circle\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {number} x - The horizontal position of the light.\r\n * @param {number} y - The vertical position of the light.\r\n * @param {number} radius - The radius of the light.\r\n * @param {number} r - The red color of the light. A value between 0 and 1.\r\n * @param {number} g - The green color of the light. A value between 0 and 1.\r\n * @param {number} b - The blue color of the light. A value between 0 and 1.\r\n * @param {number} intensity - The intensity of the light.\r\n * @param {number} [z] - The z position of the light. If not given, it will be set to `radius * 0.1`.\r\n */", "meta": { "filename": "Light.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "classdesc": "A 2D Light.\r\rThese are created by the {@link Phaser.GameObjects.LightsManager}, available from within a scene via `this.lights`.\r\rAny Game Objects with the Lighting Component, and `setLighting(true)`,\rwill then be affected by these Lights.\rIf they have a normal map, it will be used.\rIf they don't, the Lights will use the default normal map, a flat surface.\r\rThey can also simply be used to represent a point light for your own purposes.\r\rLights cannot be added to Containers. They are designed to exist in the root of a Scene.", "kind": "class", "name": "Light", "augments": [ "Phaser.Geom.Circle", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.GameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of the light.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of the light.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the light.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The red color of the light. A value between 0 and 1.", "name": "r" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The green color of the light. A value between 0 and 1.", "name": "g" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The blue color of the light. A value between 0 and 1.", "name": "b" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The intensity of the light.", "name": "intensity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The z position of the light. If not given, it will be set to `radius * 0.1`.", "name": "z" } ], "scope": "static", "longname": "Phaser.GameObjects.Light", "___id": "T000002R012087", "___s": true }, { "comment": "/**\r\n * The color of the light.\r\n *\r\n * @name Phaser.GameObjects.Light#color\r\n * @type {Phaser.Display.RGB}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Light.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The color of the light.", "name": "color", "type": { "names": [ "Phaser.Display.RGB" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.RGB" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#color", "scope": "instance", "kind": "member", "___id": "T000002R012092", "___s": true }, { "comment": "/**\r\n * The intensity of the light. This scales the overall brightness of the light effect.\r\n * A value of 1 is considered normal brightness. Higher values produce a stronger, brighter light.\r\n *\r\n * @name Phaser.GameObjects.Light#intensity\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "Light.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The intensity of the light. This scales the overall brightness of the light effect.\rA value of 1 is considered normal brightness. Higher values produce a stronger, brighter light.", "name": "intensity", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#intensity", "scope": "instance", "kind": "member", "___id": "T000002R012094", "___s": true }, { "comment": "/**\r\n * The z position of the light.\r\n * This affects the relief effect created by the light.\r\n * A higher value will make the light appear more raised.\r\n *\r\n * Lit game objects are considered to be at z=0.\r\n * Thus, if z is larger than the radius of the light,\r\n * the light will not affect them.\r\n * Strong values are in the range of 0 to radius/2.\r\n *\r\n * This is not a true position, and won't be affected by\r\n * perspective or camera position. It won't be set by `setTo`.\r\n * Use `setZ` to set it, or `setZNormal` to set it to a fraction\r\n * of the radius.\r\n *\r\n * @name Phaser.GameObjects.Light#z\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Light.js", "lineno": 82, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The z position of the light.\rThis affects the relief effect created by the light.\rA higher value will make the light appear more raised.\r\rLit game objects are considered to be at z=0.\rThus, if z is larger than the radius of the light,\rthe light will not affect them.\rStrong values are in the range of 0 to radius/2.\r\rThis is not a true position, and won't be affected by\rperspective or camera position. It won't be set by `setTo`.\rUse `setZ` to set it, or `setZNormal` to set it to a fraction\rof the radius.", "name": "z", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#z", "scope": "instance", "kind": "member", "___id": "T000002R012096", "___s": true }, { "comment": "/**\r\n * Whether this Light is restricted to a cone.\r\n *\r\n * @name Phaser.GameObjects.Light#coneEnabled\r\n * @type {boolean}\r\n * @default false\r\n * @since 4.2.0\r\n */", "meta": { "filename": "Light.js", "lineno": 103, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Whether this Light is restricted to a cone.", "name": "coneEnabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "4.2.0", "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#coneEnabled", "scope": "instance", "kind": "member", "___id": "T000002R012098", "___s": true }, { "comment": "/**\r\n * The cone direction, in radians, in world space.\r\n *\r\n * @name Phaser.GameObjects.Light#coneRotation\r\n * @type {number}\r\n * @default 0\r\n * @since 4.2.0\r\n */", "meta": { "filename": "Light.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The cone direction, in radians, in world space.", "name": "coneRotation", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.2.0", "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#coneRotation", "scope": "instance", "kind": "member", "___id": "T000002R012100", "___s": true }, { "comment": "/**\r\n * The inner cone angle, in radians. Fragments inside this angle receive full light.\r\n *\r\n * @name Phaser.GameObjects.Light#coneInnerAngle\r\n * @type {number}\r\n * @default 0\r\n * @since 4.2.0\r\n */", "meta": { "filename": "Light.js", "lineno": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The inner cone angle, in radians. Fragments inside this angle receive full light.", "name": "coneInnerAngle", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.2.0", "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#coneInnerAngle", "scope": "instance", "kind": "member", "___id": "T000002R012102", "___s": true }, { "comment": "/**\r\n * The outer cone angle, in radians. Fragments outside this angle receive no light.\r\n *\r\n * @name Phaser.GameObjects.Light#coneOuterAngle\r\n * @type {number}\r\n * @default 0\r\n * @since 4.2.0\r\n */", "meta": { "filename": "Light.js", "lineno": 133, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The outer cone angle, in radians. Fragments outside this angle receive no light.", "name": "coneOuterAngle", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.2.0", "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#coneOuterAngle", "scope": "instance", "kind": "member", "___id": "T000002R012104", "___s": true }, { "comment": "/**\r\n * The flags that are compared against `RENDER_MASK` to determine if this Light will render or not.\r\n * The relevant bit is 0001, set by the Visible component. The remaining bits are unused by Light\r\n * but are reserved for custom use if required.\r\n *\r\n * @name Phaser.GameObjects.Light#renderFlags\r\n * @type {number}\r\n * @default 15\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Light.js", "lineno": 143, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The flags that are compared against `RENDER_MASK` to determine if this Light will render or not.\rThe relevant bit is 0001, set by the Visible component. The remaining bits are unused by Light\rbut are reserved for custom use if required.", "name": "renderFlags", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "15", "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#renderFlags", "scope": "instance", "kind": "member", "___id": "T000002R012106", "___s": true }, { "comment": "/**\r\n * A bitmask that controls if this Game Object is drawn by a Camera or not.\r\n * Not usually set directly, instead call `Camera.ignore`, however you can\r\n * set this property directly using the Camera.id property:\r\n *\r\n * @example\r\n * this.cameraFilter |= camera.id\r\n *\r\n * @name Phaser.GameObjects.Light#cameraFilter\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Light.js", "lineno": 155, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "A bitmask that controls if this Game Object is drawn by a Camera or not.\rNot usually set directly, instead call `Camera.ignore`, however you can\rset this property directly using the Camera.id property:", "examples": [ "this.cameraFilter |= camera.id" ], "name": "cameraFilter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#cameraFilter", "scope": "instance", "kind": "member", "___id": "T000002R012108", "___s": true }, { "comment": "/**\r\n * The width of this Light Game Object. This is the same as `Light.diameter`.\r\n *\r\n * @name Phaser.GameObjects.Light#displayWidth\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Light.js", "lineno": 175, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The width of this Light Game Object. This is the same as `Light.diameter`.", "name": "displayWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#displayWidth", "scope": "instance", "kind": "member", "___id": "T000002R012110", "___s": true }, { "comment": "/**\r\n * The height of this Light Game Object. This is the same as `Light.diameter`.\r\n *\r\n * @name Phaser.GameObjects.Light#displayHeight\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Light.js", "lineno": 196, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The height of this Light Game Object. This is the same as `Light.diameter`.", "name": "displayHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#displayHeight", "scope": "instance", "kind": "member", "___id": "T000002R012115", "___s": true }, { "comment": "/**\r\n * The width of this Light Game Object. This is the same as `Light.diameter`.\r\n *\r\n * @name Phaser.GameObjects.Light#width\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Light.js", "lineno": 217, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The width of this Light Game Object. This is the same as `Light.diameter`.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#width", "scope": "instance", "kind": "member", "___id": "T000002R012120", "___s": true }, { "comment": "/**\r\n * The height of this Light Game Object. This is the same as `Light.diameter`.\r\n *\r\n * @name Phaser.GameObjects.Light#height\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Light.js", "lineno": 238, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The height of this Light Game Object. This is the same as `Light.diameter`.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#height", "scope": "instance", "kind": "member", "___id": "T000002R012125", "___s": true }, { "comment": "/**\r\n * The z position of the light, as a fraction of the radius.\r\n * This affects the relief effect created by the light.\r\n * A higher value will make the light appear more raised.\r\n * Strong values are in the range of 0 to 0.5.\r\n *\r\n * @name Phaser.GameObjects.Light#zNormal\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Light.js", "lineno": 259, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The z position of the light, as a fraction of the radius.\rThis affects the relief effect created by the light.\rA higher value will make the light appear more raised.\rStrong values are in the range of 0 to 0.5.", "name": "zNormal", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#zNormal", "scope": "instance", "kind": "member", "___id": "T000002R012130", "___s": true }, { "comment": "/**\r\n * Compares the renderMask with the renderFlags to see if this Game Object will render or not.\r\n * Also checks the Game Object against the given Cameras exclusion list.\r\n *\r\n * @method Phaser.GameObjects.Light#willRender\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to check against this Game Object.\r\n *\r\n * @return {boolean} True if the Game Object should be rendered, otherwise false.\r\n */", "meta": { "filename": "Light.js", "lineno": 281, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Compares the renderMask with the renderFlags to see if this Game Object will render or not.\rAlso checks the Game Object against the given Cameras exclusion list.", "kind": "function", "name": "willRender", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to check against this Game Object.", "name": "camera" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Game Object should be rendered, otherwise false." } ], "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#willRender", "scope": "instance", "___id": "T000002R012135", "___s": true }, { "comment": "/**\r\n * Set the color of the light from a single integer RGB value.\r\n *\r\n * @method Phaser.GameObjects.Light#setColor\r\n * @since 3.0.0\r\n *\r\n * @param {number} rgb - The integer RGB color of the light.\r\n *\r\n * @return {this} This Light object.\r\n */", "meta": { "filename": "Light.js", "lineno": 297, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The integer RGB color of the light.", "name": "rgb" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Light object." } ], "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#setColor", "scope": "instance", "___id": "T000002R012137", "___s": true }, { "comment": "/**\r\n * Set the intensity of the light. This scales the overall brightness of the light effect.\r\n * A value of 1 is considered normal brightness. Higher values produce a stronger, brighter light.\r\n *\r\n * @method Phaser.GameObjects.Light#setIntensity\r\n * @since 3.0.0\r\n *\r\n * @param {number} intensity - The intensity (brightness multiplier) of the light.\r\n *\r\n * @return {this} This Light object.\r\n */", "meta": { "filename": "Light.js", "lineno": 316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Set the intensity of the light. This scales the overall brightness of the light effect.\rA value of 1 is considered normal brightness. Higher values produce a stronger, brighter light.", "kind": "function", "name": "setIntensity", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The intensity (brightness multiplier) of the light.", "name": "intensity" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Light object." } ], "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#setIntensity", "scope": "instance", "___id": "T000002R012140", "___s": true }, { "comment": "/**\r\n * Set the radius of the light, in pixels. This defines the circular area of influence\r\n * within which lit Game Objects will be affected by this light.\r\n *\r\n * @method Phaser.GameObjects.Light#setRadius\r\n * @since 3.0.0\r\n *\r\n * @param {number} radius - The radius of the light, in pixels.\r\n *\r\n * @return {this} This Light object.\r\n */", "meta": { "filename": "Light.js", "lineno": 334, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Set the radius of the light, in pixels. This defines the circular area of influence\rwithin which lit Game Objects will be affected by this light.", "kind": "function", "name": "setRadius", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the light, in pixels.", "name": "radius" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Light object." } ], "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#setRadius", "scope": "instance", "___id": "T000002R012143", "___s": true }, { "comment": "/**\r\n * Set the z position of the light. This controls the perceived height of the light above\r\n * the scene, which influences the relief (normal-map shading) effect. Larger values make\r\n * the light appear more elevated. Lit Game Objects are considered to be at z=0, so if z\r\n * exceeds the light's radius the light will not affect them. Strong values are in the\r\n * range of 0 to radius/2.\r\n *\r\n * @method Phaser.GameObjects.Light#setZ\r\n * @since 4.0.0\r\n *\r\n * @param {number} z - The z position of the light, where 0 is at the same level as lit Game Objects.\r\n *\r\n * @return {this} This Light object.\r\n */", "meta": { "filename": "Light.js", "lineno": 352, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Set the z position of the light. This controls the perceived height of the light above\rthe scene, which influences the relief (normal-map shading) effect. Larger values make\rthe light appear more elevated. Lit Game Objects are considered to be at z=0, so if z\rexceeds the light's radius the light will not affect them. Strong values are in the\rrange of 0 to radius/2.", "kind": "function", "name": "setZ", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The z position of the light, where 0 is at the same level as lit Game Objects.", "name": "z" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Light object." } ], "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#setZ", "scope": "instance", "___id": "T000002R012146", "___s": true }, { "comment": "/**\r\n * Set the z position of the light as a fraction of the radius.\r\n * This affects the relief effect created by the light.\r\n * A higher value will make the light appear more raised.\r\n * Strong values are in the range of 0 to 0.5.\r\n *\r\n * @method Phaser.GameObjects.Light#setZNormal\r\n * @since 4.0.0\r\n *\r\n * @param {number} z - The normalized z position of the light.\r\n *\r\n * @return {this} This Light object.\r\n */", "meta": { "filename": "Light.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Set the z position of the light as a fraction of the radius.\rThis affects the relief effect created by the light.\rA higher value will make the light appear more raised.\rStrong values are in the range of 0 to 0.5.", "kind": "function", "name": "setZNormal", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The normalized z position of the light.", "name": "z" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Light object." } ], "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#setZNormal", "scope": "instance", "___id": "T000002R012149", "___s": true }, { "comment": "/**\r\n * Restrict this Light to a cone, suitable for flashlights, lanterns and other focal lights.\r\n *\r\n * The `rotation` is in radians, where 0 points to the right in world space. The `innerAngle`\r\n * is the fully-lit cone width. The `outerAngle` is the wider falloff cone width; if omitted,\r\n * the cone has a hard edge. Both angles are full cone widths, not half-angles.\r\n *\r\n * @method Phaser.GameObjects.Light#setCone\r\n * @since 4.2.0\r\n *\r\n * @param {number} rotation - The direction of the cone, in radians.\r\n * @param {number} innerAngle - The fully-lit cone width, in radians.\r\n * @param {number} [outerAngle=innerAngle] - The outer falloff cone width, in radians.\r\n *\r\n * @return {this} This Light object.\r\n */", "meta": { "filename": "Light.js", "lineno": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Restrict this Light to a cone, suitable for flashlights, lanterns and other focal lights.\r\rThe `rotation` is in radians, where 0 points to the right in world space. The `innerAngle`\ris the fully-lit cone width. The `outerAngle` is the wider falloff cone width; if omitted,\rthe cone has a hard edge. Both angles are full cone widths, not half-angles.", "kind": "function", "name": "setCone", "since": "4.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The direction of the cone, in radians.", "name": "rotation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The fully-lit cone width, in radians.", "name": "innerAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "innerAngle", "description": "The outer falloff cone width, in radians.", "name": "outerAngle" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Light object." } ], "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#setCone", "scope": "instance", "___id": "T000002R012152", "___s": true }, { "comment": "/**\r\n * Set the direction of this Light cone, in radians.\r\n *\r\n * @method Phaser.GameObjects.Light#setConeRotation\r\n * @since 4.2.0\r\n *\r\n * @param {number} rotation - The direction of the cone, in radians.\r\n *\r\n * @return {this} This Light object.\r\n */", "meta": { "filename": "Light.js", "lineno": 429, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Set the direction of this Light cone, in radians.", "kind": "function", "name": "setConeRotation", "since": "4.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The direction of the cone, in radians.", "name": "rotation" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Light object." } ], "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#setConeRotation", "scope": "instance", "___id": "T000002R012162", "___s": true }, { "comment": "/**\r\n * Set the inner and outer cone angles, in radians.\r\n *\r\n * @method Phaser.GameObjects.Light#setConeAngles\r\n * @since 4.2.0\r\n *\r\n * @param {number} innerAngle - The fully-lit cone width, in radians.\r\n * @param {number} [outerAngle=innerAngle] - The outer falloff cone width, in radians.\r\n *\r\n * @return {this} This Light object.\r\n */", "meta": { "filename": "Light.js", "lineno": 446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Set the inner and outer cone angles, in radians.", "kind": "function", "name": "setConeAngles", "since": "4.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The fully-lit cone width, in radians.", "name": "innerAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "innerAngle", "description": "The outer falloff cone width, in radians.", "name": "outerAngle" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Light object." } ], "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#setConeAngles", "scope": "instance", "___id": "T000002R012165", "___s": true }, { "comment": "/**\r\n * Disable cone limiting and make this Light omnidirectional again.\r\n *\r\n * @method Phaser.GameObjects.Light#disableCone\r\n * @since 4.2.0\r\n *\r\n * @return {this} This Light object.\r\n */", "meta": { "filename": "Light.js", "lineno": 475, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Disable cone limiting and make this Light omnidirectional again.", "kind": "function", "name": "disableCone", "since": "4.2.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Light object." } ], "memberof": "Phaser.GameObjects.Light", "longname": "Phaser.GameObjects.Light#disableCone", "scope": "instance", "___id": "T000002R012173", "___s": true }, { "comment": "/**\r\n * The bitmask that `GameObject.renderFlags` is compared against to determine if the Game Object will render or not.\r\n *\r\n * @constant {number} RENDER_MASK\r\n * @memberof Phaser.GameObjects.Light\r\n * @default\r\n */", "meta": { "filename": "Light.js", "lineno": 492, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "memberof": "Phaser.GameObjects.Light", "scope": "static", "longname": "Phaser.GameObjects.Light.RENDER_MASK", "___id": "T000002R012176", "___s": true }, { "comment": "/**\r\n * @callback LightForEach\r\n *\r\n * @param {Phaser.GameObjects.Light} light - The Light.\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "kind": "typedef", "name": "LightForEach", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "Phaser.GameObjects.Light" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Light" } }, "description": "The Light.", "name": "light" } ], "longname": "LightForEach", "scope": "global", "___id": "T000002R012188", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Lights Manager is responsible for managing all of the {@link Phaser.GameObjects.Light} objects\r\n * in a Scene, as well as the ambient light color that applies to all lit Game Objects.\r\n *\r\n * It is created automatically by the Scene Systems and is accessed via `this.lights` within a Scene.\r\n * To use the lighting system, call `this.lights.enable()` and ensure that any Game Objects you want\r\n * to be affected by lighting have `setLighting(true)` applied to them.\r\n *\r\n * The Lights Manager works in conjunction with the Light Filter (WebGL only). Game Objects rendered\r\n * with this filter sample the active lights and the ambient color, and use any normal maps assigned\r\n * to their textures to produce a dynamic lighting effect. Lighting has no effect in Canvas rendering.\r\n *\r\n * Each Scene supports a fixed maximum number of simultaneous lights, set via the `maxLights` property\r\n * in the game config. When more lights exist than the maximum, the manager culls the furthest lights\r\n * from the camera each frame. Use {@link Phaser.GameObjects.LightsManager#addLight} to create a\r\n * Light and {@link Phaser.GameObjects.LightsManager#setAmbientColor} to control the base illumination.\r\n *\r\n * @class LightsManager\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 23, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "classdesc": "The Lights Manager is responsible for managing all of the {@link Phaser.GameObjects.Light} objects\rin a Scene, as well as the ambient light color that applies to all lit Game Objects.\r\rIt is created automatically by the Scene Systems and is accessed via `this.lights` within a Scene.\rTo use the lighting system, call `this.lights.enable()` and ensure that any Game Objects you want\rto be affected by lighting have `setLighting(true)` applied to them.\r\rThe Lights Manager works in conjunction with the Light Filter (WebGL only). Game Objects rendered\rwith this filter sample the active lights and the ambient color, and use any normal maps assigned\rto their textures to produce a dynamic lighting effect. Lighting has no effect in Canvas rendering.\r\rEach Scene supports a fixed maximum number of simultaneous lights, set via the `maxLights` property\rin the game config. When more lights exist than the maximum, the manager culls the furthest lights\rfrom the camera each frame. Use {@link Phaser.GameObjects.LightsManager#addLight} to create a\rLight and {@link Phaser.GameObjects.LightsManager#setAmbientColor} to control the base illumination.", "kind": "class", "name": "LightsManager", "memberof": "Phaser.GameObjects", "since": "3.0.0", "scope": "static", "longname": "Phaser.GameObjects.LightsManager", "___id": "T000002R012189", "___s": true }, { "comment": "/**\r\n * The Lights in the Scene.\r\n *\r\n * @name Phaser.GameObjects.LightsManager#lights\r\n * @type {Phaser.GameObjects.Light[]}\r\n * @default []\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 52, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The Lights in the Scene.", "name": "lights", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Light", "type": "NameExpression" } ] } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#lights", "scope": "instance", "kind": "member", "___id": "T000002R012192", "___s": true }, { "comment": "/**\r\n * The ambient color.\r\n *\r\n * @name Phaser.GameObjects.LightsManager#ambientColor\r\n * @type {Phaser.Display.RGB}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The ambient color.", "name": "ambientColor", "type": { "names": [ "Phaser.Display.RGB" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.RGB" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#ambientColor", "scope": "instance", "kind": "member", "___id": "T000002R012194", "___s": true }, { "comment": "/**\r\n * Whether the Lights Manager is enabled.\r\n *\r\n * @name Phaser.GameObjects.LightsManager#active\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Whether the Lights Manager is enabled.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#active", "scope": "instance", "kind": "member", "___id": "T000002R012196", "___s": true }, { "comment": "/**\r\n * The maximum number of lights that a single Camera and the lights shader can process.\r\n * Change this via the `maxLights` property in your game config, as it cannot be changed at runtime.\r\n *\r\n * @name Phaser.GameObjects.LightsManager#maxLights\r\n * @type {number}\r\n * @readonly\r\n * @since 3.15.0\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The maximum number of lights that a single Camera and the lights shader can process.\rChange this via the `maxLights` property in your game config, as it cannot be changed at runtime.", "name": "maxLights", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.15.0", "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#maxLights", "scope": "instance", "kind": "member", "___id": "T000002R012198", "___s": true }, { "comment": "/**\r\n * The number of lights processed in the _previous_ frame.\r\n *\r\n * @name Phaser.GameObjects.LightsManager#visibleLights\r\n * @type {number}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "The number of lights processed in the _previous_ frame.", "name": "visibleLights", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#visibleLights", "scope": "instance", "kind": "member", "___id": "T000002R012200", "___s": true }, { "comment": "/**\r\n * Creates a new Point Light Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Point Light Game Object has been built into Phaser.\r\n *\r\n * The Point Light Game Object provides a way to add a point light effect into your game,\r\n * without the expensive shader processing requirements of the traditional Light Game Object.\r\n *\r\n * The difference is that the Point Light renders using a custom shader, designed to give the\r\n * impression of a point light source, of variable radius, intensity and color, in your game.\r\n * However, unlike the Light Game Object, it does not impact any other Game Objects, or use their\r\n * normal maps for calculations. This makes them extremely fast to render compared to Lights\r\n * and perfect for special effects, such as flickering torches or muzzle flashes.\r\n *\r\n * For maximum performance you should batch Point Light Game Objects together. This means\r\n * ensuring they follow each other consecutively on the display list. Ideally, use a Layer\r\n * Game Object and then add just Point Lights to it, so that it can batch together the rendering\r\n * of the lights. You don't _have_ to do this, and if you've only a handful of Point Lights in\r\n * your game then it's perfectly safe to mix them into the display list as normal. However, if\r\n * you're using a large number of them, please consider how they are mixed into the display list.\r\n *\r\n * The renderer will automatically cull Point Lights. Those with a radius that does not intersect\r\n * with the Camera will be skipped in the rendering list. This happens automatically and the\r\n * culled state is refreshed every frame, for every camera.\r\n *\r\n * The origin of a Point Light is always 0.5 and it cannot be changed.\r\n *\r\n * Point Lights are a WebGL only feature and do not have a Canvas counterpart.\r\n *\r\n * @method Phaser.GameObjects.LightsManager#addPointLight\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The horizontal position of this Point Light in the world.\r\n * @param {number} y - The vertical position of this Point Light in the world.\r\n * @param {number} [color=0xffffff] - The color of the Point Light, given as a hex value.\r\n * @param {number} [radius=128] - The radius of the Point Light.\r\n * @param {number} [intensity=1] - The intensity, or color blend, of the Point Light.\r\n * @param {number} [attenuation=0.1] - The attenuation of the Point Light. This is the reduction of light from the center point.\r\n *\r\n * @return {Phaser.GameObjects.PointLight} The Game Object that was created.\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Creates a new Point Light Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Point Light Game Object has been built into Phaser.\r\rThe Point Light Game Object provides a way to add a point light effect into your game,\rwithout the expensive shader processing requirements of the traditional Light Game Object.\r\rThe difference is that the Point Light renders using a custom shader, designed to give the\rimpression of a point light source, of variable radius, intensity and color, in your game.\rHowever, unlike the Light Game Object, it does not impact any other Game Objects, or use their\rnormal maps for calculations. This makes them extremely fast to render compared to Lights\rand perfect for special effects, such as flickering torches or muzzle flashes.\r\rFor maximum performance you should batch Point Light Game Objects together. This means\rensuring they follow each other consecutively on the display list. Ideally, use a Layer\rGame Object and then add just Point Lights to it, so that it can batch together the rendering\rof the lights. You don't _have_ to do this, and if you've only a handful of Point Lights in\ryour game then it's perfectly safe to mix them into the display list as normal. However, if\ryou're using a large number of them, please consider how they are mixed into the display list.\r\rThe renderer will automatically cull Point Lights. Those with a radius that does not intersect\rwith the Camera will be skipped in the rendering list. This happens automatically and the\rculled state is refreshed every frame, for every camera.\r\rThe origin of a Point Light is always 0.5 and it cannot be changed.\r\rPoint Lights are a WebGL only feature and do not have a Canvas counterpart.", "kind": "function", "name": "addPointLight", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Point Light in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Point Light in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color of the Point Light, given as a hex value.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The radius of the Point Light.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The intensity, or color blend, of the Point Light.", "name": "intensity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "The attenuation of the Point Light. This is the reduction of light from the center point.", "name": "attenuation" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.PointLight" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.PointLight" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#addPointLight", "scope": "instance", "___id": "T000002R012202", "___s": true }, { "comment": "/**\r\n * Enable the Lights Manager. This activates the lighting system for the Scene, causing all\r\n * Game Objects using the Light Filter to be affected by the configured lights and ambient\r\n * color. On first enable, the `maxLights` value is read from the renderer configuration.\r\n *\r\n * @method Phaser.GameObjects.LightsManager#enable\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Lights Manager instance.\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 149, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Enable the Lights Manager. This activates the lighting system for the Scene, causing all\rGame Objects using the Light Filter to be affected by the configured lights and ambient\rcolor. On first enable, the `maxLights` value is read from the renderer configuration.", "kind": "function", "name": "enable", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Lights Manager instance." } ], "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#enable", "scope": "instance", "___id": "T000002R012204", "___s": true }, { "comment": "/**\r\n * Disable the Lights Manager. When disabled, the lighting system no longer affects the rendering\r\n * of Game Objects using the Light Filter, effectively switching them back to unlit rendering.\r\n * The existing lights and ambient color are preserved and will take effect again if the manager\r\n * is re-enabled.\r\n *\r\n * @method Phaser.GameObjects.LightsManager#disable\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Lights Manager instance.\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 171, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Disable the Lights Manager. When disabled, the lighting system no longer affects the rendering\rof Game Objects using the Light Filter, effectively switching them back to unlit rendering.\rThe existing lights and ambient color are preserved and will take effect again if the manager\ris re-enabled.", "kind": "function", "name": "disable", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Lights Manager instance." } ], "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#disable", "scope": "instance", "___id": "T000002R012208", "___s": true }, { "comment": "/**\r\n * Get all lights that can be seen by the given Camera.\r\n *\r\n * It will automatically cull lights that are outside the world view of the Camera.\r\n *\r\n * If more lights are returned than supported by the renderer, the lights are then culled\r\n * based on the distance from the center of the camera. Only those closest are rendered.\r\n *\r\n * @method Phaser.GameObjects.LightsManager#getLights\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to cull Lights for.\r\n *\r\n * @return {Phaser.GameObjects.Light[]} The culled Lights.\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Get all lights that can be seen by the given Camera.\r\rIt will automatically cull lights that are outside the world view of the Camera.\r\rIf more lights are returned than supported by the renderer, the lights are then culled\rbased on the distance from the center of the camera. Only those closest are rendered.", "kind": "function", "name": "getLights", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to cull Lights for.", "name": "camera" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Light", "type": "NameExpression" } ] } }, "description": "The culled Lights." } ], "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#getLights", "scope": "instance", "___id": "T000002R012211", "___s": true }, { "comment": "/**\r\n * Sort function to sort lights by distance from the camera.\r\n * The sort is in reverse order, so that the furthest light is culled first.\r\n *\r\n * @method Phaser.GameObjects.LightsManager#sortByDistance\r\n * @since 4.0.0\r\n *\r\n * @param {number} a - A light entry object with a `distance` property representing its distance from the camera center.\r\n * @param {number} b - A light entry object with a `distance` property representing its distance from the camera center.\r\n * @return {boolean} True if `a` is further than `b`, otherwise false.\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 240, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Sort function to sort lights by distance from the camera.\rThe sort is in reverse order, so that the furthest light is culled first.", "kind": "function", "name": "sortByDistance", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A light entry object with a `distance` property representing its distance from the camera center.", "name": "a" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A light entry object with a `distance` property representing its distance from the camera center.", "name": "b" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if `a` is further than `b`, otherwise false." } ], "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#sortByDistance", "scope": "instance", "___id": "T000002R012222", "___s": true }, { "comment": "/**\r\n * Set the ambient light color.\r\n *\r\n * @method Phaser.GameObjects.LightsManager#setAmbientColor\r\n * @since 3.0.0\r\n *\r\n * @param {number} rgb - The integer RGB color of the ambient light.\r\n *\r\n * @return {this} This Lights Manager instance.\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 256, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Set the ambient light color.", "kind": "function", "name": "setAmbientColor", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The integer RGB color of the ambient light.", "name": "rgb" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Lights Manager instance." } ], "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#setAmbientColor", "scope": "instance", "___id": "T000002R012224", "___s": true }, { "comment": "/**\r\n * Returns the maximum number of Lights allowed to appear at once.\r\n *\r\n * @method Phaser.GameObjects.LightsManager#getMaxVisibleLights\r\n * @since 3.0.0\r\n *\r\n * @return {number} The maximum number of Lights allowed to appear at once.\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 275, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Returns the maximum number of Lights allowed to appear at once.", "kind": "function", "name": "getMaxVisibleLights", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum number of Lights allowed to appear at once." } ], "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#getMaxVisibleLights", "scope": "instance", "___id": "T000002R012227", "___s": true }, { "comment": "/**\r\n * Get the number of Lights managed by this Lights Manager.\r\n *\r\n * @method Phaser.GameObjects.LightsManager#getLightCount\r\n * @since 3.0.0\r\n *\r\n * @return {number} The number of Lights managed by this Lights Manager.\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Get the number of Lights managed by this Lights Manager.", "kind": "function", "name": "getLightCount", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of Lights managed by this Lights Manager." } ], "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#getLightCount", "scope": "instance", "___id": "T000002R012229", "___s": true }, { "comment": "/**\r\n * Creates a new {@link Phaser.GameObjects.Light} object, adds it to this Lights Manager, and returns it.\r\n * The Light will influence all Game Objects using the Light Filter that are within its radius,\r\n * using the texture's normal map data to compute shading. You can configure its position, radius,\r\n * color, intensity, and z-height (which affects the angle of the shading effect).\r\n *\r\n * @method Phaser.GameObjects.LightsManager#addLight\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of the Light.\r\n * @param {number} [y=0] - The vertical position of the Light.\r\n * @param {number} [radius=128] - The radius of the Light.\r\n * @param {number} [rgb=0xffffff] - The integer RGB color of the light.\r\n * @param {number} [intensity=1] - The intensity of the Light.\r\n * @param {number} [z] - The z position of the light. If omitted, it will be set to `radius * 0.1`.\r\n *\r\n * @return {Phaser.GameObjects.Light} The Light that was added.\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Creates a new {@link Phaser.GameObjects.Light} object, adds it to this Lights Manager, and returns it.\rThe Light will influence all Game Objects using the Light Filter that are within its radius,\rusing the texture's normal map data to compute shading. You can configure its position, radius,\rcolor, intensity, and z-height (which affects the angle of the shading effect).", "kind": "function", "name": "addLight", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the Light.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the Light.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The radius of the Light.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The integer RGB color of the light.", "name": "rgb" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The intensity of the Light.", "name": "intensity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The z position of the light. If omitted, it will be set to `radius * 0.1`.", "name": "z" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Light" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Light" } }, "description": "The Light that was added." } ], "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#addLight", "scope": "instance", "___id": "T000002R012231", "___s": true }, { "comment": "/**\r\n * Creates a new cone-limited {@link Phaser.GameObjects.Light} object, adds it to this Lights Manager,\r\n * and returns it.\r\n *\r\n * The cone angles are full cone widths in radians. Fragments inside `innerAngle` receive full light,\r\n * and fragments between `innerAngle` and `outerAngle` are softly attenuated.\r\n *\r\n * @method Phaser.GameObjects.LightsManager#addConeLight\r\n * @since 4.2.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of the Light.\r\n * @param {number} [y=0] - The vertical position of the Light.\r\n * @param {number} [radius=128] - The radius of the Light.\r\n * @param {number} [rgb=0xffffff] - The integer RGB color of the light.\r\n * @param {number} [intensity=1] - The intensity of the Light.\r\n * @param {number} [rotation=0] - The direction of the cone, in radians.\r\n * @param {number} [innerAngle=Math.PI / 4] - The fully-lit cone width, in radians.\r\n * @param {number} [outerAngle=innerAngle] - The outer falloff cone width, in radians.\r\n * @param {number} [z] - The z position of the light. If omitted, it will be set to `radius * 0.1`.\r\n *\r\n * @return {Phaser.GameObjects.Light} The Light that was added.\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Creates a new cone-limited {@link Phaser.GameObjects.Light} object, adds it to this Lights Manager,\rand returns it.\r\rThe cone angles are full cone widths in radians. Fragments inside `innerAngle` receive full light,\rand fragments between `innerAngle` and `outerAngle` are softly attenuated.", "kind": "function", "name": "addConeLight", "since": "4.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the Light.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the Light.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The radius of the Light.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The integer RGB color of the light.", "name": "rgb" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The intensity of the Light.", "name": "intensity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The direction of the cone, in radians.", "name": "rotation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "Math.PI / 4", "description": "The fully-lit cone width, in radians.", "name": "innerAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "innerAngle", "description": "The outer falloff cone width, in radians.", "name": "outerAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The z position of the light. If omitted, it will be set to `radius * 0.1`.", "name": "z" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Light" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Light" } }, "description": "The Light that was added." } ], "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#addConeLight", "scope": "instance", "___id": "T000002R012241", "___s": true }, { "comment": "/**\r\n * Removes a {@link Phaser.GameObjects.Light} from this Lights Manager. The Light will no longer\r\n * influence the rendering of any Game Objects. The Light object itself is not destroyed; it is\r\n * simply removed from the manager's active list.\r\n *\r\n * @method Phaser.GameObjects.LightsManager#removeLight\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Light} light - The Light to remove.\r\n *\r\n * @return {this} This Lights Manager instance.\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 367, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Removes a {@link Phaser.GameObjects.Light} from this Lights Manager. The Light will no longer\rinfluence the rendering of any Game Objects. The Light object itself is not destroyed; it is\rsimply removed from the manager's active list.", "kind": "function", "name": "removeLight", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Light" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Light" } }, "description": "The Light to remove.", "name": "light" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Lights Manager instance." } ], "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#removeLight", "scope": "instance", "___id": "T000002R012245", "___s": true }, { "comment": "/**\r\n * Shuts down the Lights Manager and clears all active Lights. This is called automatically\r\n * when a Scene shuts down. The Lights Manager can be re-enabled afterwards by calling\r\n * {@link Phaser.GameObjects.LightsManager#enable}.\r\n *\r\n * @method Phaser.GameObjects.LightsManager#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 391, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Shuts down the Lights Manager and clears all active Lights. This is called automatically\rwhen a Scene shuts down. The Lights Manager can be re-enabled afterwards by calling\r{@link Phaser.GameObjects.LightsManager#enable}.", "kind": "function", "name": "shutdown", "since": "3.0.0", "memberof": "Phaser.GameObjects.LightsManager", "longname": "Phaser.GameObjects.LightsManager#shutdown", "scope": "instance", "___id": "T000002R012248", "___s": true }, { "comment": "/**\r\n * Destroy the Lights Manager.\r\n *\r\n * Cleans up all references by calling {@link Phaser.GameObjects.LightsManager#shutdown}.\r\n *\r\n * @method Phaser.GameObjects.LightsManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LightsManager.js", "lineno": 404, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Destroy the Lights Manager.\r\rCleans 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", "___id": "T000002R012251", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Scene plugin that provides a {@link Phaser.GameObjects.LightsManager} for rendering objects with dynamic lighting.\r\n *\r\n * Available from within a Scene via `this.lights`.\r\n *\r\n * Add Lights using the {@link Phaser.GameObjects.LightsManager#addLight} method:\r\n *\r\n * ```javascript\r\n * // Enable the Lights Manager because it is disabled by default\r\n * this.lights.enable();\r\n *\r\n * // Create a Light at [400, 300] with a radius of 200\r\n * this.lights.addLight(400, 300, 200);\r\n * ```\r\n *\r\n * For Game Objects to be affected by the Lights when rendered, you will need to set them to use lighting like so:\r\n *\r\n * ```javascript\r\n * sprite.setLighting(true);\r\n * ```\r\n *\r\n * @class LightsPlugin\r\n * @extends Phaser.GameObjects.LightsManager\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene that this Lights Plugin belongs to.\r\n */", "meta": { "filename": "LightsPlugin.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "classdesc": "A Scene plugin that provides a {@link Phaser.GameObjects.LightsManager} for rendering objects with dynamic lighting.\r\rAvailable from within a Scene via `this.lights`.\r\rAdd Lights using the {@link Phaser.GameObjects.LightsManager#addLight} method:\r\r```javascript\r// Enable the Lights Manager because it is disabled by default\rthis.lights.enable();\r\r// Create a Light at [400, 300] with a radius of 200\rthis.lights.addLight(400, 300, 200);\r```\r\rFor Game Objects to be affected by the Lights when rendered, you will need to set them to use lighting like so:\r\r```javascript\rsprite.setLighting(true);\r```", "kind": "class", "name": "LightsPlugin", "augments": [ "Phaser.GameObjects.LightsManager" ], "memberof": "Phaser.GameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene that this Lights Plugin belongs to.", "name": "scene" } ], "scope": "static", "longname": "Phaser.GameObjects.LightsPlugin", "___id": "T000002R012258", "___s": true }, { "comment": "/**\r\n * A reference to the Scene that this Lights Plugin belongs to.\r\n *\r\n * @name Phaser.GameObjects.LightsPlugin#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LightsPlugin.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "A reference to the Scene that this Lights Plugin belongs to.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.LightsPlugin", "longname": "Phaser.GameObjects.LightsPlugin#scene", "scope": "instance", "kind": "member", "___id": "T000002R012262", "___s": true }, { "comment": "/**\r\n * A reference to the Scene's systems.\r\n *\r\n * @name Phaser.GameObjects.LightsPlugin#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LightsPlugin.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "A reference to the Scene's systems.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.LightsPlugin", "longname": "Phaser.GameObjects.LightsPlugin#systems", "scope": "instance", "kind": "member", "___id": "T000002R012264", "___s": true }, { "comment": "/**\r\n * Handles the boot event from the Scene's Event Emitter, subscribing to\r\n * the Scene's `shutdown` and `destroy` events so the plugin can clean up\r\n * its resources when the Scene is stopped or destroyed.\r\n *\r\n * @method Phaser.GameObjects.LightsPlugin#boot\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LightsPlugin.js", "lineno": 76, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Handles the boot event from the Scene's Event Emitter, subscribing to\rthe Scene's `shutdown` and `destroy` events so the plugin can clean up\rits resources when the Scene is stopped or destroyed.", "kind": "function", "name": "boot", "since": "3.0.0", "memberof": "Phaser.GameObjects.LightsPlugin", "longname": "Phaser.GameObjects.LightsPlugin#boot", "scope": "instance", "___id": "T000002R012266", "___s": true }, { "comment": "/**\r\n * Destroy the Lights Plugin.\r\n *\r\n * Cleans up all references.\r\n *\r\n * @method Phaser.GameObjects.LightsPlugin#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "LightsPlugin.js", "lineno": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\lights", "code": {} }, "description": "Destroy the Lights Plugin.\r\rCleans 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", "___id": "T000002R012269", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Mesh2D Game Object.\r\n *\r\n * A Mesh2D Game Object is used for the display of 2D meshes.\r\n * It is a WebGL only Game Object.\r\n * It contains a number of textured triangles.\r\n * Each triangle is defined by a set of three vertices,\r\n * with a position and texture coordinate; and a reference to a texture.\r\n *\r\n * Because the triangles define their own texture coordinates,\r\n * Mesh2D does not directly use frame data from the texture.\r\n * You should set up your own texture coordinates,\r\n * either by hand or using a texture atlas.\r\n *\r\n * The Mesh2D game object can batch together with quads from game objects\r\n * like Image, Sprite, and Text.\r\n * It supports several rendering strategies, and it's important to use the correct one.\r\n *\r\n * By default, it does not combine triangles into quads.\r\n * Each triangle is rendered as a single quad.\r\n * This is inefficient, so consider switching to one of the other strategies.\r\n *\r\n * Use the `buildOrderedIndices` method to precompute an optimized index list,\r\n * which arranges triangles into quad-forming pairs,\r\n * synthesizing degenerate triangles where a triangle has no edge-sharing partner.\r\n * You choose the optimization strategy (`0` fast, `1` medium, `2` high), paying the cost once when the topology is stable.\r\n * Use `useOrderedIndices` (and `setUseOrderedIndices`) to toggle between the ordered and unordered lists without rebuilding.\r\n * This strategy is best for static topology, where the triangles do not change.\r\n * (The vertices can change, but the triangles do not.)\r\n *\r\n * Use the `renderAsTriangles` method to render the mesh as individual triangles.\r\n * This is suitable for dynamic topology that cannot be optimized into quads ahead of time.\r\n * However, it uses a separate render node designed for textured triangles,\r\n * so it doesn't batch with quads.\r\n * This strategy is best for dynamic topology, where the arrangement of\r\n * triangles itself changes frequently.\r\n *\r\n * Prefer the ordered index list strategy where possible.\r\n * It needs to do less work at render time.\r\n *\r\n * If you can guarantee that the index list is already ordered,\r\n * you can set `useOrderedIndices` to `true` and generate `indicesOrdered` yourself.\r\n *\r\n * Mesh2D supports lighting. You should be careful not to distort\r\n * the mesh too far, or normal maps will look weird.\r\n * In particular, rotating texture coordinates will rotate the apparent light\r\n * direction.\r\n *\r\n * This is intended to be used as a base for dealing with 2D meshes.\r\n *\r\n * @class Mesh2D\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @webglonly\r\n * @constructor\r\n * @since 4.2.0\r\n *\r\n * @extends Phaser.GameObjects.Components.AlphaSingle\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.ComputedSize\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Flip\r\n * @extends Phaser.GameObjects.Components.GetBounds\r\n * @extends Phaser.GameObjects.Components.Lighting\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.TextureCrop\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {number[]} vertices - The vertices of the mesh. Each vertex is a sequence within the array: x, y, u, v. The array has a step of 4.\r\n * @param {number[]} indices - The indices of the mesh. Each index is a sequence: a, b, c, page. The abc values index to vertices in the vertices array. The page value is the index of the texture source in the texture atlas to use for this triangle. Typically 0. The array has a step of 4.\r\n * @param {boolean} [flipV=false] - Whether to flip the texture coordinates vertically. This affects texture coordinates, not the vertices. Set this property if your geometry provides texture coordinates that are opposite to GL texture expectations (which are bottom-up).\r\n */", "meta": { "filename": "Mesh2D.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh2d", "code": {} }, "classdesc": "A Mesh2D Game Object.\r\rA Mesh2D Game Object is used for the display of 2D meshes.\rIt is a WebGL only Game Object.\rIt contains a number of textured triangles.\rEach triangle is defined by a set of three vertices,\rwith a position and texture coordinate; and a reference to a texture.\r\rBecause the triangles define their own texture coordinates,\rMesh2D does not directly use frame data from the texture.\rYou should set up your own texture coordinates,\reither by hand or using a texture atlas.\r\rThe Mesh2D game object can batch together with quads from game objects\rlike Image, Sprite, and Text.\rIt supports several rendering strategies, and it's important to use the correct one.\r\rBy default, it does not combine triangles into quads.\rEach triangle is rendered as a single quad.\rThis is inefficient, so consider switching to one of the other strategies.\r\rUse the `buildOrderedIndices` method to precompute an optimized index list,\rwhich arranges triangles into quad-forming pairs,\rsynthesizing degenerate triangles where a triangle has no edge-sharing partner.\rYou choose the optimization strategy (`0` fast, `1` medium, `2` high), paying the cost once when the topology is stable.\rUse `useOrderedIndices` (and `setUseOrderedIndices`) to toggle between the ordered and unordered lists without rebuilding.\rThis strategy is best for static topology, where the triangles do not change.\r(The vertices can change, but the triangles do not.)\r\rUse the `renderAsTriangles` method to render the mesh as individual triangles.\rThis is suitable for dynamic topology that cannot be optimized into quads ahead of time.\rHowever, it uses a separate render node designed for textured triangles,\rso it doesn't batch with quads.\rThis strategy is best for dynamic topology, where the arrangement of\rtriangles itself changes frequently.\r\rPrefer the ordered index list strategy where possible.\rIt needs to do less work at render time.\r\rIf you can guarantee that the index list is already ordered,\ryou can set `useOrderedIndices` to `true` and generate `indicesOrdered` yourself.\r\rMesh2D supports lighting. You should be careful not to distort\rthe mesh too far, or normal maps will look weird.\rIn particular, rotating texture coordinates will rotate the apparent light\rdirection.\r\rThis is intended to be used as a base for dealing with 2D meshes.", "kind": "class", "name": "Mesh2D", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.AlphaSingle", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.ComputedSize", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.Flip", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Lighting", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.RenderNodes", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.TextureCrop", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.GameObjects", "tags": [ { "originalTitle": "webglonly", "title": "webglonly", "text": "" } ], "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The vertices of the mesh. Each vertex is a sequence within the array: x, y, u, v. The array has a step of 4.", "name": "vertices" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The indices of the mesh. Each index is a sequence: a, b, c, page. The abc values index to vertices in the vertices array. The page value is the index of the texture source in the texture atlas to use for this triangle. Typically 0. The array has a step of 4.", "name": "indices" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to flip the texture coordinates vertically. This affects texture coordinates, not the vertices. Set this property if your geometry provides texture coordinates that are opposite to GL texture expectations (which are bottom-up).", "name": "flipV" } ], "scope": "static", "longname": "Phaser.GameObjects.Mesh2D", "___id": "T000002R012280", "___s": true }, { "comment": "/**\r\n * The vertices of the mesh.\r\n * Each vertex is a sequence within the array:\r\n * x, y, u, v.\r\n * The array has a step of 4.\r\n *\r\n * - x (offset 0): The x position of the vertex.\r\n * - y (offset 1): The y position of the vertex.\r\n * - u (offset 2): The u texture coordinate of the vertex.\r\n * - v (offset 3): The v texture coordinate of the vertex.\r\n *\r\n * @name Phaser.GameObjects.Mesh2D#vertices\r\n * @type {number[]}\r\n * @since 4.2.0\r\n */", "meta": { "filename": "Mesh2D.js", "lineno": 121, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh2d", "code": {} }, "description": "The vertices of the mesh.\rEach vertex is a sequence within the array:\rx, y, u, v.\rThe array has a step of 4.\r\r- x (offset 0): The x position of the vertex.\r- y (offset 1): The y position of the vertex.\r- u (offset 2): The u texture coordinate of the vertex.\r- v (offset 3): The v texture coordinate of the vertex.", "name": "vertices", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.2.0", "memberof": "Phaser.GameObjects.Mesh2D", "longname": "Phaser.GameObjects.Mesh2D#vertices", "scope": "instance", "kind": "member", "___id": "T000002R012285", "___s": true }, { "comment": "/**\r\n * The indices of the mesh.\r\n * Each index is a sequence: a, b, c, page.\r\n * These index to vertices in the vertices array.\r\n * The array has a step of 4.\r\n *\r\n * - a (offset 0): The index of the first vertex.\r\n * - b (offset 1): The index of the second vertex.\r\n * - c (offset 2): The index of the third vertex.\r\n * - page (offset 3): The page of the triangle: which texture source\r\n * in the texture atlas is used for this triangle. Typically 0.\r\n *\r\n * @name Phaser.GameObjects.Mesh2D#indices\r\n * @type {number[]}\r\n * @since 4.2.0\r\n */", "meta": { "filename": "Mesh2D.js", "lineno": 138, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh2d", "code": {} }, "description": "The indices of the mesh.\rEach index is a sequence: a, b, c, page.\rThese index to vertices in the vertices array.\rThe array has a step of 4.\r\r- a (offset 0): The index of the first vertex.\r- b (offset 1): The index of the second vertex.\r- c (offset 2): The index of the third vertex.\r- page (offset 3): The page of the triangle: which texture source\r in the texture atlas is used for this triangle. Typically 0.", "name": "indices", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "4.2.0", "memberof": "Phaser.GameObjects.Mesh2D", "longname": "Phaser.GameObjects.Mesh2D#indices", "scope": "instance", "kind": "member", "___id": "T000002R012287", "___s": true }, { "comment": "/**\r\n * An optimized copy of the `indices` list, built by\r\n * `buildOrderedIndices`. It uses the same internal pattern as\r\n * `indices` (a sequence of `a, b, c, page` with a step of 4), but it\r\n * may be longer, because it can contain synthesized degenerate\r\n * triangles which pad single triangles out to complete quads.\r\n *\r\n * Triangles in this list are arranged in pairs. Each pair is intended\r\n * to be consumed as a single quad: the first triangle is `p, q, r` and\r\n * the second is `q, r, s`, where `q, r` is the shared edge, and `p, s`\r\n * are the corners unique to each triangle. When a triangle has no\r\n * partner, `s` repeats `r` to form a degenerate second triangle.\r\n *\r\n * This is `null` until `buildOrderedIndices` is called. Use\r\n * `useOrderedIndices` to control whether it is used.\r\n *\r\n * @name Phaser.GameObjects.Mesh2D#indicesOrdered\r\n * @type {?number[]}\r\n * @since 4.2.0\r\n * @default null\r\n */", "meta": { "filename": "Mesh2D.js", "lineno": 156, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh2d", "code": {} }, "description": "An optimized copy of the `indices` list, built by\r`buildOrderedIndices`. It uses the same internal pattern as\r`indices` (a sequence of `a, b, c, page` with a step of 4), but it\rmay be longer, because it can contain synthesized degenerate\rtriangles which pad single triangles out to complete quads.\r\rTriangles in this list are arranged in pairs. Each pair is intended\rto be consumed as a single quad: the first triangle is `p, q, r` and\rthe second is `q, r, s`, where `q, r` is the shared edge, and `p, s`\rare the corners unique to each triangle. When a triangle has no\rpartner, `s` repeats `r` to form a degenerate second triangle.\r\rThis is `null` until `buildOrderedIndices` is called. Use\r`useOrderedIndices` to control whether it is used.", "name": "indicesOrdered", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ], "nullable": true } }, "nullable": true, "since": "4.2.0", "defaultvalue": "null", "memberof": "Phaser.GameObjects.Mesh2D", "longname": "Phaser.GameObjects.Mesh2D#indicesOrdered", "scope": "instance", "kind": "member", "___id": "T000002R012289", "___s": true }, { "comment": "/**\r\n * Whether to use `indicesOrdered` instead of `indices` when rendering.\r\n *\r\n * This has no effect unless `indicesOrdered` has been populated by\r\n * `buildOrderedIndices`. It is safe to toggle at any time, allowing you\r\n * to switch between the ordered and unordered lists without rebuilding.\r\n *\r\n * @name Phaser.GameObjects.Mesh2D#useOrderedIndices\r\n * @type {boolean}\r\n * @since 4.2.0\r\n * @default false\r\n */", "meta": { "filename": "Mesh2D.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh2d", "code": {} }, "description": "Whether to use `indicesOrdered` instead of `indices` when rendering.\r\rThis has no effect unless `indicesOrdered` has been populated by\r`buildOrderedIndices`. It is safe to toggle at any time, allowing you\rto switch between the ordered and unordered lists without rebuilding.", "name": "useOrderedIndices", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.2.0", "defaultvalue": "false", "memberof": "Phaser.GameObjects.Mesh2D", "longname": "Phaser.GameObjects.Mesh2D#useOrderedIndices", "scope": "instance", "kind": "member", "___id": "T000002R012291", "___s": true }, { "comment": "/**\r\n * Whether to render this mesh as individual triangles, rather than\r\n * combining triangles into quads.\r\n *\r\n * When `true`, the renderer routes the mesh to a batch handler\r\n * optimized for individual triangles (`gl.TRIANGLES`). This is suitable\r\n * for dynamic topology which cannot be optimized into quads ahead of\r\n * time. When `false`, the mesh is rendered as quads, which batches with\r\n * regular sprites.\r\n *\r\n * @name Phaser.GameObjects.Mesh2D#renderAsTriangles\r\n * @type {boolean}\r\n * @since 4.2.0\r\n * @default false\r\n */", "meta": { "filename": "Mesh2D.js", "lineno": 193, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh2d", "code": {} }, "description": "Whether to render this mesh as individual triangles, rather than\rcombining triangles into quads.\r\rWhen `true`, the renderer routes the mesh to a batch handler\roptimized for individual triangles (`gl.TRIANGLES`). This is suitable\rfor dynamic topology which cannot be optimized into quads ahead of\rtime. When `false`, the mesh is rendered as quads, which batches with\rregular sprites.", "name": "renderAsTriangles", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.2.0", "defaultvalue": "false", "memberof": "Phaser.GameObjects.Mesh2D", "longname": "Phaser.GameObjects.Mesh2D#renderAsTriangles", "scope": "instance", "kind": "member", "___id": "T000002R012293", "___s": true }, { "comment": "/**\r\n * Whether to flip the texture coordinates vertically.\r\n *\r\n * This affects texture coordinates, not the vertices.\r\n * Set this property if your geometry provides texture coordinates\r\n * that are opposite to GL texture expectations (which are bottom-up).\r\n *\r\n * @name Phaser.GameObjects.Mesh2D#flipV\r\n * @type {boolean}\r\n * @since 4.2.0\r\n * @default false\r\n */", "meta": { "filename": "Mesh2D.js", "lineno": 210, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh2d", "code": {} }, "description": "Whether to flip the texture coordinates vertically.\r\rThis affects texture coordinates, not the vertices.\rSet this property if your geometry provides texture coordinates\rthat are opposite to GL texture expectations (which are bottom-up).", "name": "flipV", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.2.0", "defaultvalue": "false", "memberof": "Phaser.GameObjects.Mesh2D", "longname": "Phaser.GameObjects.Mesh2D#flipV", "scope": "instance", "kind": "member", "___id": "T000002R012295", "___s": true }, { "comment": "/**\r\n * Sets the vertical texture flip state of this Game Object.\r\n *\r\n * @param {boolean} [value=false] - Whether to flip the texture coordinates vertically.\r\n * @returns {this} This Game Object instance.\r\n */", "meta": { "range": [ 11401, 11494 ], "filename": "Mesh2D.js", "lineno": 283, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh2d", "code": { "id": "astnode100097209", "name": "setFlipV", "type": "FunctionExpression" }, "vars": { "this.flipV": null } }, "description": "Sets the vertical texture flip state of this Game Object.", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to flip the texture coordinates vertically.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "name": "setFlipV", "longname": "setFlipV", "kind": "function", "scope": "global", "___id": "T000002R012314", "___s": true }, { "comment": "/**\r\n * Sets whether to use `indicesOrdered` instead of `indices` when rendering.\r\n *\r\n * This has no side effects other than setting the property. It does not\r\n * rebuild `indicesOrdered`, so you may toggle freely between the ordered\r\n * and unordered lists. Call `buildOrderedIndices` to populate the ordered\r\n * list.\r\n *\r\n * @method Phaser.GameObjects.Mesh2D#setUseOrderedIndices\r\n * @since 4.2.0\r\n * @param {boolean} [value=false] - Whether to use the ordered index list.\r\n * @returns {this} This Game Object instance.\r\n */", "meta": { "filename": "Mesh2D.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh2d", "code": {} }, "description": "Sets whether to use `indicesOrdered` instead of `indices` when rendering.\r\rThis has no side effects other than setting the property. It does not\rrebuild `indicesOrdered`, so you may toggle freely between the ordered\rand unordered lists. Call `buildOrderedIndices` to populate the ordered\rlist.", "kind": "function", "name": "setUseOrderedIndices", "since": "4.2.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to use the ordered index list.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh2D", "longname": "Phaser.GameObjects.Mesh2D#setUseOrderedIndices", "scope": "instance", "___id": "T000002R012316", "___s": true }, { "comment": "/**\r\n * Sets whether to render this mesh as individual triangles.\r\n *\r\n * @method Phaser.GameObjects.Mesh2D#setRenderAsTriangles\r\n * @since 4.2.0\r\n * @param {boolean} [value=false] - Whether to render the mesh as individual triangles.\r\n * @returns {this} This Game Object instance.\r\n */", "meta": { "filename": "Mesh2D.js", "lineno": 308, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh2d", "code": {} }, "description": "Sets whether to render this mesh as individual triangles.", "kind": "function", "name": "setRenderAsTriangles", "since": "4.2.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to render the mesh as individual triangles.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh2D", "longname": "Phaser.GameObjects.Mesh2D#setRenderAsTriangles", "scope": "instance", "___id": "T000002R012319", "___s": true }, { "comment": "/**\r\n * Builds `indicesOrdered`, an optimized copy of `indices` in which\r\n * triangles are arranged into quad-forming pairs. Each pair consists of\r\n * two triangles `p, q, r` and `q, r, s`: where two triangles share an edge,\r\n * `q, r` is that shared edge and `p, s` are their unique corners; where a\r\n * triangle has no partner, the second triangle of the pair is degenerate\r\n * (`s` repeats `r`), padding the single triangle out to a full quad.\r\n *\r\n * Because this processes the entire `indices` list, you should only call\r\n * it when the topology is stable. The cost depends on the chosen strategy.\r\n *\r\n * @method Phaser.GameObjects.Mesh2D#buildOrderedIndices\r\n * @since 4.2.0\r\n * @param {number} [strategy=0] - The level of optimization to use.\r\n *\r\n * - `0`: Fast. Each triangle forms its own quad with a synthesized\r\n * degenerate triangle. No edge sharing is detected. This is quick to\r\n * build but the least memory efficient at render time.\r\n * - `1`: Medium. Each triangle checks only the next triangle for a shared\r\n * edge, forming a quad if one is found, otherwise padding with a\r\n * degenerate triangle.\r\n * - `2`: High. Every triangle is checked against every other triangle for a\r\n * shared edge, using an edge lookup to keep this tractable. This is the\r\n * slowest to build but the most memory efficient at render time.\r\n * @param {boolean} [useOrderedIndices] - If defined, also sets the `useOrderedIndices` property.\r\n * @returns {this} This Game Object instance.\r\n */", "meta": { "filename": "Mesh2D.js", "lineno": 322, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh2d", "code": {} }, "description": "Builds `indicesOrdered`, an optimized copy of `indices` in which\rtriangles are arranged into quad-forming pairs. Each pair consists of\rtwo triangles `p, q, r` and `q, r, s`: where two triangles share an edge,\r`q, r` is that shared edge and `p, s` are their unique corners; where a\rtriangle has no partner, the second triangle of the pair is degenerate\r(`s` repeats `r`), padding the single triangle out to a full quad.\r\rBecause this processes the entire `indices` list, you should only call\rit when the topology is stable. The cost depends on the chosen strategy.", "kind": "function", "name": "buildOrderedIndices", "since": "4.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The level of optimization to use.\r\r- `0`: Fast. Each triangle forms its own quad with a synthesized\r degenerate triangle. No edge sharing is detected. This is quick to\r build but the least memory efficient at render time.\r- `1`: Medium. Each triangle checks only the next triangle for a shared\r edge, forming a quad if one is found, otherwise padding with a\r degenerate triangle.\r- `2`: High. Every triangle is checked against every other triangle for a\r shared edge, using an edge lookup to keep this tractable. This is the\r slowest to build but the most memory efficient at render time.", "name": "strategy" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If defined, also sets the `useOrderedIndices` property.", "name": "useOrderedIndices" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Mesh2D", "longname": "Phaser.GameObjects.Mesh2D#buildOrderedIndices", "scope": "instance", "___id": "T000002R012322", "___s": true }, { "comment": "/**\r\n * Creates a new Mesh2D Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Mesh2D Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#mesh2d\r\n * @since 4.2.0\r\n *\r\n * @param {Phaser.Types.GameObjects.GameObjectConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Mesh2D} The Game Object that was created.\r\n */", "meta": { "filename": "Mesh2DCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh2d", "code": {} }, "description": "Creates a new Mesh2D Game Object and returns it.\r\rNote: This method will only be available if the Mesh2D Game Object has been built into Phaser.", "kind": "function", "name": "mesh2d", "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.GameObjectConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.Mesh2D" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Mesh2D" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#mesh2d", "scope": "instance", "___id": "T000002R012406", "___s": true }, { "comment": "/**\r\n * Creates a new Mesh2D Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Mesh2D Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#mesh2d\r\n * @since 4.2.0\r\n *\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {number[]} vertices - The vertices of the mesh.\r\n * @param {number[]} indices - The indices of the mesh.\r\n * @param {boolean} [flipV=false] - Whether to flip the texture vertically.\r\n *\r\n * @return {Phaser.GameObjects.Mesh2D} The Game Object that was created.\r\n */", "meta": { "filename": "Mesh2DFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\mesh2d", "code": {} }, "description": "Creates a new Mesh2D Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Mesh2D Game Object has been built into Phaser.", "kind": "function", "name": "mesh2d", "since": "4.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The vertices of the mesh.", "name": "vertices" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The indices of the mesh.", "name": "indices" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to flip the texture vertically.", "name": "flipV" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Mesh2D" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Mesh2D" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#mesh2d", "scope": "instance", "___id": "T000002R012416", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Nine Slice Game Object allows you to display a texture-based object that\r\n * can be stretched both horizontally and vertically, but that retains\r\n * fixed-sized corners. The dimensions of the corners are set via the\r\n * parameters to this class.\r\n *\r\n * This is extremely useful for UI and button like elements, where you need\r\n * them to expand to accommodate the content without distorting the texture.\r\n *\r\n * The texture you provide for this Game Object should be based on the\r\n * following layout structure:\r\n *\r\n * ```\r\n * A B\r\n * +---+----------------------+---+\r\n * C | 1 | 2 | 3 |\r\n * +---+----------------------+---+\r\n * | | | |\r\n * | 4 | 5 | 6 |\r\n * | | | |\r\n * +---+----------------------+---+\r\n * D | 7 | 8 | 9 |\r\n * +---+----------------------+---+\r\n * ```\r\n *\r\n * When changing this objects width and / or height:\r\n *\r\n * areas 1, 3, 7 and 9 (the corners) will remain unscaled\r\n * areas 2 and 8 will be stretched horizontally only\r\n * areas 4 and 6 will be stretched vertically only\r\n * area 5 will be stretched both horizontally and vertically\r\n *\r\n * You can also create a 3 slice Game Object:\r\n *\r\n * This works in a similar way, except you can only stretch it horizontally.\r\n * Therefore, it requires less configuration:\r\n *\r\n * ```\r\n * A B\r\n * +---+----------------------+---+\r\n * | | | |\r\n * C | 1 | 2 | 3 |\r\n * | | | |\r\n * +---+----------------------+---+\r\n * ```\r\n *\r\n * When changing this objects width (you cannot change its height)\r\n *\r\n * areas 1 and 3 will remain unscaled\r\n * area 2 will be stretched horizontally\r\n *\r\n * The above configuration concept is adapted from the Pixi NineSlicePlane.\r\n *\r\n * To specify a 3 slice object instead of a 9 slice you should only\r\n * provide the `leftWidth` and `rightWidth` parameters. To create a 9 slice\r\n * you must supply all parameters.\r\n *\r\n * The _minimum_ width this Game Object can be is the total of\r\n * `leftWidth` + `rightWidth`. The _minimum_ height this Game Object\r\n * can be is the total of `topHeight` + `bottomHeight`.\r\n * If you need to display this object at a smaller size, you can scale it.\r\n *\r\n * In terms of performance, using a 3 slice Game Object is the equivalent of\r\n * having 3 Sprites in a row. Using a 9 slice Game Object is the equivalent\r\n * of having 9 Sprites in a row. The vertices of this object are all batched\r\n * together and can co-exist with other Sprites and graphics on the display\r\n * list, without incurring any additional overhead.\r\n *\r\n * This Game Object can now populate its values automatically\r\n * if they have been set within Texture Packer 7.1.0 or above and exported with\r\n * the atlas json. If this is the case, you can just create this Game Object without\r\n * specifying anything more than the texture key and frame and it will pull the\r\n * area data from the atlas.\r\n *\r\n * This object does not support trimmed textures from Texture Packer.\r\n * Trimming interferes with the ability to stretch the texture correctly.\r\n *\r\n * @class NineSlice\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @extends Phaser.GameObjects.Components.AlphaSingle\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.GetBounds\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Texture\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} x - The horizontal position of the center of this Game Object in the world.\r\n * @param {number} y - The vertical position of the center of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n * @param {number} [width=256] - The width of the Nine Slice Game Object. You can adjust the width post-creation.\r\n * @param {number} [height=256] - The height of the Nine Slice Game Object. If this is a 3 slice object the height will be fixed to the height of the texture and cannot be changed.\r\n * @param {number} [leftWidth=10] - The size of the left vertical column (A).\r\n * @param {number} [rightWidth=10] - The size of the right vertical column (B).\r\n * @param {number} [topHeight=0] - The size of the top horizontal row (C). Set to zero or undefined to create a 3 slice object.\r\n * @param {number} [bottomHeight=0] - The size of the bottom horizontal row (D). Set to zero or undefined to create a 3 slice object.\r\n * @param {boolean} [tileX=false] - When enabled, the scalable horizontal regions are repeated across the object instead of being stretched. Each tile is still slightly stretched so that it remains visible in full, which may cause minor distortion but far less than pure stretching. The texture should be seamless to avoid visible artifacts between tiles.\r\n * @param {boolean} [tileY=false] - When enabled, the scalable vertical regions are repeated across the object instead of being stretched. Each tile is still slightly stretched so that it remains visible in full, which may cause minor distortion but far less than pure stretching. The texture should be seamless to avoid visible artifacts between tiles.\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "classdesc": "A Nine Slice Game Object allows you to display a texture-based object that\rcan be stretched both horizontally and vertically, but that retains\rfixed-sized corners. The dimensions of the corners are set via the\rparameters to this class.\r\rThis is extremely useful for UI and button like elements, where you need\rthem to expand to accommodate the content without distorting the texture.\r\rThe texture you provide for this Game Object should be based on the\rfollowing layout structure:\r\r```\r A B\r +---+----------------------+---+\r C | 1 | 2 | 3 |\r +---+----------------------+---+\r | | | |\r | 4 | 5 | 6 |\r | | | |\r +---+----------------------+---+\r D | 7 | 8 | 9 |\r +---+----------------------+---+\r```\r\rWhen changing this objects width and / or height:\r\r areas 1, 3, 7 and 9 (the corners) will remain unscaled\r areas 2 and 8 will be stretched horizontally only\r areas 4 and 6 will be stretched vertically only\r area 5 will be stretched both horizontally and vertically\r\rYou can also create a 3 slice Game Object:\r\rThis works in a similar way, except you can only stretch it horizontally.\rTherefore, it requires less configuration:\r\r```\r A B\r +---+----------------------+---+\r | | | |\r C | 1 | 2 | 3 |\r | | | |\r +---+----------------------+---+\r```\r\rWhen changing this objects width (you cannot change its height)\r\r areas 1 and 3 will remain unscaled\r area 2 will be stretched horizontally\r\rThe above configuration concept is adapted from the Pixi NineSlicePlane.\r\rTo specify a 3 slice object instead of a 9 slice you should only\rprovide the `leftWidth` and `rightWidth` parameters. To create a 9 slice\ryou must supply all parameters.\r\rThe _minimum_ width this Game Object can be is the total of\r`leftWidth` + `rightWidth`. The _minimum_ height this Game Object\rcan be is the total of `topHeight` + `bottomHeight`.\rIf you need to display this object at a smaller size, you can scale it.\r\rIn terms of performance, using a 3 slice Game Object is the equivalent of\rhaving 3 Sprites in a row. Using a 9 slice Game Object is the equivalent\rof having 9 Sprites in a row. The vertices of this object are all batched\rtogether and can co-exist with other Sprites and graphics on the display\rlist, without incurring any additional overhead.\r\rThis Game Object can now populate its values automatically\rif they have been set within Texture Packer 7.1.0 or above and exported with\rthe atlas json. If this is the case, you can just create this Game Object without\rspecifying anything more than the texture key and frame and it will pull the\rarea data from the atlas.\r\rThis object does not support trimmed textures from Texture Packer.\rTrimming interferes with the ability to stretch the texture correctly.", "kind": "class", "name": "NineSlice", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.AlphaSingle", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.RenderNodes", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Texture", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.GameObjects", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of the center of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of the center of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 256, "description": "The width of the Nine Slice Game Object. You can adjust the width post-creation.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 256, "description": "The height of the Nine Slice Game Object. If this is a 3 slice object the height will be fixed to the height of the texture and cannot be changed.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The size of the left vertical column (A).", "name": "leftWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The size of the right vertical column (B).", "name": "rightWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The size of the top horizontal row (C). Set to zero or undefined to create a 3 slice object.", "name": "topHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The size of the bottom horizontal row (D). Set to zero or undefined to create a 3 slice object.", "name": "bottomHeight" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "When enabled, the scalable horizontal regions are repeated across the object instead of being stretched. Each tile is still slightly stretched so that it remains visible in full, which may cause minor distortion but far less than pure stretching. The texture should be seamless to avoid visible artifacts between tiles.", "name": "tileX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "When enabled, the scalable vertical regions are repeated across the object instead of being stretched. Each tile is still slightly stretched so that it remains visible in full, which may cause minor distortion but far less than pure stretching. The texture should be seamless to avoid visible artifacts between tiles.", "name": "tileY" } ], "scope": "static", "longname": "Phaser.GameObjects.NineSlice", "___id": "T000002R012438", "___s": true }, { "comment": "/**\r\n * An array of Vertex objects that correspond to the quads that make-up\r\n * this Nine Slice Game Object. They are stored in the following order:\r\n *\r\n * Top Left - Indexes 0 - 5\r\n * Top Center - Indexes 6 - 11\r\n * Top Right - Indexes 12 - 17\r\n * Center Left - Indexes 18 - 23\r\n * Center - Indexes 24 - 29\r\n * Center Right - Indexes 30 - 35\r\n * Bottom Left - Indexes 36 - 41\r\n * Bottom Center - Indexes 42 - 47\r\n * Bottom Right - Indexes 48 - 53\r\n *\r\n * Each quad is represented by 6 Vertex instances.\r\n *\r\n * This array will contain 18 elements for a 3 slice object\r\n * and 54 for a nine slice object.\r\n *\r\n * You should never modify this array once it has been populated.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#vertices\r\n * @type {Phaser.GameObjects.NineSliceVertex[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 208, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "An array of Vertex objects that correspond to the quads that make-up\rthis Nine Slice Game Object. They are stored in the following order:\r\rTop Left - Indexes 0 - 5\rTop Center - Indexes 6 - 11\rTop Right - Indexes 12 - 17\rCenter Left - Indexes 18 - 23\rCenter - Indexes 24 - 29\rCenter Right - Indexes 30 - 35\rBottom Left - Indexes 36 - 41\rBottom Center - Indexes 42 - 47\rBottom Right - Indexes 48 - 53\r\rEach quad is represented by 6 Vertex instances.\r\rThis array will contain 18 elements for a 3 slice object\rand 54 for a nine slice object.\r\rYou should never modify this array once it has been populated.", "name": "vertices", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.NineSliceVertex", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#vertices", "scope": "instance", "kind": "member", "___id": "T000002R012453", "___s": true }, { "comment": "/**\r\n * The size of the left vertical bar (A).\r\n *\r\n * @name Phaser.GameObjects.NineSlice#leftWidth\r\n * @type {number}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 235, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The size of the left vertical bar (A).", "name": "leftWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#leftWidth", "scope": "instance", "kind": "member", "___id": "T000002R012455", "___s": true }, { "comment": "/**\r\n * The size of the right vertical bar (B).\r\n *\r\n * @name Phaser.GameObjects.NineSlice#rightWidth\r\n * @type {number}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 245, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The size of the right vertical bar (B).", "name": "rightWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#rightWidth", "scope": "instance", "kind": "member", "___id": "T000002R012457", "___s": true }, { "comment": "/**\r\n * The size of the top horizontal bar (C).\r\n *\r\n * If this is a 3 slice object this property will be set to the\r\n * height of the texture being used.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#topHeight\r\n * @type {number}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 255, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The size of the top horizontal bar (C).\r\rIf this is a 3 slice object this property will be set to the\rheight of the texture being used.", "name": "topHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#topHeight", "scope": "instance", "kind": "member", "___id": "T000002R012459", "___s": true }, { "comment": "/**\r\n * The size of the bottom horizontal bar (D).\r\n *\r\n * If this is a 3 slice object this property will be set to zero.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#bottomHeight\r\n * @type {number}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 268, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The size of the bottom horizontal bar (D).\r\rIf this is a 3 slice object this property will be set to zero.", "name": "bottomHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#bottomHeight", "scope": "instance", "kind": "member", "___id": "T000002R012461", "___s": true }, { "comment": "/**\r\n * Indicates whether the scalable horizontal regions of the Nine Slice\r\n * are repeated across the object instead of being stretched. Each tile\r\n * is still slightly stretched so that it remains visible in full.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#tileX\r\n * @type {boolean}\r\n * @readonly\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 280, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Indicates whether the scalable horizontal regions of the Nine Slice\rare repeated across the object instead of being stretched. Each tile\ris still slightly stretched so that it remains visible in full.", "name": "tileX", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "4.0.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#tileX", "scope": "instance", "kind": "member", "___id": "T000002R012463", "___s": true }, { "comment": "/**\r\n * Indicates whether the scalable vertical regions of the Nine Slice\r\n * are repeated across the object instead of being stretched. Each tile\r\n * is still slightly stretched so that it remains visible in full.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#tileY\r\n * @type {boolean}\r\n * @readonly\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 292, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Indicates whether the scalable vertical regions of the Nine Slice\rare repeated across the object instead of being stretched. Each tile\ris still slightly stretched so that it remains visible in full.", "name": "tileY", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "4.0.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#tileY", "scope": "instance", "kind": "member", "___id": "T000002R012465", "___s": true }, { "comment": "/**\r\n * The tint value being applied to the Game Object.\r\n * The value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#tint\r\n * @type {number}\r\n * @default 0xffffff\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 324, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The tint value being applied to the Game Object.\rThe value should be set as a hex number, i.e. 0xff0000 for red, or 0xff00ff for purple.", "name": "tint", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0xffffff", "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#tint", "scope": "instance", "kind": "member", "___id": "T000002R012471", "___s": true }, { "comment": "/**\r\n * The tint mode to use when applying the tint to the texture.\r\n *\r\n * Available modes are:\r\n * - Phaser.TintModes.MULTIPLY (default)\r\n * - Phaser.TintModes.FILL\r\n * - Phaser.TintModes.ADD\r\n * - Phaser.TintModes.SCREEN\r\n * - Phaser.TintModes.OVERLAY\r\n * - Phaser.TintModes.HARD_LIGHT\r\n *\r\n * @name Phaser.GameObjects.NineSlice#tintMode\r\n * @type {Phaser.TintModes}\r\n * @default Phaser.TintModes.MULTIPLY\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 335, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The tint mode to use when applying the tint to the texture.\r\rAvailable modes are:\r- Phaser.TintModes.MULTIPLY (default)\r- Phaser.TintModes.FILL\r- Phaser.TintModes.ADD\r- Phaser.TintModes.SCREEN\r- Phaser.TintModes.OVERLAY\r- Phaser.TintModes.HARD_LIGHT", "name": "tintMode", "type": { "names": [ "Phaser.TintModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.TintModes" } }, "defaultvalue": "Phaser.TintModes.MULTIPLY", "since": "4.0.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#tintMode", "scope": "instance", "kind": "member", "___id": "T000002R012473", "___s": true }, { "comment": "/**\r\n * This property is `true` if this Nine Slice Game Object was configured\r\n * with just `leftWidth` and `rightWidth` values, making it a 3-slice\r\n * instead of a 9-slice object.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#is3Slice\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 355, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "This property is `true` if this Nine Slice Game Object was configured\rwith just `leftWidth` and `rightWidth` values, making it a 3-slice\rinstead of a 9-slice object.", "name": "is3Slice", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#is3Slice", "scope": "instance", "kind": "member", "___id": "T000002R012476", "___s": true }, { "comment": "/**\r\n * Resets the width, height and slices for this NineSlice Game Object.\r\n *\r\n * This allows you to modify the texture being used by this object and then reset the slice configuration,\r\n * to avoid having to destroy this Game Object in order to use it for a different game element.\r\n *\r\n * Please note that you cannot change a 9-slice to a 3-slice or vice versa.\r\n *\r\n * @method Phaser.GameObjects.NineSlice#setSlices\r\n * @since 3.60.0\r\n *\r\n * @param {number} [width=256] - The width of the Nine Slice Game Object. You can adjust the width post-creation.\r\n * @param {number} [height=256] - The height of the Nine Slice Game Object. If this is a 3 slice object the height will be fixed to the height of the texture and cannot be changed.\r\n * @param {number} [leftWidth=10] - The size of the left vertical column (A).\r\n * @param {number} [rightWidth=10] - The size of the right vertical column (B).\r\n * @param {number} [topHeight=0] - The size of the top horizontal row (C). Set to zero or undefined to create a 3 slice object.\r\n * @param {number} [bottomHeight=0] - The size of the bottom horizontal row (D). Set to zero or undefined to create a 3 slice object.\r\n * @param {boolean} [skipScale9=false] - If this Nine Slice was created from Texture Packer scale9 atlas data, set this property to use the given column sizes instead of those specified in the JSON.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 407, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Resets the width, height and slices for this NineSlice Game Object.\r\rThis allows you to modify the texture being used by this object and then reset the slice configuration,\rto avoid having to destroy this Game Object in order to use it for a different game element.\r\rPlease note that you cannot change a 9-slice to a 3-slice or vice versa.", "kind": "function", "name": "setSlices", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 256, "description": "The width of the Nine Slice Game Object. You can adjust the width post-creation.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 256, "description": "The height of the Nine Slice Game Object. If this is a 3 slice object the height will be fixed to the height of the texture and cannot be changed.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The size of the left vertical column (A).", "name": "leftWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The size of the right vertical column (B).", "name": "rightWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The size of the top horizontal row (C). Set to zero or undefined to create a 3 slice object.", "name": "topHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The size of the bottom horizontal row (D). Set to zero or undefined to create a 3 slice object.", "name": "bottomHeight" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If this Nine Slice was created from Texture Packer scale9 atlas data, set this property to use the given column sizes instead of those specified in the JSON.", "name": "skipScale9" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#setSlices", "scope": "instance", "___id": "T000002R012484", "___s": true }, { "comment": "/**\r\n * Updates all of the vertex UV coordinates. This is called automatically\r\n * when the NineSlice Game Object is created, or if the texture frame changes.\r\n *\r\n * Unlike with the `updateVertices` method, you do not need to call this\r\n * method if the Nine Slice changes size. Only if it changes texture frame.\r\n *\r\n * @method Phaser.GameObjects.NineSlice#updateUVs\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 504, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Updates all of the vertex UV coordinates. This is called automatically\rwhen the NineSlice Game Object is created, or if the texture frame changes.\r\rUnlike with the `updateVertices` method, you do not need to call this\rmethod if the Nine Slice changes size. Only if it changes texture frame.", "kind": "function", "name": "updateUVs", "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#updateUVs", "scope": "instance", "___id": "T000002R012515", "___s": true }, { "comment": "/**\r\n * Recalculates all of the vertices in this Nine Slice Game Object\r\n * based on the `leftWidth`, `rightWidth`, `topHeight`, `bottomHeight`,\r\n * `tileX` and `tileY` properties, combined with the Game Object size.\r\n *\r\n * This method is called automatically when this object is created\r\n * or if its origin is changed.\r\n *\r\n * You should not typically need to call this method directly, but it\r\n * is left public should you find a need to modify one of those properties\r\n * after creation.\r\n *\r\n * @method Phaser.GameObjects.NineSlice#updateVertices\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 580, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Recalculates all of the vertices in this Nine Slice Game Object\rbased on the `leftWidth`, `rightWidth`, `topHeight`, `bottomHeight`,\r`tileX` and `tileY` properties, combined with the Game Object size.\r\rThis method is called automatically when this object is created\ror if its origin is changed.\r\rYou should not typically need to call this method directly, but it\ris left public should you find a need to modify one of those properties\rafter creation.", "kind": "function", "name": "updateVertices", "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#updateVertices", "scope": "instance", "___id": "T000002R012537", "___s": true }, { "comment": "/**\r\n * Internally updates the position coordinates across all vertices of the\r\n * given quad offset.\r\n *\r\n * You should not typically need to call this method directly, but it\r\n * is left public should an extended class require it.\r\n *\r\n * @method Phaser.GameObjects.NineSlice#updateQuad\r\n * @since 3.60.0\r\n *\r\n * @param {number} offset - The offset in the vertices array of the quad to update.\r\n * @param {number} x1 - The top-left X coordinate of the quad, in normalized space (-0.5 to 0.5).\r\n * @param {number} y1 - The top-left Y coordinate of the quad, in normalized space (-0.5 to 0.5).\r\n * @param {number} x2 - The bottom-right X coordinate of the quad, in normalized space (-0.5 to 0.5).\r\n * @param {number} y2 - The bottom-right Y coordinate of the quad, in normalized space (-0.5 to 0.5).\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 756, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Internally updates the position coordinates across all vertices of the\rgiven quad offset.\r\rYou should not typically need to call this method directly, but it\ris left public should an extended class require it.", "kind": "function", "name": "updateQuad", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The offset in the vertices array of the quad to update.", "name": "offset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left X coordinate of the quad, in normalized space (-0.5 to 0.5).", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left Y coordinate of the quad, in normalized space (-0.5 to 0.5).", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right X coordinate of the quad, in normalized space (-0.5 to 0.5).", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right Y coordinate of the quad, in normalized space (-0.5 to 0.5).", "name": "y2" } ], "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#updateQuad", "scope": "instance", "___id": "T000002R012582", "___s": true }, { "comment": "/**\r\n * Internally updates the UV coordinates across all vertices of the\r\n * given quad offset, based on the frame size.\r\n *\r\n * You should not typically need to call this method directly, but it\r\n * is left public should an extended class require it.\r\n *\r\n * @method Phaser.GameObjects.NineSlice#updateQuadUVs\r\n * @since 3.60.0\r\n *\r\n * @param {number} offset - The offset in the vertices array of the quad to update.\r\n * @param {number} u1 - The top-left U coordinate of the quad, in the range 0 to 1.\r\n * @param {number} v1 - The top-left V coordinate of the quad, in the range 0 to 1.\r\n * @param {number} u2 - The bottom-right U coordinate of the quad, in the range 0 to 1.\r\n * @param {number} v2 - The bottom-right V coordinate of the quad, in the range 0 to 1.\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 789, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Internally updates the UV coordinates across all vertices of the\rgiven quad offset, based on the frame size.\r\rYou should not typically need to call this method directly, but it\ris left public should an extended class require it.", "kind": "function", "name": "updateQuadUVs", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The offset in the vertices array of the quad to update.", "name": "offset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left U coordinate of the quad, in the range 0 to 1.", "name": "u1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left V coordinate of the quad, in the range 0 to 1.", "name": "v1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right U coordinate of the quad, in the range 0 to 1.", "name": "u2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right V coordinate of the quad, in the range 0 to 1.", "name": "v2" } ], "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#updateQuadUVs", "scope": "instance", "___id": "T000002R012589", "___s": true }, { "comment": "/**\r\n * Clears all tint values associated with this Game Object.\r\n *\r\n * Immediately sets the color values back to 0xffffff and the tint type to 'multiply',\r\n * which results in no visible change to the texture.\r\n *\r\n * @method Phaser.GameObjects.NineSlice#clearTint\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 842, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Clears all tint values associated with this Game Object.\r\rImmediately sets the color values back to 0xffffff and the tint type to 'multiply',\rwhich results in no visible change to the texture.", "kind": "function", "name": "clearTint", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#clearTint", "scope": "instance", "___id": "T000002R012603", "___s": true }, { "comment": "/**\r\n * Sets a tint on this Game Object.\r\n *\r\n * The tint applies a color to the pixel color values\r\n * from the GameObject's texture in one of several modes,\r\n * set with `setTintMode` or the `tintMode` property.\r\n *\r\n * To modify the tint color once set, either call this method again with new values or use the\r\n * `tint` property.\r\n *\r\n * To remove a tint call `clearTint`, or call this method with no parameters.\r\n *\r\n * @method Phaser.GameObjects.NineSlice#setTint\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {number} [color=0xffffff] - The tint being applied to the entire Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 862, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Sets a tint on this Game Object.\r\rThe tint applies a color to the pixel color values\rfrom the GameObject's texture in one of several modes,\rset with `setTintMode` or the `tintMode` property.\r\rTo modify the tint color once set, either call this method again with new values or use the\r`tint` property.\r\rTo remove a tint call `clearTint`, or call this method with no parameters.", "kind": "function", "name": "setTint", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The tint being applied to the entire Game Object.", "name": "color" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#setTint", "scope": "instance", "___id": "T000002R012605", "___s": true }, { "comment": "/**\r\n * Sets the tint mode for this Game Object.\r\n *\r\n * The tint mode applies a color to the pixel color values\r\n * from the GameObject's texture in one of several modes:\r\n *\r\n * - Phaser.TintModes.MULTIPLY (default)\r\n * - Phaser.TintModes.FILL\r\n * - Phaser.TintModes.ADD\r\n * - Phaser.TintModes.SCREEN\r\n * - Phaser.TintModes.OVERLAY\r\n * - Phaser.TintModes.HARD_LIGHT\r\n *\r\n * @method Phaser.GameObjects.NineSlice#setTintMode\r\n * @webglOnly\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.TintModes} [mode=Phaser.TintModes.MULTIPLY] - The tint mode to use.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 891, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Sets the tint mode for this Game Object.\r\rThe tint mode applies a color to the pixel color values\rfrom the GameObject's texture in one of several modes:\r\r- Phaser.TintModes.MULTIPLY (default)\r- Phaser.TintModes.FILL\r- Phaser.TintModes.ADD\r- Phaser.TintModes.SCREEN\r- Phaser.TintModes.OVERLAY\r- Phaser.TintModes.HARD_LIGHT", "kind": "function", "name": "setTintMode", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.TintModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.TintModes" } }, "optional": true, "defaultvalue": "Phaser.TintModes.MULTIPLY", "description": "The tint mode to use.", "name": "mode" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#setTintMode", "scope": "instance", "___id": "T000002R012609", "___s": true }, { "comment": "/**\r\n * Does this Game Object have a tint applied?\r\n *\r\n * It checks to see if the tint property is set to a value other than 0xffffff\r\n * or the tint mode is not the default Phaser.TintModes.MULTIPLY.\r\n * This indicates that a Game Object is tinted.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#isTinted\r\n * @type {boolean}\r\n * @webglOnly\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 920, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Does this Game Object have a tint applied?\r\rIt checks to see if the tint property is set to a value other than 0xffffff\ror the tint mode is not the default Phaser.TintModes.MULTIPLY.\rThis indicates that a Game Object is tinted.", "name": "isTinted", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#isTinted", "scope": "instance", "kind": "member", "___id": "T000002R012613", "___s": true }, { "comment": "/**\r\n * The displayed width of this Game Object.\r\n *\r\n * Setting this value will adjust the way in which this Nine Slice\r\n * object scales horizontally, if configured to do so.\r\n *\r\n * The _minimum_ width this Game Object can be is the total of\r\n * `leftWidth` + `rightWidth`. If you need to display this object\r\n * at a smaller size, you can also scale it.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#width\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 942, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The displayed width of this Game Object.\r\rSetting this value will adjust the way in which this Nine Slice\robject scales horizontally, if configured to do so.\r\rThe _minimum_ width this Game Object can be is the total of\r`leftWidth` + `rightWidth`. If you need to display this object\rat a smaller size, you can also scale it.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#width", "scope": "instance", "kind": "member", "___id": "T000002R012616", "___s": true }, { "comment": "/**\r\n * The displayed height of this Game Object.\r\n *\r\n * Setting this value will adjust the way in which this Nine Slice\r\n * object scales vertically, if configured to do so.\r\n *\r\n * The _minimum_ height this Game Object can be is the total of\r\n * `topHeight` + `bottomHeight`. If you need to display this object\r\n * at a smaller size, you can also scale it.\r\n *\r\n * If this is a 3-slice object, you can only stretch it horizontally\r\n * and changing the height will be ignored.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#height\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 972, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The displayed height of this Game Object.\r\rSetting this value will adjust the way in which this Nine Slice\robject scales vertically, if configured to do so.\r\rThe _minimum_ height this Game Object can be is the total of\r`topHeight` + `bottomHeight`. If you need to display this object\rat a smaller size, you can also scale it.\r\rIf this is a 3-slice object, you can only stretch it horizontally\rand changing the height will be ignored.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#height", "scope": "instance", "kind": "member", "___id": "T000002R012621", "___s": true }, { "comment": "/**\r\n * The displayed width of this Game Object.\r\n *\r\n * This value takes into account the scale factor.\r\n *\r\n * Setting this value will adjust the Game Object's scale property.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#displayWidth\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 1008, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The displayed width of this Game Object.\r\rThis value takes into account the scale factor.\r\rSetting this value will adjust the Game Object's scale property.", "name": "displayWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#displayWidth", "scope": "instance", "kind": "member", "___id": "T000002R012626", "___s": true }, { "comment": "/**\r\n * The displayed height of this Game Object.\r\n *\r\n * This value takes into account the scale factor.\r\n *\r\n * Setting this value will adjust the Game Object's scale property.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#displayHeight\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 1033, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The displayed height of this Game Object.\r\rThis value takes into account the scale factor.\r\rSetting this value will adjust the Game Object's scale property.", "name": "displayHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#displayHeight", "scope": "instance", "kind": "member", "___id": "T000002R012631", "___s": true }, { "comment": "/**\r\n * Sets the size of this Game Object.\r\n *\r\n * For a Nine Slice Game Object this means it will be stretched (or shrunk) horizontally\r\n * and vertically depending on the dimensions given to this method, in accordance with\r\n * how it has been configured for the various corner sizes.\r\n *\r\n * If this is a 3-slice object, you can only stretch it horizontally\r\n * and changing the height will be ignored.\r\n *\r\n * If you have enabled this Game Object for input, changing the size will also change the\r\n * size of the hit area.\r\n *\r\n * @method Phaser.GameObjects.NineSlice#setSize\r\n * @since 3.60.0\r\n *\r\n * @param {number} width - The width of this Game Object.\r\n * @param {number} height - The height of this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 1058, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Sets the size of this Game Object.\r\rFor a Nine Slice Game Object this means it will be stretched (or shrunk) horizontally\rand vertically depending on the dimensions given to this method, in accordance with\rhow it has been configured for the various corner sizes.\r\rIf this is a 3-slice object, you can only stretch it horizontally\rand changing the height will be ignored.\r\rIf you have enabled this Game Object for input, changing the size will also change the\rsize of the hit area.", "kind": "function", "name": "setSize", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#setSize", "scope": "instance", "___id": "T000002R012636", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Game Object.\r\n *\r\n * Calling this will adjust the scale.\r\n *\r\n * @method Phaser.GameObjects.NineSlice#setDisplaySize\r\n * @since 3.60.0\r\n *\r\n * @param {number} width - The width of this Game Object.\r\n * @param {number} height - The height of this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 1097, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Sets the display size of this Game Object.\r\rCalling this will adjust the scale.", "kind": "function", "name": "setDisplaySize", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#setDisplaySize", "scope": "instance", "___id": "T000002R012643", "___s": true }, { "comment": "/**\r\n * The horizontal origin of this Game Object.\r\n * The origin maps the relationship between the size and position of the Game Object.\r\n * The default value is 0.5, meaning all Game Objects are positioned based on their center.\r\n * Setting the value to 0 means the position now relates to the left of the Game Object.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#originX\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 1118, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The horizontal origin of this Game Object.\rThe origin maps the relationship between the size and position of the Game Object.\rThe default value is 0.5, meaning all Game Objects are positioned based on their center.\rSetting the value to 0 means the position now relates to the left of the Game Object.", "name": "originX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#originX", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Components.Origin#originX", "___id": "T000002R012647", "___s": true }, { "comment": "/**\r\n * The vertical origin of this Game Object.\r\n * The origin maps the relationship between the size and position of the Game Object.\r\n * The default value is 0.5, meaning all Game Objects are positioned based on their center.\r\n * Setting the value to 0 means the position now relates to the top of the Game Object.\r\n *\r\n * @name Phaser.GameObjects.NineSlice#originY\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 1143, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The vertical origin of this Game Object.\rThe origin maps the relationship between the size and position of the Game Object.\rThe default value is 0.5, meaning all Game Objects are positioned based on their center.\rSetting the value to 0 means the position now relates to the top of the Game Object.", "name": "originY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#originY", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Components.Origin#originY", "___id": "T000002R012652", "___s": true }, { "comment": "/**\r\n * Sets the origin of this Game Object.\r\n *\r\n * The values are given in the range 0 to 1.\r\n *\r\n * @method Phaser.GameObjects.NineSlice#setOrigin\r\n * @since 3.60.0\r\n *\r\n * @param {number} [x=0.5] - The horizontal origin value.\r\n * @param {number} [y=x] - The vertical origin value. If not defined it will be set to the value of `x`.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 1168, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Sets the origin of this Game Object.\r\rThe values are given in the range 0 to 1.", "kind": "function", "name": "setOrigin", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "The horizontal origin value.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#setOrigin", "scope": "instance", "overrides": "Phaser.GameObjects.Components.Origin#setOrigin", "___id": "T000002R012657", "___s": true }, { "comment": "/**\r\n * Resets the size of this Nine Slice Game Object to match the current texture frame.\r\n *\r\n * For a 3-slice object, this sets the height to match the frame height and refreshes\r\n * the UV coordinates. For a 9-slice object, only the UVs are refreshed. This is called\r\n * automatically when the texture frame changes and should not normally need to be\r\n * called directly.\r\n *\r\n * @method Phaser.GameObjects.NineSlice#setSizeToFrame\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "NineSlice.js", "lineno": 1194, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Resets the size of this Nine Slice Game Object to match the current texture frame.\r\rFor a 3-slice object, this sets the height to match the frame height and refreshes\rthe UV coordinates. For a 9-slice object, only the UVs are refreshed. This is called\rautomatically when the texture frame changes and should not normally need to be\rcalled directly.", "kind": "function", "name": "setSizeToFrame", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.NineSlice", "longname": "Phaser.GameObjects.NineSlice#setSizeToFrame", "scope": "instance", "___id": "T000002R012663", "___s": true }, { "comment": "/**\r\n * Creates a new Nine Slice Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Nine Slice Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#nineslice\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.GameObjects.NineSlice.NineSliceConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.NineSlice} The Game Object that was created.\r\n */", "meta": { "filename": "NineSliceCreator.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Creates a new Nine Slice Game Object and returns it.\r\rNote: This method will only be available if the Nine Slice Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "nineslice", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.NineSlice.NineSliceConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NineSlice.NineSliceConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.NineSlice" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.NineSlice" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#nineslice", "scope": "instance", "___id": "T000002R012678", "___s": true }, { "comment": "/**\r\n * A Nine Slice Game Object allows you to display a texture-based object that\r\n * can be stretched both horizontally and vertically, but that retains\r\n * fixed-sized corners. The dimensions of the corners are set via the\r\n * parameters to this class.\r\n *\r\n * This is extremely useful for UI and button like elements, where you need\r\n * them to expand to accommodate the content without distorting the texture.\r\n *\r\n * The texture you provide for this Game Object should be based on the\r\n * following layout structure:\r\n *\r\n * ```\r\n * A B\r\n * +---+----------------------+---+\r\n * C | 1 | 2 | 3 |\r\n * +---+----------------------+---+\r\n * | | | |\r\n * | 4 | 5 | 6 |\r\n * | | | |\r\n * +---+----------------------+---+\r\n * D | 7 | 8 | 9 |\r\n * +---+----------------------+---+\r\n * ```\r\n *\r\n * When changing this object's width and / or height:\r\n *\r\n * areas 1, 3, 7 and 9 (the corners) will remain unscaled\r\n * areas 2 and 8 will be stretched horizontally only\r\n * areas 4 and 6 will be stretched vertically only\r\n * area 5 will be stretched both horizontally and vertically\r\n *\r\n * You can also create a 3 slice Game Object:\r\n *\r\n * This works in a similar way, except you can only stretch it horizontally.\r\n * Therefore, it requires less configuration:\r\n *\r\n * ```\r\n * A B\r\n * +---+----------------------+---+\r\n * | | | |\r\n * C | 1 | 2 | 3 |\r\n * | | | |\r\n * +---+----------------------+---+\r\n * ```\r\n *\r\n * When changing this object's width (you cannot change its height)\r\n *\r\n * areas 1 and 3 will remain unscaled\r\n * area 2 will be stretched horizontally\r\n *\r\n * The above configuration concept is adapted from the Pixi NineSlicePlane.\r\n *\r\n * To specify a 3 slice object instead of a 9 slice you should only\r\n * provide the `leftWidth` and `rightWidth` parameters. To create a 9 slice\r\n * you must supply all parameters.\r\n *\r\n * The _minimum_ width this Game Object can be is the total of\r\n * `leftWidth` + `rightWidth`. The _minimum_ height this Game Object\r\n * can be is the total of `topHeight` + `bottomHeight`.\r\n * If you need to display this object at a smaller size, you can scale it.\r\n *\r\n * In terms of performance, using a 3 slice Game Object is the equivalent of\r\n * having 3 Sprites in a row. Using a 9 slice Game Object is the equivalent\r\n * of having 9 Sprites in a row. The vertices of this object are all batched\r\n * together and can co-exist with other Sprites and graphics on the display\r\n * list, without incurring any additional overhead.\r\n *\r\n * As of Phaser 3.60 this Game Object is WebGL only.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#nineslice\r\n * @webglOnly\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The horizontal position of the center of this Game Object in the world.\r\n * @param {number} y - The vertical position of the center of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n * @param {number} [width=256] - The width of the Nine Slice Game Object. You can adjust the width post-creation.\r\n * @param {number} [height=256] - The height of the Nine Slice Game Object. If this is a 3 slice object the height will be fixed to the height of the texture and cannot be changed.\r\n * @param {number} [leftWidth=10] - The size of the left vertical column (A).\r\n * @param {number} [rightWidth=10] - The size of the right vertical column (B).\r\n * @param {number} [topHeight=0] - The size of the top horizontal row (C). Set to zero or undefined to create a 3 slice object.\r\n * @param {number} [bottomHeight=0] - The size of the bottom horizontal row (D). Set to zero or undefined to create a 3 slice object.\r\n * @param {boolean} [tileX=false] - Whether to tile the horizontal regions instead of stretching them. Some stretching will still occur to keep the tile count a whole number.\r\n * @param {boolean} [tileY=false] - Whether to tile the vertical regions instead of stretching them. Some stretching will still occur to keep the tile count a whole number.\r\n *\r\n * @return {Phaser.GameObjects.NineSlice} The Game Object that was created.\r\n */", "meta": { "filename": "NineSliceFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "A Nine Slice Game Object allows you to display a texture-based object that\rcan be stretched both horizontally and vertically, but that retains\rfixed-sized corners. The dimensions of the corners are set via the\rparameters to this class.\r\rThis is extremely useful for UI and button like elements, where you need\rthem to expand to accommodate the content without distorting the texture.\r\rThe texture you provide for this Game Object should be based on the\rfollowing layout structure:\r\r```\r A B\r +---+----------------------+---+\r C | 1 | 2 | 3 |\r +---+----------------------+---+\r | | | |\r | 4 | 5 | 6 |\r | | | |\r +---+----------------------+---+\r D | 7 | 8 | 9 |\r +---+----------------------+---+\r```\r\rWhen changing this object's width and / or height:\r\r areas 1, 3, 7 and 9 (the corners) will remain unscaled\r areas 2 and 8 will be stretched horizontally only\r areas 4 and 6 will be stretched vertically only\r area 5 will be stretched both horizontally and vertically\r\rYou can also create a 3 slice Game Object:\r\rThis works in a similar way, except you can only stretch it horizontally.\rTherefore, it requires less configuration:\r\r```\r A B\r +---+----------------------+---+\r | | | |\r C | 1 | 2 | 3 |\r | | | |\r +---+----------------------+---+\r```\r\rWhen changing this object's width (you cannot change its height)\r\r areas 1 and 3 will remain unscaled\r area 2 will be stretched horizontally\r\rThe above configuration concept is adapted from the Pixi NineSlicePlane.\r\rTo specify a 3 slice object instead of a 9 slice you should only\rprovide the `leftWidth` and `rightWidth` parameters. To create a 9 slice\ryou must supply all parameters.\r\rThe _minimum_ width this Game Object can be is the total of\r`leftWidth` + `rightWidth`. The _minimum_ height this Game Object\rcan be is the total of `topHeight` + `bottomHeight`.\rIf you need to display this object at a smaller size, you can scale it.\r\rIn terms of performance, using a 3 slice Game Object is the equivalent of\rhaving 3 Sprites in a row. Using a 9 slice Game Object is the equivalent\rof having 9 Sprites in a row. The vertices of this object are all batched\rtogether and can co-exist with other Sprites and graphics on the display\rlist, without incurring any additional overhead.\r\rAs of Phaser 3.60 this Game Object is WebGL only.", "kind": "function", "name": "nineslice", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of the center of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of the center of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 256, "description": "The width of the Nine Slice Game Object. You can adjust the width post-creation.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 256, "description": "The height of the Nine Slice Game Object. If this is a 3 slice object the height will be fixed to the height of the texture and cannot be changed.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The size of the left vertical column (A).", "name": "leftWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The size of the right vertical column (B).", "name": "rightWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The size of the top horizontal row (C). Set to zero or undefined to create a 3 slice object.", "name": "topHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The size of the bottom horizontal row (D). Set to zero or undefined to create a 3 slice object.", "name": "bottomHeight" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to tile the horizontal regions instead of stretching them. Some stretching will still occur to keep the tile count a whole number.", "name": "tileX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to tile the vertical regions instead of stretching them. Some stretching will still occur to keep the tile count a whole number.", "name": "tileY" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.NineSlice" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.NineSlice" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#nineslice", "scope": "instance", "___id": "T000002R012694", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Represents a single vertex within a NineSlice Game Object.\r\n *\r\n * A NineSlice Game Object is divided into a 3x3 grid of regions, each defined by a mesh\r\n * of vertices. This class stores all the data needed for one vertex: its normalized position\r\n * (x, y inherited from Vector2), its projected screen-space position (vx, vy), and its\r\n * UV texture coordinates (u, v) used during rendering.\r\n *\r\n * You do not typically create NineSliceVertex instances directly. They are created and\r\n * managed internally by the NineSlice Game Object.\r\n *\r\n * @class NineSliceVertex\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @extends Phaser.Math.Vector2\r\n * @since 4.0.0\r\n *\r\n * @param {number} x - The x position of the vertex.\r\n * @param {number} y - The y position of the vertex.\r\n * @param {number} u - The UV u coordinate of the vertex.\r\n * @param {number} v - The UV v coordinate of the vertex.\r\n */", "meta": { "filename": "NineSliceVertex.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "classdesc": "Represents a single vertex within a NineSlice Game Object.\r\rA NineSlice Game Object is divided into a 3x3 grid of regions, each defined by a mesh\rof vertices. This class stores all the data needed for one vertex: its normalized position\r(x, y inherited from Vector2), its projected screen-space position (vx, vy), and its\rUV texture coordinates (u, v) used during rendering.\r\rYou do not typically create NineSliceVertex instances directly. They are created and\rmanaged internally by the NineSlice Game Object.", "kind": "class", "name": "NineSliceVertex", "memberof": "Phaser.GameObjects", "augments": [ "Phaser.Math.Vector2" ], "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the vertex.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the vertex.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The UV u coordinate of the vertex.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The UV v coordinate of the vertex.", "name": "v" } ], "scope": "static", "longname": "Phaser.GameObjects.NineSliceVertex", "___id": "T000002R012704", "___s": true }, { "comment": "/**\r\n * The projected x coordinate of this vertex.\r\n *\r\n * @name Phaser.GameObjects.NineSliceVertex#vx\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NineSliceVertex.js", "lineno": 43, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The projected x coordinate of this vertex.", "name": "vx", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.NineSliceVertex", "longname": "Phaser.GameObjects.NineSliceVertex#vx", "scope": "instance", "kind": "member", "___id": "T000002R012708", "___s": true }, { "comment": "/**\r\n * The projected y coordinate of this vertex.\r\n *\r\n * @name Phaser.GameObjects.NineSliceVertex#vy\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NineSliceVertex.js", "lineno": 52, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "The projected y coordinate of this vertex.", "name": "vy", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.NineSliceVertex", "longname": "Phaser.GameObjects.NineSliceVertex#vy", "scope": "instance", "kind": "member", "___id": "T000002R012710", "___s": true }, { "comment": "/**\r\n * UV u coordinate of this vertex.\r\n *\r\n * @name Phaser.GameObjects.NineSliceVertex#u\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NineSliceVertex.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "UV u coordinate of this vertex.", "name": "u", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.NineSliceVertex", "longname": "Phaser.GameObjects.NineSliceVertex#u", "scope": "instance", "kind": "member", "___id": "T000002R012712", "___s": true }, { "comment": "/**\r\n * UV v coordinate of this vertex.\r\n *\r\n * @name Phaser.GameObjects.NineSliceVertex#v\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NineSliceVertex.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "UV v coordinate of this vertex.", "name": "v", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.NineSliceVertex", "longname": "Phaser.GameObjects.NineSliceVertex#v", "scope": "instance", "kind": "member", "___id": "T000002R012714", "___s": true }, { "comment": "/**\r\n * Sets the UV texture coordinates of this vertex.\r\n *\r\n * @method Phaser.GameObjects.NineSliceVertex#setUVs\r\n * @since 4.0.0\r\n *\r\n * @param {number} u - The UV u coordinate of the vertex.\r\n * @param {number} v - The UV v coordinate of the vertex.\r\n *\r\n * @return {this} This Vertex.\r\n */", "meta": { "filename": "NineSliceVertex.js", "lineno": 80, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Sets the UV texture coordinates of this vertex.", "kind": "function", "name": "setUVs", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The UV u coordinate of the vertex.", "name": "u" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The UV v coordinate of the vertex.", "name": "v" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Vertex." } ], "memberof": "Phaser.GameObjects.NineSliceVertex", "longname": "Phaser.GameObjects.NineSliceVertex#setUVs", "scope": "instance", "___id": "T000002R012716", "___s": true }, { "comment": "/**\r\n * Updates this vertex's position and calculates its projected screen-space coordinates.\r\n *\r\n * Sets the normalized `x` and `y` position, then scales them by the parent object's\r\n * `width` and `height` to produce the projected `vx` and `vy` values. The origin\r\n * offset of the parent object is then factored in, shifting `vx` and `vy` so that the\r\n * mesh is correctly aligned relative to the object's origin point.\r\n *\r\n * @method Phaser.GameObjects.NineSliceVertex#resize\r\n * @since 4.0.0\r\n *\r\n * @param {number} x - The x position of the vertex.\r\n * @param {number} y - The y position of the vertex.\r\n * @param {number} width - The width of the parent object.\r\n * @param {number} height - The height of the parent object.\r\n * @param {number} originX - The originX of the parent object.\r\n * @param {number} originY - The originY of the parent object.\r\n *\r\n * @return {this} This Vertex.\r\n */", "meta": { "filename": "NineSliceVertex.js", "lineno": 99, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice", "code": {} }, "description": "Updates this vertex's position and calculates its projected screen-space coordinates.\r\rSets the normalized `x` and `y` position, then scales them by the parent object's\r`width` and `height` to produce the projected `vx` and `vy` values. The origin\roffset of the parent object is then factored in, shifting `vx` and `vy` so that the\rmesh is correctly aligned relative to the object's origin point.", "kind": "function", "name": "resize", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the vertex.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the vertex.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the parent object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the parent object.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The originX of the parent object.", "name": "originX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The originY of the parent object.", "name": "originY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Vertex." } ], "memberof": "Phaser.GameObjects.NineSliceVertex", "longname": "Phaser.GameObjects.NineSliceVertex#resize", "scope": "instance", "___id": "T000002R012720", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.NineSlice\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice\\typedefs", "code": {} }, "kind": "namespace", "name": "NineSlice", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.NineSlice", "scope": "static", "___id": "T000002R012757", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.NineSlice.NineSliceConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 3.60.0\r\n *\r\n * @property {string|Phaser.Textures.Texture} [key] - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @property {string|number} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n * @property {number} [width=256] - The width of the Nine Slice Game Object. You can adjust the width post-creation.\r\n * @property {number} [height=256] - The height of the Nine Slice Game Object. If this is a 3 slice object the height will be fixed to the height of the texture and cannot be changed.\r\n * @property {number} [leftWidth=10] - The size of the left vertical column (A).\r\n * @property {number} [rightWidth=10] - The size of the right vertical column (B).\r\n * @property {number} [topHeight=0] - The size of the top horiztonal row (C). Set to zero or undefined to create a 3 slice object.\r\n * @property {number} [bottomHeight=0] - The size of the bottom horiztonal row (D). Set to zero or undefined to create a 3 slice object.\r\n * @property {boolean} [tileX=false] - Enable tile mode on the horizontal axis.\r\n * @property {boolean} [tileY=false] - Enable tile mode on the vertical axis.\r\n */", "meta": { "filename": "NineSliceConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\nineslice\\typedefs", "code": {} }, "kind": "typedef", "name": "NineSliceConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "3.60.0", "properties": [ { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 256, "description": "The width of the Nine Slice Game Object. You can adjust the width post-creation.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 256, "description": "The height of the Nine Slice Game Object. If this is a 3 slice object the height will be fixed to the height of the texture and cannot be changed.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The size of the left vertical column (A).", "name": "leftWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The size of the right vertical column (B).", "name": "rightWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The size of the top horiztonal row (C). Set to zero or undefined to create a 3 slice object.", "name": "topHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The size of the bottom horiztonal row (D). Set to zero or undefined to create a 3 slice object.", "name": "bottomHeight" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Enable tile mode on the horizontal axis.", "name": "tileX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Enable tile mode on the vertical axis.", "name": "tileY" } ], "memberof": "Phaser.Types.GameObjects.NineSlice", "longname": "Phaser.Types.GameObjects.NineSlice.NineSliceConfig", "scope": "static", "___id": "T000002R012758", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Noise Game Object.\r\n *\r\n * This game object is a quad which displays random noise.\r\n * You can manipulate this object like any other, make it interactive,\r\n * and use it in filters and masks to create visually stunning effects.\r\n *\r\n * Behind the scenes, a Noise is a {@link Phaser.GameObjects.Shader}\r\n * using a specific shader program.\r\n *\r\n * Noise or 'white noise' is simply random values.\r\n * These are created by hashing the offset pixel coordinates,\r\n * so the same noise is always created at the same position.\r\n * This creates a reproducible effect.\r\n *\r\n * You can set the color and transparency of the noise.\r\n *\r\n * You can scroll the noise by animating the `noiseOffset` property.\r\n * Note that floating-point precision is very important to this effect.\r\n * Scrolling very large distances may cause blockiness in the output.\r\n * Scrolling very small distances may cause the output to change completely,\r\n * as it is not processing the same exact values.\r\n * If you scroll by an exact fraction of the resolution of the object,\r\n * the output will remain mostly the same,\r\n * but it is not guaranteed to be stable.\r\n * It's more effective to use `setRenderToTexture` and use this as a texture\r\n * in a TileSprite.\r\n *\r\n * You can set `noisePower` to sculpt the output levels.\r\n * Higher power reduces higher values.\r\n * Lower power reduces lower values.\r\n *\r\n * @class Noise\r\n * @extends Phaser.GameObjects.Shader\r\n * @memberof Phaser.GameObjects\r\n * @since 4.0.0\r\n * @constructor\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {Phaser.Types.GameObjects.Noise.NoiseQuadConfig} [config] - The configuration for this Game Object.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "Noise.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise", "code": {} }, "classdesc": "A Noise Game Object.\r\rThis game object is a quad which displays random noise.\rYou can manipulate this object like any other, make it interactive,\rand use it in filters and masks to create visually stunning effects.\r\rBehind the scenes, a Noise is a {@link Phaser.GameObjects.Shader}\rusing a specific shader program.\r\rNoise or 'white noise' is simply random values.\rThese are created by hashing the offset pixel coordinates,\rso the same noise is always created at the same position.\rThis creates a reproducible effect.\r\rYou can set the color and transparency of the noise.\r\rYou can scroll the noise by animating the `noiseOffset` property.\rNote that floating-point precision is very important to this effect.\rScrolling very large distances may cause blockiness in the output.\rScrolling very small distances may cause the output to change completely,\ras it is not processing the same exact values.\rIf you scroll by an exact fraction of the resolution of the object,\rthe output will remain mostly the same,\rbut it is not guaranteed to be stable.\rIt's more effective to use `setRenderToTexture` and use this as a texture\rin a TileSprite.\r\rYou can set `noisePower` to sculpt the output levels.\rHigher power reduces higher values.\rLower power reduces lower values.", "kind": "class", "name": "Noise", "augments": [ "Phaser.GameObjects.Shader" ], "memberof": "Phaser.GameObjects", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.Types.GameObjects.Noise.NoiseQuadConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Noise.NoiseQuadConfig" } }, "optional": true, "description": "The configuration for this Game Object.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "scope": "static", "longname": "Phaser.GameObjects.Noise", "___id": "T000002R012763", "___s": true }, { "comment": "/**\r\n * The offset of the noise in each dimension: [ x, y ].\r\n * Animate x and y to scroll the noise pattern.\r\n *\r\n * This must be an array of 2 numbers.\r\n *\r\n * @name Phaser.GameObjects.Noise#noiseOffset\r\n * @type {number[]}\r\n * @default [ 0, 0 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Noise.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise", "code": {} }, "description": "The offset of the noise in each dimension: [ x, y ].\rAnimate x and y to scroll the noise pattern.\r\rThis must be an array of 2 numbers.", "name": "noiseOffset", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 0, 0 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.Noise", "longname": "Phaser.GameObjects.Noise#noiseOffset", "scope": "instance", "kind": "member", "___id": "T000002R012773", "___s": true }, { "comment": "/**\r\n * The power to apply to the noise value.\r\n * This can enhance/suppress high/low noise.\r\n *\r\n * @name Phaser.GameObjects.Noise#noisePower\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Noise.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise", "code": {} }, "description": "The power to apply to the noise value.\rThis can enhance/suppress high/low noise.", "name": "noisePower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.Noise", "longname": "Phaser.GameObjects.Noise#noisePower", "scope": "instance", "kind": "member", "___id": "T000002R012776", "___s": true }, { "comment": "/**\r\n * The color mapped to low noise values (approaching 0).\r\n *\r\n * The default is black. You can set any color, and change the alpha.\r\n *\r\n * @name Phaser.GameObjects.Noise#noiseColorStart\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Noise.js", "lineno": 103, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise", "code": {} }, "description": "The color mapped to low noise values (approaching 0).\r\rThe default is black. You can set any color, and change the alpha.", "name": "noiseColorStart", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Noise", "longname": "Phaser.GameObjects.Noise#noiseColorStart", "scope": "instance", "kind": "member", "___id": "T000002R012778", "___s": true }, { "comment": "/**\r\n * The color mapped to high noise values (approaching 1).\r\n *\r\n * The default is white. You can set any color, and change the alpha.\r\n *\r\n * @name Phaser.GameObjects.Noise#noiseColorEnd\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Noise.js", "lineno": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise", "code": {} }, "description": "The color mapped to high noise values (approaching 1).\r\rThe default is white. You can set any color, and change the alpha.", "name": "noiseColorEnd", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Noise", "longname": "Phaser.GameObjects.Noise#noiseColorEnd", "scope": "instance", "kind": "member", "___id": "T000002R012780", "___s": true }, { "comment": "/**\r\n * Whether to render channel noise separately,\r\n * creating many colors of output.\r\n *\r\n * @name Phaser.GameObjects.Noise#noiseRandomChannels\r\n * @type {boolean}\r\n * @default false\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Noise.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise", "code": {} }, "description": "Whether to render channel noise separately,\rcreating many colors of output.", "name": "noiseRandomChannels", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "4.0.0", "memberof": "Phaser.GameObjects.Noise", "longname": "Phaser.GameObjects.Noise#noiseRandomChannels", "scope": "instance", "kind": "member", "___id": "T000002R012782", "___s": true }, { "comment": "/**\r\n * Whether to render a random normal value per pixel.\r\n * The normal is in the hemisphere facing the camera.\r\n *\r\n * This value overrides `noiseRandomChannels`.\r\n *\r\n * @name Phaser.GameObjects.Noise#noiseRandomNormal\r\n * @type {boolean}\r\n * @default false\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Noise.js", "lineno": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise", "code": {} }, "description": "Whether to render a random normal value per pixel.\rThe normal is in the hemisphere facing the camera.\r\rThis value overrides `noiseRandomChannels`.", "name": "noiseRandomNormal", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "4.0.0", "memberof": "Phaser.GameObjects.Noise", "longname": "Phaser.GameObjects.Noise#noiseRandomNormal", "scope": "instance", "kind": "member", "___id": "T000002R012784", "___s": true }, { "comment": "/**\r\n * Set the colors of the noise, from a variety of color formats.\r\n *\r\n * - A number is expected to be a 24 or 32 bit RGB or ARGB value.\r\n * - A string is expected to be a hex code.\r\n * - An array of numbers is expected to be RGB or RGBA in the range 0-1.\r\n * - A Color object can be used.\r\n *\r\n * @method Phaser.GameObjects.Noise#setNoiseColor\r\n * @since 4.0.0\r\n * @param {number | string | number[] | Phaser.Display.Color} [start=0x000000] - The color mapped to low noise values (approaching 0).\r\n * @param {number | string | number[] | Phaser.Display.Color} [end=0xffffff] - The color mapped to high noise values (approaching 1).\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "Noise.js", "lineno": 155, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise", "code": {} }, "description": "Set the colors of the noise, from a variety of color formats.\r\r- A number is expected to be a 24 or 32 bit RGB or ARGB value.\r- A string is expected to be a hex code.\r- An array of numbers is expected to be RGB or RGBA in the range 0-1.\r- A Color object can be used.", "kind": "function", "name": "setNoiseColor", "since": "4.0.0", "params": [ { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color mapped to low noise values (approaching 0).", "name": "start" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color mapped to high noise values (approaching 1).", "name": "end" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.Noise", "longname": "Phaser.GameObjects.Noise#setNoiseColor", "scope": "instance", "___id": "T000002R012786", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A NoiseCell2D Game Object.\r\n *\r\n * This game object is a quad which displays cellular noise.\r\n * You can manipulate this object like any other, make it interactive,\r\n * and use it in filters and masks to create visually stunning effects.\r\n *\r\n * Behind the scenes, a NoiseCell2D is a {@link Phaser.GameObjects.Shader}\r\n * using a specific shader program.\r\n *\r\n * Cellular noise, also called Worley Noise or Voronoi Noise,\r\n * consists of a pattern of cells. This is good for modeling natural phenomena\r\n * like waves, clouds, or scales.\r\n *\r\n * You can set the color and transparency, cell count, variation,\r\n * and seed value of the noise.\r\n * You can change the detail level by increasing `noiseIterations`.\r\n * You can change the noise mode to output sharp edges, soft edges,\r\n * or flat colors for the cells.\r\n *\r\n * You can scroll the noise by animating the `noiseOffset` property.\r\n *\r\n * You can set `noiseNormalMap` to output a normal map.\r\n * This is a quick way to add texture for lighting.\r\n *\r\n * @class NoiseCell2D\r\n * @extends Phaser.GameObjects.Shader\r\n * @memberof Phaser.GameObjects\r\n * @since 4.0.0\r\n * @constructor\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DQuadConfig} [config] - The configuration for this Game Object.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "classdesc": "A NoiseCell2D Game Object.\r\rThis game object is a quad which displays cellular noise.\rYou can manipulate this object like any other, make it interactive,\rand use it in filters and masks to create visually stunning effects.\r\rBehind the scenes, a NoiseCell2D is a {@link Phaser.GameObjects.Shader}\rusing a specific shader program.\r\rCellular noise, also called Worley Noise or Voronoi Noise,\rconsists of a pattern of cells. This is good for modeling natural phenomena\rlike waves, clouds, or scales.\r\rYou can set the color and transparency, cell count, variation,\rand seed value of the noise.\rYou can change the detail level by increasing `noiseIterations`.\rYou can change the noise mode to output sharp edges, soft edges,\ror flat colors for the cells.\r\rYou can scroll the noise by animating the `noiseOffset` property.\r\rYou can set `noiseNormalMap` to output a normal map.\rThis is a quick way to add texture for lighting.", "kind": "class", "name": "NoiseCell2D", "augments": [ "Phaser.GameObjects.Shader" ], "memberof": "Phaser.GameObjects", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DQuadConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DQuadConfig" } }, "optional": true, "description": "The configuration for this Game Object.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "scope": "static", "longname": "Phaser.GameObjects.NoiseCell2D", "___id": "T000002R012803", "___s": true }, { "comment": "/**\r\n * The number of cells in each dimension.\r\n *\r\n * This must be an array of 2 numbers.\r\n *\r\n * Try to keep the cell count between 2\r\n * and about an eighth of the resolution of the texture.\r\n * A cell count of 1 has no room to vary.\r\n * A cell count greater than the resolution of the texture\r\n * will essentially be expensive white noise.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell2D#noiseCells\r\n * @type {number[]}\r\n * @default [ 32, 32 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "The number of cells in each dimension.\r\rThis must be an array of 2 numbers.\r\rTry to keep the cell count between 2\rand about an eighth of the resolution of the texture.\rA cell count of 1 has no room to vary.\rA cell count greater than the resolution of the texture\rwill essentially be expensive white noise.", "name": "noiseCells", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 32, 32 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#noiseCells", "scope": "instance", "kind": "member", "___id": "T000002R012828", "___s": true }, { "comment": "/**\r\n * How many cells wide the pattern is.\r\n *\r\n * By default, this is set to the same dimensions as `noiseCells`.\r\n * This causes the output to wrap seamlessly at the edges.\r\n * To restore wrapping if you changed settings, call `this.wrapNoise()`.\r\n *\r\n * A lower value causes the output to repeat.\r\n *\r\n * A higher value breaks visible wrapping.\r\n * The cell pattern still repeats off-camera.\r\n * Try to keep this value as low as possible,\r\n * as it helps avoid floating-point precision errors.\r\n *\r\n * This must be an array of 2 numbers.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell2D#noiseWrap\r\n * @type {number[]}\r\n * @default [ 32, 32 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "How many cells wide the pattern is.\r\rBy default, this is set to the same dimensions as `noiseCells`.\rThis causes the output to wrap seamlessly at the edges.\rTo restore wrapping if you changed settings, call `this.wrapNoise()`.\r\rA lower value causes the output to repeat.\r\rA higher value breaks visible wrapping.\rThe cell pattern still repeats off-camera.\rTry to keep this value as low as possible,\ras it helps avoid floating-point precision errors.\r\rThis must be an array of 2 numbers.", "name": "noiseWrap", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 32, 32 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#noiseWrap", "scope": "instance", "kind": "member", "___id": "T000002R012831", "___s": true }, { "comment": "/**\r\n * The offset of the noise in each dimension: [ x, y ].\r\n * Animate x and y to scroll the noise pattern.\r\n *\r\n * This must be an array of 2 numbers.\r\n *\r\n * Moving too far from 0 will introduce floating-point precision issues.\r\n * This can cause the noise to appear blocky.\r\n * We start to see obvious blockiness at offsets of a few thousand,\r\n * so stay below that.\r\n *\r\n * @example\r\n * // Scroll the noise pattern without changing the pattern.\r\n * noise.noiseOffset[0] = Math.sin(scene.time.now / 10000);\r\n * noise.noiseOffset[1] = Math.cos(scene.time.now / 10000);\r\n *\r\n * @name Phaser.GameObjects.NoiseCell2D#noiseOffset\r\n * @type {number[]}\r\n * @default [ 0, 0 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "The offset of the noise in each dimension: [ x, y ].\rAnimate x and y to scroll the noise pattern.\r\rThis must be an array of 2 numbers.\r\rMoving too far from 0 will introduce floating-point precision issues.\rThis can cause the noise to appear blocky.\rWe start to see obvious blockiness at offsets of a few thousand,\rso stay below that.", "examples": [ "// Scroll the noise pattern without changing the pattern.\rnoise.noiseOffset[0] = Math.sin(scene.time.now / 10000);\rnoise.noiseOffset[1] = Math.cos(scene.time.now / 10000);" ], "name": "noiseOffset", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 0, 0 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#noiseOffset", "scope": "instance", "kind": "member", "___id": "T000002R012834", "___s": true }, { "comment": "/**\r\n * How much each cell can vary from its grid position.\r\n * High values break further from the grid.\r\n *\r\n * At 0, cells are perfectly square.\r\n * At 1, cells are fully chaotic.\r\n * Never go higher than 1, as this can distort the cell matrix so much\r\n * that the nearest cell is outside the sampling range,\r\n * causing seams in the noise.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell2D#noiseVariation\r\n * @type {number[]}\r\n * @default [ 1, 1 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 172, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "How much each cell can vary from its grid position.\rHigh values break further from the grid.\r\rAt 0, cells are perfectly square.\rAt 1, cells are fully chaotic.\rNever go higher than 1, as this can distort the cell matrix so much\rthat the nearest cell is outside the sampling range,\rcausing seams in the noise.", "name": "noiseVariation", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 1, 1 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#noiseVariation", "scope": "instance", "kind": "member", "___id": "T000002R012837", "___s": true }, { "comment": "/**\r\n * How many octaves of noise to apply.\r\n * This adds fine detail to the noise, at the cost of performance.\r\n *\r\n * Each octave of noise has twice the resolution,\r\n * and contributes half as much to the output.\r\n *\r\n * This value should be an integer of 1 or higher.\r\n * Values above 5 or so have increasingly little effect.\r\n * Each iteration has a cost, so only use as much as you need!\r\n *\r\n * @name Phaser.GameObjects.NoiseCell2D#noiseIterations\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 193, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "How many octaves of noise to apply.\rThis adds fine detail to the noise, at the cost of performance.\r\rEach octave of noise has twice the resolution,\rand contributes half as much to the output.\r\rThis value should be an integer of 1 or higher.\rValues above 5 or so have increasingly little effect.\rEach iteration has a cost, so only use as much as you need!", "name": "noiseIterations", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#noiseIterations", "scope": "instance", "kind": "member", "___id": "T000002R012840", "___s": true }, { "comment": "/**\r\n * What mode to output the noise in.\r\n *\r\n * - 0: Sharp boundaries between cells.\r\n * - 1: Index mode. Cells have a single flat color.\r\n * It is random and may not be unique.\r\n * - 2: Smooth boundaries between cells.\r\n * Use `noiseSmoothing` to control smoothness.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell2D#noiseMode\r\n * @type {number}\r\n * @default 0\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "What mode to output the noise in.\r\r- 0: Sharp boundaries between cells.\r- 1: Index mode. Cells have a single flat color.\r It is random and may not be unique.\r- 2: Smooth boundaries between cells.\r Use `noiseSmoothing` to control smoothness.", "name": "noiseMode", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#noiseMode", "scope": "instance", "kind": "member", "___id": "T000002R012843", "___s": true }, { "comment": "/**\r\n * How much smoothing to apply in smoothing mode.\r\n *\r\n * The default value is 1, which applies moderate smoothing between cells.\r\n * The value is a factor.\r\n * Values from 0-1 reduce the smoothing.\r\n * Values above 1 intensify the smoothing.\r\n * Intensification slows above 4 or so.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell2D#noiseSmoothing\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 235, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "How much smoothing to apply in smoothing mode.\r\rThe default value is 1, which applies moderate smoothing between cells.\rThe value is a factor.\rValues from 0-1 reduce the smoothing.\rValues above 1 intensify the smoothing.\rIntensification slows above 4 or so.", "name": "noiseSmoothing", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#noiseSmoothing", "scope": "instance", "kind": "member", "___id": "T000002R012846", "___s": true }, { "comment": "/**\r\n * Whether to convert the noise output to a normal map.\r\n *\r\n * This works properly with noise modes 0 and 2, which form curves.\r\n *\r\n * Control the curvature strength with `noiseNormalScale`.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell2D#noiseNormalMap\r\n * @type {boolean}\r\n * @default false\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 255, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "Whether to convert the noise output to a normal map.\r\rThis works properly with noise modes 0 and 2, which form curves.\r\rControl the curvature strength with `noiseNormalScale`.", "name": "noiseNormalMap", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#noiseNormalMap", "scope": "instance", "kind": "member", "___id": "T000002R012849", "___s": true }, { "comment": "/**\r\n * Curvature strength of normal map output.\r\n * This is used when `noiseNormalMap` is enabled.\r\n *\r\n * The default is 1. Higher values produce more curvature;\r\n * lower values are flatter.\r\n *\r\n * Surface angle is determined by the rate of change of the noise.\r\n * Noise with more iterations tends to change more rapidly,\r\n * thus have more pronounced normals.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell2D#noiseNormalScale\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "Curvature strength of normal map output.\rThis is used when `noiseNormalMap` is enabled.\r\rThe default is 1. Higher values produce more curvature;\rlower values are flatter.\r\rSurface angle is determined by the rate of change of the noise.\rNoise with more iterations tends to change more rapidly,\rthus have more pronounced normals.", "name": "noiseNormalScale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#noiseNormalScale", "scope": "instance", "kind": "member", "___id": "T000002R012851", "___s": true }, { "comment": "/**\r\n * The color of the middle of the cells.\r\n *\r\n * The default is black. You can set any color, and change the alpha.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell2D#noiseColorStart\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 291, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "The color of the middle of the cells.\r\rThe default is black. You can set any color, and change the alpha.", "name": "noiseColorStart", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#noiseColorStart", "scope": "instance", "kind": "member", "___id": "T000002R012854", "___s": true }, { "comment": "/**\r\n * The color of the edge of the cells.\r\n *\r\n * The default is white. You can set any color, and change the alpha.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell2D#noiseColorEnd\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 302, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "The color of the edge of the cells.\r\rThe default is white. You can set any color, and change the alpha.", "name": "noiseColorEnd", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#noiseColorEnd", "scope": "instance", "kind": "member", "___id": "T000002R012856", "___s": true }, { "comment": "/**\r\n * Seed values for the noise.\r\n * Vary these to change the shape of cells in the pattern.\r\n * A different seed creates a completely different pattern.\r\n *\r\n * This must be an array of 8 numbers.\r\n *\r\n * Noise seed values should be fairly small.\r\n * Numbers between 0 and 1, or 0 and 8, are recommended.\r\n * Very large seed values may lose floating-point precision\r\n * and cause the noise to appear blocky.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell2D#noiseSeed\r\n * @type {number[]}\r\n * @default [ 1, 2, 3, 4, 5, 6, 7, 8 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 318, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "Seed values for the noise.\rVary these to change the shape of cells in the pattern.\rA different seed creates a completely different pattern.\r\rThis must be an array of 8 numbers.\r\rNoise seed values should be fairly small.\rNumbers between 0 and 1, or 0 and 8, are recommended.\rVery large seed values may lose floating-point precision\rand cause the noise to appear blocky.", "name": "noiseSeed", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 1, 2, 3, 4, 5, 6, 7, 8 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#noiseSeed", "scope": "instance", "kind": "member", "___id": "T000002R012858", "___s": true }, { "comment": "/**\r\n * Whether to jitter shader inputs to force continuous high precision.\r\n * This is an advanced setting.\r\n *\r\n * Chromium browsers seem to switch between WebGL rendering modes,\r\n * which changes the precision available to the noise shader.\r\n * This can change the noise calculation, causing parts of the output\r\n * to flicker unpredictably.\r\n * The `keepAwake` setting adds an imperceptible amount to the offset\r\n * during rendering, which seems to force Chromium to be consistent\r\n * and eliminate the flickering.\r\n *\r\n * Don't disable this unless you know what you're doing.\r\n * It prevents an unpredictable problem that might not appear in your\r\n * browser or device, but will appear for other users.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell2D#keepAwake\r\n * @type {boolean}\r\n * @default true\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 342, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "Whether to jitter shader inputs to force continuous high precision.\rThis is an advanced setting.\r\rChromium browsers seem to switch between WebGL rendering modes,\rwhich changes the precision available to the noise shader.\rThis can change the noise calculation, causing parts of the output\rto flicker unpredictably.\rThe `keepAwake` setting adds an imperceptible amount to the offset\rduring rendering, which seems to force Chromium to be consistent\rand eliminate the flickering.\r\rDon't disable this unless you know what you're doing.\rIt prevents an unpredictable problem that might not appear in your\rbrowser or device, but will appear for other users.", "name": "keepAwake", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#keepAwake", "scope": "instance", "kind": "member", "___id": "T000002R012861", "___s": true }, { "comment": "/**\r\n * Set the colors of the noise, from a variety of color formats.\r\n *\r\n * - A number is expected to be a 24 or 32 bit RGB or ARGB value.\r\n * - A string is expected to be a hex code.\r\n * - An array of numbers is expected to be RGB or RGBA in the range 0-1.\r\n * - A Color object can be used.\r\n *\r\n * @method Phaser.GameObjects.NoiseCell2D#setNoiseColor\r\n * @since 4.0.0\r\n * @param {number | string | number[] | Phaser.Display.Color} [start=0x000000] - The color in the middle of the cells.\r\n * @param {number | string | number[] | Phaser.Display.Color} [end=0xffffff] - The color at the edge of the cells.\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 366, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "Set the colors of the noise, from a variety of color formats.\r\r- A number is expected to be a 24 or 32 bit RGB or ARGB value.\r- A string is expected to be a hex code.\r- An array of numbers is expected to be RGB or RGBA in the range 0-1.\r- A Color object can be used.", "kind": "function", "name": "setNoiseColor", "since": "4.0.0", "params": [ { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color in the middle of the cells.", "name": "start" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color at the edge of the cells.", "name": "end" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#setNoiseColor", "scope": "instance", "___id": "T000002R012863", "___s": true }, { "comment": "/**\r\n * Randomize the noise seed, creating a unique pattern.\r\n *\r\n * @method Phaser.GameObjects.NoiseCell2D#randomizeNoiseSeed\r\n * @since 4.0.0\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 432, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "Randomize the noise seed, creating a unique pattern.", "kind": "function", "name": "randomizeNoiseSeed", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#randomizeNoiseSeed", "scope": "instance", "___id": "T000002R012870", "___s": true }, { "comment": "/**\r\n * Set the noise texture to wrap seamlessly.\r\n *\r\n * This sets `noiseWrap` to equal `noiseCells` in all dimensions.\r\n *\r\n * @method Phaser.GameObjects.NoiseCell2D#wrapNoise\r\n * @since 4.0.0\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseCell2D.js", "lineno": 449, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "Set the noise texture to wrap seamlessly.\r\rThis sets `noiseWrap` to equal `noiseCells` in all dimensions.", "kind": "function", "name": "wrapNoise", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseCell2D", "longname": "Phaser.GameObjects.NoiseCell2D#wrapNoise", "scope": "instance", "___id": "T000002R012875", "___s": true }, { "comment": "/**\r\n * Creates a new NoiseCell2D Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the NoiseCell2D Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#noisecell2d\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.NoiseCell2D} The Game Object that was created.\r\n */", "meta": { "filename": "NoiseCell2DCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "Creates a new NoiseCell2D Game Object and returns it.\r\rNote: This method will only be available if the NoiseCell2D Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "noisecell2d", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.NoiseCell2D" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.NoiseCell2D" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#noisecell2d", "scope": "instance", "___id": "T000002R012902", "___s": true }, { "comment": "/**\r\n * Creates a new NoiseCell2D Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the NoiseCell2D Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#noisecell2d\r\n * @webglOnly\r\n * @since 4.0.0\r\n *\r\n * @param {(string|Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DQuadConfig)} [config] - The configuration object this NoiseCell2D will use. This defines the shape and appearance of the NoiseCell2D texture.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n *\r\n * @return {Phaser.GameObjects.NoiseCell2D} The Game Object that was created.\r\n */", "meta": { "filename": "NoiseCell2DFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d", "code": {} }, "description": "Creates a new NoiseCell2D Game Object and adds it to the Scene.\r\rNote: This method will only be available if the NoiseCell2D Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "noisecell2d", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DQuadConfig" } ] } }, "optional": true, "description": "The configuration object this NoiseCell2D will use. This defines the shape and appearance of the NoiseCell2D texture.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.NoiseCell2D" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.NoiseCell2D" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#noisecell2d", "scope": "instance", "___id": "T000002R012913", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.NoiseCell2D\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d\\typedefs", "code": {} }, "kind": "namespace", "name": "NoiseCell2D", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.NoiseCell2D", "scope": "static", "___id": "T000002R012914", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 4.0.0\r\n *\r\n * @property {string|Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DQuadConfig} [config] - The configuration object this NoiseCell2D will use.\r\n * @property {number} [width=128] - The width of the Game Object.\r\n * @property {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "NoiseCell2DConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d\\typedefs", "code": {} }, "kind": "typedef", "name": "NoiseCell2DConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "4.0.0", "properties": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DQuadConfig" } ] } }, "optional": true, "description": "The configuration object this NoiseCell2D will use.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "memberof": "Phaser.Types.GameObjects.NoiseCell2D", "longname": "Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DConfig", "scope": "static", "___id": "T000002R012915", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DQuadConfig\r\n * @since 4.0.0\r\n *\r\n * @property {number[]} [noiseCells=[ 32, 32 ]] - The number of cells in each dimension.\r\n * @property {number[]} [noiseWrap] - How many cells in each dimension before the pattern repeats. `noiseCells` must be integers for this to work properly. By default, this is the same as `noiseCells`.\r\n * @property {number[]} [noiseOffset=[ 0, 0 ]] - The offset of the noise texture.\r\n * @property {number[]} [noiseVariation=[ 1, 1 ]] - The variation of the cells away from a perfect grid.\r\n * @property {number} [noiseIterations=1] - How many octaves of noise to render, creating a more detailed output.\r\n * @property {number} [noiseMode=0] - Which mode to render. 0 is sharp edged cells. 1 is flat colored cells. 2 is soft edged cells.\r\n * @property {number} [noiseSmoothing=1] - How smooth to render in mode 2.\r\n * @property {boolean} [noiseNormalMap=false] - Whether to convert the noise to a normal map.\r\n * @property {number} [noiseNormalScale=1] - How much curvature to include in the normal map, if `noiseNormalMap` is enabled.\r\n * @property {number | string | number[] | Phaser.Display.Color} [noiseColorStart=0x000000] - The color at the middle of the cells.\r\n * @property {number | string | number[] | Phaser.Display.Color} [noiseColorEnd=0xffffff] - The color at the edge of the cells.\r\n * @property {number[]} [noiseSeed=[ 1, 2, 3, 4, 5, 6, 7, 8 ]] - The seed which determines the cell pattern. A different seed creates an entirely different pattern.\r\n */", "meta": { "filename": "NoiseCell2DQuadConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell2d\\typedefs", "code": {} }, "kind": "typedef", "name": "NoiseCell2DQuadConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 32, 32 ]", "description": "The number of cells in each dimension.", "name": "noiseCells" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "How many cells in each dimension before the pattern repeats. `noiseCells` must be integers for this to work properly. By default, this is the same as `noiseCells`.", "name": "noiseWrap" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 0, 0 ]", "description": "The offset of the noise texture.", "name": "noiseOffset" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 1, 1 ]", "description": "The variation of the cells away from a perfect grid.", "name": "noiseVariation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How many octaves of noise to render, creating a more detailed output.", "name": "noiseIterations" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Which mode to render. 0 is sharp edged cells. 1 is flat colored cells. 2 is soft edged cells.", "name": "noiseMode" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How smooth to render in mode 2.", "name": "noiseSmoothing" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to convert the noise to a normal map.", "name": "noiseNormalMap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How much curvature to include in the normal map, if `noiseNormalMap` is enabled.", "name": "noiseNormalScale" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color at the middle of the cells.", "name": "noiseColorStart" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color at the edge of the cells.", "name": "noiseColorEnd" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 1, 2, 3, 4, 5, 6, 7, 8 ]", "description": "The seed which determines the cell pattern. A different seed creates an entirely different pattern.", "name": "noiseSeed" } ], "memberof": "Phaser.Types.GameObjects.NoiseCell2D", "longname": "Phaser.Types.GameObjects.NoiseCell2D.NoiseCell2DQuadConfig", "scope": "static", "___id": "T000002R012916", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A NoiseCell3D Game Object.\r\n *\r\n * This game object is a quad which displays cellular noise.\r\n * You can manipulate this object like any other, make it interactive,\r\n * and use it in filters and masks to create visually stunning effects.\r\n *\r\n * Behind the scenes, a NoiseCell3D is a {@link Phaser.GameObjects.Shader}\r\n * using a specific shader program.\r\n *\r\n * Cellular noise, also called Worley Noise or Voronoi Noise,\r\n * consists of a pattern of cells. This is good for modeling natural phenomena\r\n * like waves, clouds, or scales.\r\n *\r\n * You can set the color and transparency, cell count, variation,\r\n * and seed value of the noise.\r\n * You can change the detail level by increasing `noiseIterations`.\r\n * You can change the noise mode to output sharp edges, soft edges,\r\n * or flat colors for the cells.\r\n *\r\n * You can scroll the noise by animating the `noiseOffset` property.\r\n *\r\n * You can set `noiseNormalMap` to output a normal map.\r\n * This is a quick way to add texture for lighting.\r\n *\r\n * The 3D version of NoiseCell has one extra dimension: Z.\r\n * The shader only renders the XY slice through the noise field.\r\n * Because the centers of cells typically lie elsewhere in the hypervolume,\r\n * cells appear with variation in brightness.\r\n * You can scroll on the Z axis to shift the slice, smoothly changing the cell pattern.\r\n *\r\n * @class NoiseCell3D\r\n * @extends Phaser.GameObjects.Shader\r\n * @memberof Phaser.GameObjects\r\n * @since 4.0.0\r\n * @constructor\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DQuadConfig} [config] - The configuration for this Game Object.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "classdesc": "A NoiseCell3D Game Object.\r\rThis game object is a quad which displays cellular noise.\rYou can manipulate this object like any other, make it interactive,\rand use it in filters and masks to create visually stunning effects.\r\rBehind the scenes, a NoiseCell3D is a {@link Phaser.GameObjects.Shader}\rusing a specific shader program.\r\rCellular noise, also called Worley Noise or Voronoi Noise,\rconsists of a pattern of cells. This is good for modeling natural phenomena\rlike waves, clouds, or scales.\r\rYou can set the color and transparency, cell count, variation,\rand seed value of the noise.\rYou can change the detail level by increasing `noiseIterations`.\rYou can change the noise mode to output sharp edges, soft edges,\ror flat colors for the cells.\r\rYou can scroll the noise by animating the `noiseOffset` property.\r\rYou can set `noiseNormalMap` to output a normal map.\rThis is a quick way to add texture for lighting.\r\rThe 3D version of NoiseCell has one extra dimension: Z.\rThe shader only renders the XY slice through the noise field.\rBecause the centers of cells typically lie elsewhere in the hypervolume,\rcells appear with variation in brightness.\rYou can scroll on the Z axis to shift the slice, smoothly changing the cell pattern.", "kind": "class", "name": "NoiseCell3D", "augments": [ "Phaser.GameObjects.Shader" ], "memberof": "Phaser.GameObjects", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DQuadConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DQuadConfig" } }, "optional": true, "description": "The configuration for this Game Object.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "scope": "static", "longname": "Phaser.GameObjects.NoiseCell3D", "___id": "T000002R012921", "___s": true }, { "comment": "/**\r\n * The number of cells in each dimension.\r\n *\r\n * This must be an array of 3 numbers.\r\n *\r\n * Try to keep the cell count between 2\r\n * and about an eighth of the resolution of the texture.\r\n * A cell count of 1 has no room to vary.\r\n * A cell count greater than the resolution of the texture\r\n * will essentially be expensive white noise.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell3D#noiseCells\r\n * @type {number[]}\r\n * @default [ 32, 32, 32 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "The number of cells in each dimension.\r\rThis must be an array of 3 numbers.\r\rTry to keep the cell count between 2\rand about an eighth of the resolution of the texture.\rA cell count of 1 has no room to vary.\rA cell count greater than the resolution of the texture\rwill essentially be expensive white noise.", "name": "noiseCells", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 32, 32, 32 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#noiseCells", "scope": "instance", "kind": "member", "___id": "T000002R012946", "___s": true }, { "comment": "/**\r\n * How many cells wide the pattern is.\r\n *\r\n * By default, this is set to the same dimensions as `noiseCells`.\r\n * This causes the output to wrap seamlessly at the edges.\r\n * To restore wrapping if you changed settings, call `this.wrapNoise()`.\r\n *\r\n * A lower value causes the output to repeat.\r\n *\r\n * A higher value breaks visible wrapping.\r\n * The cell pattern still repeats off-camera.\r\n * Try to keep this value as low as possible,\r\n * as it helps avoid floating-point precision errors.\r\n *\r\n * This must be an array of 3 numbers.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell3D#noiseWrap\r\n * @type {number[]}\r\n * @default [ 32, 32, 32 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 121, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "How many cells wide the pattern is.\r\rBy default, this is set to the same dimensions as `noiseCells`.\rThis causes the output to wrap seamlessly at the edges.\rTo restore wrapping if you changed settings, call `this.wrapNoise()`.\r\rA lower value causes the output to repeat.\r\rA higher value breaks visible wrapping.\rThe cell pattern still repeats off-camera.\rTry to keep this value as low as possible,\ras it helps avoid floating-point precision errors.\r\rThis must be an array of 3 numbers.", "name": "noiseWrap", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 32, 32, 32 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#noiseWrap", "scope": "instance", "kind": "member", "___id": "T000002R012949", "___s": true }, { "comment": "/**\r\n * The offset of the noise in each dimension: [ x, y, z ].\r\n * Animate x and y to scroll the noise pattern.\r\n * Animate z to smoothly change the noise pattern.\r\n *\r\n * This must be an array of 3 numbers.\r\n *\r\n * Moving too far from 0 will introduce floating-point precision issues.\r\n * This can cause the noise to appear blocky.\r\n * We start to see obvious blockiness at offsets of a few thousand,\r\n * so stay below that.\r\n *\r\n * You can evolve the noise pattern by scrolling the Z axis.\r\n * However, this will eventually meet those floating-point precision issues.\r\n *\r\n * @example\r\n * // Scroll the noise pattern without changing the pattern.\r\n * noise.noiseOffset[0] = Math.sin(scene.time.now / 10000);\r\n * noise.noiseOffset[1] = Math.cos(scene.time.now / 10000);\r\n *\r\n * // Evolve the noise pattern along the Z axis.\r\n * noise.noiseOffset[2] = scene.time.now / 1000;\r\n *\r\n * @name Phaser.GameObjects.NoiseCell3D#noiseOffset\r\n * @type {number[]}\r\n * @default [ 0, 0, 0 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "The offset of the noise in each dimension: [ x, y, z ].\rAnimate x and y to scroll the noise pattern.\rAnimate z to smoothly change the noise pattern.\r\rThis must be an array of 3 numbers.\r\rMoving too far from 0 will introduce floating-point precision issues.\rThis can cause the noise to appear blocky.\rWe start to see obvious blockiness at offsets of a few thousand,\rso stay below that.\r\rYou can evolve the noise pattern by scrolling the Z axis.\rHowever, this will eventually meet those floating-point precision issues.", "examples": [ "// Scroll the noise pattern without changing the pattern.\rnoise.noiseOffset[0] = Math.sin(scene.time.now / 10000);\rnoise.noiseOffset[1] = Math.cos(scene.time.now / 10000);\r\r// Evolve the noise pattern along the Z axis.\rnoise.noiseOffset[2] = scene.time.now / 1000;" ], "name": "noiseOffset", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 0, 0, 0 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#noiseOffset", "scope": "instance", "kind": "member", "___id": "T000002R012952", "___s": true }, { "comment": "/**\r\n * How much each cell can vary from its grid position.\r\n * High values break further from the grid.\r\n *\r\n * At 0, cells are perfectly square.\r\n * At 1, cells are fully chaotic.\r\n * Never go higher than 1, as this can distort the cell matrix so much\r\n * that the nearest cell is outside the sampling range,\r\n * causing seams in the noise.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell3D#noiseVariation\r\n * @type {number[]}\r\n * @default [ 1, 1, 1 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "How much each cell can vary from its grid position.\rHigh values break further from the grid.\r\rAt 0, cells are perfectly square.\rAt 1, cells are fully chaotic.\rNever go higher than 1, as this can distort the cell matrix so much\rthat the nearest cell is outside the sampling range,\rcausing seams in the noise.", "name": "noiseVariation", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 1, 1, 1 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#noiseVariation", "scope": "instance", "kind": "member", "___id": "T000002R012955", "___s": true }, { "comment": "/**\r\n * How many octaves of noise to apply.\r\n * This adds fine detail to the noise, at the cost of performance.\r\n *\r\n * Each octave of noise has twice the resolution,\r\n * and contributes half as much to the output.\r\n *\r\n * This value should be an integer of 1 or higher.\r\n * Values above 5 or so have increasingly little effect.\r\n * Each iteration has a cost, so only use as much as you need!\r\n *\r\n * @name Phaser.GameObjects.NoiseCell3D#noiseIterations\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 207, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "How many octaves of noise to apply.\rThis adds fine detail to the noise, at the cost of performance.\r\rEach octave of noise has twice the resolution,\rand contributes half as much to the output.\r\rThis value should be an integer of 1 or higher.\rValues above 5 or so have increasingly little effect.\rEach iteration has a cost, so only use as much as you need!", "name": "noiseIterations", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#noiseIterations", "scope": "instance", "kind": "member", "___id": "T000002R012958", "___s": true }, { "comment": "/**\r\n * What mode to output the noise in.\r\n *\r\n * - 0: Sharp boundaries between cells.\r\n * - 1: Index mode. Cells have a single flat color.\r\n * The color assigned to each cell is random and may not be unique across cells.\r\n * - 2: Smooth boundaries between cells.\r\n * Use `noiseSmoothing` to control smoothness.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell3D#noiseMode\r\n * @type {number}\r\n * @default 0\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 229, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "What mode to output the noise in.\r\r- 0: Sharp boundaries between cells.\r- 1: Index mode. Cells have a single flat color.\r The color assigned to each cell is random and may not be unique across cells.\r- 2: Smooth boundaries between cells.\r Use `noiseSmoothing` to control smoothness.", "name": "noiseMode", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#noiseMode", "scope": "instance", "kind": "member", "___id": "T000002R012961", "___s": true }, { "comment": "/**\r\n * How much smoothing to apply in smoothing mode.\r\n *\r\n * The default value is 1, which applies moderate smoothing between cells.\r\n * The value is a factor.\r\n * Values from 0-1 reduce the smoothing.\r\n * Values above 1 intensify the smoothing.\r\n * Intensification slows above 4 or so.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell3D#noiseSmoothing\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 249, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "How much smoothing to apply in smoothing mode.\r\rThe default value is 1, which applies moderate smoothing between cells.\rThe value is a factor.\rValues from 0-1 reduce the smoothing.\rValues above 1 intensify the smoothing.\rIntensification slows above 4 or so.", "name": "noiseSmoothing", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#noiseSmoothing", "scope": "instance", "kind": "member", "___id": "T000002R012964", "___s": true }, { "comment": "/**\r\n * Whether to convert the noise output to a normal map.\r\n *\r\n * This works properly with noise modes 0 and 2, which form curves.\r\n *\r\n * Control the curvature strength with `noiseNormalScale`.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell3D#noiseNormalMap\r\n * @type {boolean}\r\n * @default false\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "Whether to convert the noise output to a normal map.\r\rThis works properly with noise modes 0 and 2, which form curves.\r\rControl the curvature strength with `noiseNormalScale`.", "name": "noiseNormalMap", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#noiseNormalMap", "scope": "instance", "kind": "member", "___id": "T000002R012967", "___s": true }, { "comment": "/**\r\n * Curvature strength of normal map output.\r\n * This is used when `noiseNormalMap` is enabled.\r\n *\r\n * The default is 1. Higher values produce more curvature;\r\n * lower values are flatter.\r\n *\r\n * Surface angle is determined by the rate of change of the noise.\r\n * Noise with more iterations tends to change more rapidly,\r\n * thus have more pronounced normals.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell3D#noiseNormalScale\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 283, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "Curvature strength of normal map output.\rThis is used when `noiseNormalMap` is enabled.\r\rThe default is 1. Higher values produce more curvature;\rlower values are flatter.\r\rSurface angle is determined by the rate of change of the noise.\rNoise with more iterations tends to change more rapidly,\rthus have more pronounced normals.", "name": "noiseNormalScale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#noiseNormalScale", "scope": "instance", "kind": "member", "___id": "T000002R012969", "___s": true }, { "comment": "/**\r\n * The color of the middle of the cells.\r\n *\r\n * The default is black. You can set any color, and change the alpha.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell3D#noiseColorStart\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 305, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "The color of the middle of the cells.\r\rThe default is black. You can set any color, and change the alpha.", "name": "noiseColorStart", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#noiseColorStart", "scope": "instance", "kind": "member", "___id": "T000002R012972", "___s": true }, { "comment": "/**\r\n * The color of the edge of the cells.\r\n *\r\n * The default is white. You can set any color, and change the alpha.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell3D#noiseColorEnd\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 316, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "The color of the edge of the cells.\r\rThe default is white. You can set any color, and change the alpha.", "name": "noiseColorEnd", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#noiseColorEnd", "scope": "instance", "kind": "member", "___id": "T000002R012974", "___s": true }, { "comment": "/**\r\n * Seed values for the noise.\r\n * Vary these to change the shape of cells in the pattern.\r\n * A different seed creates a completely different pattern.\r\n *\r\n * This must be an array of 12 numbers.\r\n *\r\n * Noise seed values should be fairly small.\r\n * Numbers between 0 and 1, or 0 and 12, are recommended.\r\n * Very large seed values may lose floating-point precision\r\n * and cause the noise to appear blocky.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell3D#noiseSeed\r\n * @type {number[]}\r\n * @default [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 332, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "Seed values for the noise.\rVary these to change the shape of cells in the pattern.\rA different seed creates a completely different pattern.\r\rThis must be an array of 12 numbers.\r\rNoise seed values should be fairly small.\rNumbers between 0 and 1, or 0 and 12, are recommended.\rVery large seed values may lose floating-point precision\rand cause the noise to appear blocky.", "name": "noiseSeed", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#noiseSeed", "scope": "instance", "kind": "member", "___id": "T000002R012976", "___s": true }, { "comment": "/**\r\n * Whether to jitter shader inputs to force continuous high precision.\r\n * This is an advanced setting.\r\n *\r\n * Chromium browsers seem to switch between WebGL rendering modes,\r\n * which changes the precision available to the noise shader.\r\n * This can change the noise calculation, causing parts of the output\r\n * to flicker unpredictably.\r\n * The `keepAwake` setting adds an imperceptible amount to the offset\r\n * during rendering, which seems to force Chromium to be consistent\r\n * and eliminate the flickering.\r\n *\r\n * Don't disable this unless you know what you're doing.\r\n * It prevents an unpredictable problem that might not appear in your\r\n * browser or device, but will appear for other users.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell3D#keepAwake\r\n * @type {boolean}\r\n * @default true\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 356, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "Whether to jitter shader inputs to force continuous high precision.\rThis is an advanced setting.\r\rChromium browsers seem to switch between WebGL rendering modes,\rwhich changes the precision available to the noise shader.\rThis can change the noise calculation, causing parts of the output\rto flicker unpredictably.\rThe `keepAwake` setting adds an imperceptible amount to the offset\rduring rendering, which seems to force Chromium to be consistent\rand eliminate the flickering.\r\rDon't disable this unless you know what you're doing.\rIt prevents an unpredictable problem that might not appear in your\rbrowser or device, but will appear for other users.", "name": "keepAwake", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#keepAwake", "scope": "instance", "kind": "member", "___id": "T000002R012979", "___s": true }, { "comment": "/**\r\n * Set the colors of the noise, from a variety of color formats.\r\n *\r\n * - A number is expected to be a 24 or 32 bit RGB or ARGB value.\r\n * - A string is expected to be a hex code.\r\n * - An array of numbers is expected to be RGB or RGBA in the range 0-1.\r\n * - A Color object can be used.\r\n *\r\n * @method Phaser.GameObjects.NoiseCell3D#setNoiseColor\r\n * @since 4.0.0\r\n * @param {number | string | number[] | Phaser.Display.Color} [start=0x000000] - The color in the middle of the cells.\r\n * @param {number | string | number[] | Phaser.Display.Color} [end=0xffffff] - The color at the edge of the cells.\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 380, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "Set the colors of the noise, from a variety of color formats.\r\r- A number is expected to be a 24 or 32 bit RGB or ARGB value.\r- A string is expected to be a hex code.\r- An array of numbers is expected to be RGB or RGBA in the range 0-1.\r- A Color object can be used.", "kind": "function", "name": "setNoiseColor", "since": "4.0.0", "params": [ { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color in the middle of the cells.", "name": "start" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color at the edge of the cells.", "name": "end" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#setNoiseColor", "scope": "instance", "___id": "T000002R012981", "___s": true }, { "comment": "/**\r\n * Randomize the noise seed, creating a unique pattern.\r\n *\r\n * @method Phaser.GameObjects.NoiseCell3D#randomizeNoiseSeed\r\n * @since 4.0.0\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "Randomize the noise seed, creating a unique pattern.", "kind": "function", "name": "randomizeNoiseSeed", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#randomizeNoiseSeed", "scope": "instance", "___id": "T000002R012988", "___s": true }, { "comment": "/**\r\n * Set the noise texture to wrap seamlessly.\r\n *\r\n * This sets `noiseWrap` to equal `noiseCells` in all dimensions.\r\n *\r\n * @method Phaser.GameObjects.NoiseCell3D#wrapNoise\r\n * @since 4.0.0\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseCell3D.js", "lineno": 463, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "Set the noise texture to wrap seamlessly.\r\rThis sets `noiseWrap` to equal `noiseCells` in all dimensions.", "kind": "function", "name": "wrapNoise", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseCell3D", "longname": "Phaser.GameObjects.NoiseCell3D#wrapNoise", "scope": "instance", "___id": "T000002R012993", "___s": true }, { "comment": "/**\r\n * Creates a new NoiseCell3D Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the NoiseCell3D Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#noisecell3d\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.NoiseCell3D} The Game Object that was created.\r\n */", "meta": { "filename": "NoiseCell3DCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "Creates a new NoiseCell3D Game Object and returns it.\r\rNote: This method will only be available if the NoiseCell3D Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "noisecell3d", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.NoiseCell3D" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.NoiseCell3D" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#noisecell3d", "scope": "instance", "___id": "T000002R013020", "___s": true }, { "comment": "/**\r\n * Creates a new NoiseCell3D Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the NoiseCell3D Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#noisecell3d\r\n * @webglOnly\r\n * @since 4.0.0\r\n *\r\n * @param {(string|Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DQuadConfig)} [config] - The configuration object this NoiseCell3D will use. This defines the shape and appearance of the NoiseCell3D texture.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n *\r\n * @return {Phaser.GameObjects.NoiseCell3D} The Game Object that was created.\r\n */", "meta": { "filename": "NoiseCell3DFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d", "code": {} }, "description": "Creates a new NoiseCell3D Game Object and adds it to the Scene.\r\rNote: This method will only be available if the NoiseCell3D Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "noisecell3d", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DQuadConfig" } ] } }, "optional": true, "description": "The configuration object this NoiseCell3D will use. This defines the shape and appearance of the NoiseCell3D texture.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.NoiseCell3D" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.NoiseCell3D" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#noisecell3d", "scope": "instance", "___id": "T000002R013031", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.NoiseCell3D\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d\\typedefs", "code": {} }, "kind": "namespace", "name": "NoiseCell3D", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.NoiseCell3D", "scope": "static", "___id": "T000002R013032", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 4.0.0\r\n *\r\n * @property {string|Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DQuadConfig} [config] - The configuration object this NoiseCell3D will use.\r\n * @property {number} [width=128] - The width of the Game Object.\r\n * @property {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "NoiseCell3DConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d\\typedefs", "code": {} }, "kind": "typedef", "name": "NoiseCell3DConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "4.0.0", "properties": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DQuadConfig" } ] } }, "optional": true, "description": "The configuration object this NoiseCell3D will use.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "memberof": "Phaser.Types.GameObjects.NoiseCell3D", "longname": "Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DConfig", "scope": "static", "___id": "T000002R013033", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DQuadConfig\r\n * @since 4.0.0\r\n *\r\n * @property {number[]} [noiseCells=[ 32, 32, 32 ]] - The number of cells in each dimension.\r\n * @property {number[]} [noiseWrap] - How many cells in each dimension before the pattern repeats. `noiseCells` must be integers for this to work properly. By default, this is the same as `noiseCells`.\r\n * @property {number[]} [noiseOffset=[ 0, 0, 0 ]] - The offset of the noise texture.\r\n * @property {number[]} [noiseVariation=[ 1, 1, 1 ]] - The variation of the cells away from a perfect grid.\r\n * @property {number} [noiseIterations=1] - How many octaves of noise to render, creating a more detailed output.\r\n * @property {number} [noiseMode=0] - Which mode to render. 0 is sharp edged cells. 1 is flat colored cells. 2 is soft edged cells.\r\n * @property {number} [noiseSmoothing=1] - How smooth to render in mode 2.\r\n * @property {boolean} [noiseNormalMap=false] - Whether to convert the noise to a normal map.\r\n * @property {number} [noiseNormalScale=1] - How much curvature to include in the normal map, if `noiseNormalMap` is enabled.\r\n * @property {number | string | number[] | Phaser.Display.Color} [noiseColorStart=0x000000] - The color at the middle of the cells.\r\n * @property {number | string | number[] | Phaser.Display.Color} [noiseColorEnd=0xffffff] - The color at the edge of the cells.\r\n * @property {number[]} [noiseSeed=[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]] - The seed which determines the cell pattern. A different seed creates an entirely different pattern.\r\n */", "meta": { "filename": "NoiseCell3DQuadConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell3d\\typedefs", "code": {} }, "kind": "typedef", "name": "NoiseCell3DQuadConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 32, 32, 32 ]", "description": "The number of cells in each dimension.", "name": "noiseCells" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "How many cells in each dimension before the pattern repeats. `noiseCells` must be integers for this to work properly. By default, this is the same as `noiseCells`.", "name": "noiseWrap" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 0, 0, 0 ]", "description": "The offset of the noise texture.", "name": "noiseOffset" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 1, 1, 1 ]", "description": "The variation of the cells away from a perfect grid.", "name": "noiseVariation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How many octaves of noise to render, creating a more detailed output.", "name": "noiseIterations" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Which mode to render. 0 is sharp edged cells. 1 is flat colored cells. 2 is soft edged cells.", "name": "noiseMode" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How smooth to render in mode 2.", "name": "noiseSmoothing" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to convert the noise to a normal map.", "name": "noiseNormalMap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How much curvature to include in the normal map, if `noiseNormalMap` is enabled.", "name": "noiseNormalScale" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color at the middle of the cells.", "name": "noiseColorStart" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color at the edge of the cells.", "name": "noiseColorEnd" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]", "description": "The seed which determines the cell pattern. A different seed creates an entirely different pattern.", "name": "noiseSeed" } ], "memberof": "Phaser.Types.GameObjects.NoiseCell3D", "longname": "Phaser.Types.GameObjects.NoiseCell3D.NoiseCell3DQuadConfig", "scope": "static", "___id": "T000002R013034", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A NoiseCell4D Game Object.\r\n *\r\n * This game object is a quad which displays cellular noise.\r\n * You can manipulate this object like any other, make it interactive,\r\n * and use it in filters and masks to create visually stunning effects.\r\n *\r\n * Behind the scenes, a NoiseCell4D is a {@link Phaser.GameObjects.Shader}\r\n * using a specific shader program.\r\n *\r\n * Cellular noise, also called Worley Noise or Voronoi Noise,\r\n * consists of a pattern of cells. This is good for modeling natural phenomena\r\n * like waves, clouds, or scales.\r\n *\r\n * You can set the color and transparency, cell count, variation,\r\n * and seed value of the noise.\r\n * You can change the detail level by increasing `noiseIterations`.\r\n * You can change the noise mode to output sharp edges, soft edges,\r\n * or flat colors for the cells.\r\n *\r\n * You can scroll the noise by animating the `noiseOffset` property.\r\n *\r\n * You can set `noiseNormalMap` to output a normal map.\r\n * This is a quick way to add texture for lighting.\r\n *\r\n * The 4D version of NoiseCell has two extra dimensions: Z and W.\r\n * The shader only renders the XY slice through the noise field.\r\n * Because the centers of cells typically lie elsewhere in the hypervolume,\r\n * cells appear with variation in brightness.\r\n * You can scroll on the Z axis to shift the slice, smoothly changing the cell pattern.\r\n * In 4D, you can instead move the ZW offset in a circle,\r\n * creating a constantly changing pattern which repeats without reversing\r\n * or resetting.\r\n * This ZW circling technique is advised for long-term effects,\r\n * because it avoids large offsets which can cause floating-point precision issues.\r\n *\r\n * @class NoiseCell4D\r\n * @extends Phaser.GameObjects.Shader\r\n * @memberof Phaser.GameObjects\r\n * @since 4.0.0\r\n * @constructor\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DQuadConfig} [config] - The configuration for this Game Object.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "classdesc": "A NoiseCell4D Game Object.\r\rThis game object is a quad which displays cellular noise.\rYou can manipulate this object like any other, make it interactive,\rand use it in filters and masks to create visually stunning effects.\r\rBehind the scenes, a NoiseCell4D is a {@link Phaser.GameObjects.Shader}\rusing a specific shader program.\r\rCellular noise, also called Worley Noise or Voronoi Noise,\rconsists of a pattern of cells. This is good for modeling natural phenomena\rlike waves, clouds, or scales.\r\rYou can set the color and transparency, cell count, variation,\rand seed value of the noise.\rYou can change the detail level by increasing `noiseIterations`.\rYou can change the noise mode to output sharp edges, soft edges,\ror flat colors for the cells.\r\rYou can scroll the noise by animating the `noiseOffset` property.\r\rYou can set `noiseNormalMap` to output a normal map.\rThis is a quick way to add texture for lighting.\r\rThe 4D version of NoiseCell has two extra dimensions: Z and W.\rThe shader only renders the XY slice through the noise field.\rBecause the centers of cells typically lie elsewhere in the hypervolume,\rcells appear with variation in brightness.\rYou can scroll on the Z axis to shift the slice, smoothly changing the cell pattern.\rIn 4D, you can instead move the ZW offset in a circle,\rcreating a constantly changing pattern which repeats without reversing\ror resetting.\rThis ZW circling technique is advised for long-term effects,\rbecause it avoids large offsets which can cause floating-point precision issues.", "kind": "class", "name": "NoiseCell4D", "augments": [ "Phaser.GameObjects.Shader" ], "memberof": "Phaser.GameObjects", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DQuadConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DQuadConfig" } }, "optional": true, "description": "The configuration for this Game Object.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "scope": "static", "longname": "Phaser.GameObjects.NoiseCell4D", "___id": "T000002R013039", "___s": true }, { "comment": "/**\r\n * The number of cells in each dimension.\r\n *\r\n * This must be an array of 4 numbers.\r\n *\r\n * Try to keep the cell count between 2\r\n * and about an eighth of the resolution of the texture.\r\n * A cell count of 1 has no room to vary.\r\n * A cell count greater than the resolution of the texture\r\n * will essentially be expensive white noise.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell4D#noiseCells\r\n * @type {number[]}\r\n * @default [ 32, 32, 32, 32 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "The number of cells in each dimension.\r\rThis must be an array of 4 numbers.\r\rTry to keep the cell count between 2\rand about an eighth of the resolution of the texture.\rA cell count of 1 has no room to vary.\rA cell count greater than the resolution of the texture\rwill essentially be expensive white noise.", "name": "noiseCells", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 32, 32, 32, 32 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#noiseCells", "scope": "instance", "kind": "member", "___id": "T000002R013064", "___s": true }, { "comment": "/**\r\n * How many cells wide the pattern is.\r\n *\r\n * By default, this is set to the same dimensions as `noiseCells`.\r\n * This causes the output to wrap seamlessly at the edges.\r\n * To restore wrapping if you changed settings, call `this.wrapNoise()`.\r\n *\r\n * A lower value causes the output to repeat.\r\n *\r\n * A higher value breaks visible wrapping.\r\n * The cell pattern still repeats off-camera.\r\n * Try to keep this value as low as possible,\r\n * as it helps avoid floating-point precision errors.\r\n *\r\n * This must be an array of 4 numbers.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell4D#noiseWrap\r\n * @type {number[]}\r\n * @default [ 32, 32, 32, 32 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "How many cells wide the pattern is.\r\rBy default, this is set to the same dimensions as `noiseCells`.\rThis causes the output to wrap seamlessly at the edges.\rTo restore wrapping if you changed settings, call `this.wrapNoise()`.\r\rA lower value causes the output to repeat.\r\rA higher value breaks visible wrapping.\rThe cell pattern still repeats off-camera.\rTry to keep this value as low as possible,\ras it helps avoid floating-point precision errors.\r\rThis must be an array of 4 numbers.", "name": "noiseWrap", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 32, 32, 32, 32 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#noiseWrap", "scope": "instance", "kind": "member", "___id": "T000002R013067", "___s": true }, { "comment": "/**\r\n * The offset of the noise in each dimension: [ x, y, z, w ].\r\n * Animate x and y to scroll the noise pattern.\r\n * Animate z and w to smoothly change the noise pattern.\r\n *\r\n * This must be an array of 4 numbers.\r\n *\r\n * Moving too far from 0 will introduce floating-point precision issues.\r\n * This can cause the noise to appear blocky.\r\n * We start to see obvious blockiness at offsets of a few thousand,\r\n * so stay below that.\r\n *\r\n * You can evolve the noise pattern by scrolling the Z axis.\r\n * However, this will eventually meet those floating-point precision issues.\r\n *\r\n * In four dimensions, you can instead evolve the noise pattern\r\n * by moving along a circle in the ZW plane.\r\n * This changes the pattern smoothly, without leaving the safe region,\r\n * and without needing to stop and reverse or reset.\r\n * 4D noise is very useful for continuously scrolling patterns.\r\n *\r\n * @example\r\n * // Scroll the noise pattern without changing the pattern.\r\n * noise.noiseOffset[0] = Math.sin(scene.time.now / 10000);\r\n * noise.noiseOffset[1] = Math.cos(scene.time.now / 10000);\r\n *\r\n * // Evolve the noise pattern along a circle in the ZW plane.\r\n * noise.noiseOffset[2] = Math.sin(scene.time.now / 1000) / 32;\r\n * noise.noiseOffset[3] = Math.cos(scene.time.now / 1000) / 32;\r\n *\r\n * @name Phaser.GameObjects.NoiseCell4D#noiseOffset\r\n * @type {number[]}\r\n * @default [ 0, 0, 0, 0 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 158, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "The offset of the noise in each dimension: [ x, y, z, w ].\rAnimate x and y to scroll the noise pattern.\rAnimate z and w to smoothly change the noise pattern.\r\rThis must be an array of 4 numbers.\r\rMoving too far from 0 will introduce floating-point precision issues.\rThis can cause the noise to appear blocky.\rWe start to see obvious blockiness at offsets of a few thousand,\rso stay below that.\r\rYou can evolve the noise pattern by scrolling the Z axis.\rHowever, this will eventually meet those floating-point precision issues.\r\rIn four dimensions, you can instead evolve the noise pattern\rby moving along a circle in the ZW plane.\rThis changes the pattern smoothly, without leaving the safe region,\rand without needing to stop and reverse or reset.\r4D noise is very useful for continuously scrolling patterns.", "examples": [ "// Scroll the noise pattern without changing the pattern.\rnoise.noiseOffset[0] = Math.sin(scene.time.now / 10000);\rnoise.noiseOffset[1] = Math.cos(scene.time.now / 10000);\r\r// Evolve the noise pattern along a circle in the ZW plane.\rnoise.noiseOffset[2] = Math.sin(scene.time.now / 1000) / 32;\rnoise.noiseOffset[3] = Math.cos(scene.time.now / 1000) / 32;" ], "name": "noiseOffset", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 0, 0, 0, 0 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#noiseOffset", "scope": "instance", "kind": "member", "___id": "T000002R013070", "___s": true }, { "comment": "/**\r\n * How much each cell can vary from its grid position.\r\n * High values break further from the grid.\r\n *\r\n * At 0, cells are perfectly square.\r\n * At 1, cells are fully chaotic.\r\n * Never go higher than 1, as this can distort the cell matrix so much\r\n * that the nearest cell is outside the sampling range,\r\n * causing seams in the noise.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell4D#noiseVariation\r\n * @type {number[]}\r\n * @default [ 1, 1, 1, 1 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 199, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "How much each cell can vary from its grid position.\rHigh values break further from the grid.\r\rAt 0, cells are perfectly square.\rAt 1, cells are fully chaotic.\rNever go higher than 1, as this can distort the cell matrix so much\rthat the nearest cell is outside the sampling range,\rcausing seams in the noise.", "name": "noiseVariation", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 1, 1, 1, 1 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#noiseVariation", "scope": "instance", "kind": "member", "___id": "T000002R013073", "___s": true }, { "comment": "/**\r\n * How many octaves of noise to apply.\r\n * This adds fine detail to the noise, at the cost of performance.\r\n *\r\n * Each octave of noise has twice the resolution,\r\n * and contributes half as much to the output.\r\n *\r\n * This value should be an integer of 1 or higher.\r\n * Values above 5 or so have increasingly little effect.\r\n * Each iteration has a cost, so only use as much as you need!\r\n *\r\n * @name Phaser.GameObjects.NoiseCell4D#noiseIterations\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 220, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "How many octaves of noise to apply.\rThis adds fine detail to the noise, at the cost of performance.\r\rEach octave of noise has twice the resolution,\rand contributes half as much to the output.\r\rThis value should be an integer of 1 or higher.\rValues above 5 or so have increasingly little effect.\rEach iteration has a cost, so only use as much as you need!", "name": "noiseIterations", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#noiseIterations", "scope": "instance", "kind": "member", "___id": "T000002R013076", "___s": true }, { "comment": "/**\r\n * What mode to output the noise in.\r\n *\r\n * - 0: Sharp boundaries between cells.\r\n * - 1: Index mode. Cells have a single flat color.\r\n * It is random and may not be unique.\r\n * - 2: Smooth boundaries between cells.\r\n * Use `noiseSmoothing` to control smoothness.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell4D#noiseMode\r\n * @type {number}\r\n * @default 0\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 242, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "What mode to output the noise in.\r\r- 0: Sharp boundaries between cells.\r- 1: Index mode. Cells have a single flat color.\r It is random and may not be unique.\r- 2: Smooth boundaries between cells.\r Use `noiseSmoothing` to control smoothness.", "name": "noiseMode", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#noiseMode", "scope": "instance", "kind": "member", "___id": "T000002R013079", "___s": true }, { "comment": "/**\r\n * How much smoothing to apply in smoothing mode.\r\n *\r\n * The default value is 1, which applies moderate smoothing between cells.\r\n * The value is a factor.\r\n * Values from 0-1 reduce the smoothing.\r\n * Values above 1 intensify the smoothing.\r\n * Intensification slows above 4 or so.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell4D#noiseSmoothing\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 262, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "How much smoothing to apply in smoothing mode.\r\rThe default value is 1, which applies moderate smoothing between cells.\rThe value is a factor.\rValues from 0-1 reduce the smoothing.\rValues above 1 intensify the smoothing.\rIntensification slows above 4 or so.", "name": "noiseSmoothing", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#noiseSmoothing", "scope": "instance", "kind": "member", "___id": "T000002R013082", "___s": true }, { "comment": "/**\r\n * Whether to convert the noise output to a normal map.\r\n *\r\n * This works properly with noise modes 0 and 2, which form curves.\r\n *\r\n * Control the curvature strength with `noiseNormalScale`.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell4D#noiseNormalMap\r\n * @type {boolean}\r\n * @default false\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 282, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "Whether to convert the noise output to a normal map.\r\rThis works properly with noise modes 0 and 2, which form curves.\r\rControl the curvature strength with `noiseNormalScale`.", "name": "noiseNormalMap", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#noiseNormalMap", "scope": "instance", "kind": "member", "___id": "T000002R013085", "___s": true }, { "comment": "/**\r\n * Curvature strength of normal map output.\r\n * This is used when `noiseNormalMap` is enabled.\r\n *\r\n * The default is 1. Higher values produce more curvature;\r\n * lower values are flatter.\r\n *\r\n * Surface angle is determined by the rate of change of the noise.\r\n * Noise with more iterations tends to change more rapidly,\r\n * thus have more pronounced normals.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell4D#noiseNormalScale\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 296, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "Curvature strength of normal map output.\rThis is used when `noiseNormalMap` is enabled.\r\rThe default is 1. Higher values produce more curvature;\rlower values are flatter.\r\rSurface angle is determined by the rate of change of the noise.\rNoise with more iterations tends to change more rapidly,\rthus have more pronounced normals.", "name": "noiseNormalScale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#noiseNormalScale", "scope": "instance", "kind": "member", "___id": "T000002R013087", "___s": true }, { "comment": "/**\r\n * The color of the middle of the cells.\r\n *\r\n * The default is black. You can set any color, and change the alpha.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell4D#noiseColorStart\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 318, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "The color of the middle of the cells.\r\rThe default is black. You can set any color, and change the alpha.", "name": "noiseColorStart", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#noiseColorStart", "scope": "instance", "kind": "member", "___id": "T000002R013090", "___s": true }, { "comment": "/**\r\n * The color of the edge of the cells.\r\n *\r\n * The default is white. You can set any color, and change the alpha.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell4D#noiseColorEnd\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 329, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "The color of the edge of the cells.\r\rThe default is white. You can set any color, and change the alpha.", "name": "noiseColorEnd", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#noiseColorEnd", "scope": "instance", "kind": "member", "___id": "T000002R013092", "___s": true }, { "comment": "/**\r\n * Seed values for the noise.\r\n * Vary these to change the shape of cells in the pattern.\r\n * A different seed creates a completely different pattern.\r\n *\r\n * This must be an array of 16 numbers.\r\n *\r\n * Noise seed values should be fairly small.\r\n * Numbers between 0 and 1, or 0 and 16, are recommended.\r\n * Very large seed values may lose floating-point precision\r\n * and cause the noise to appear blocky.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell4D#noiseSeed\r\n * @type {number[]}\r\n * @default [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 345, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "Seed values for the noise.\rVary these to change the shape of cells in the pattern.\rA different seed creates a completely different pattern.\r\rThis must be an array of 16 numbers.\r\rNoise seed values should be fairly small.\rNumbers between 0 and 1, or 0 and 16, are recommended.\rVery large seed values may lose floating-point precision\rand cause the noise to appear blocky.", "name": "noiseSeed", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#noiseSeed", "scope": "instance", "kind": "member", "___id": "T000002R013094", "___s": true }, { "comment": "/**\r\n * Whether to jitter shader inputs to force continuous high precision.\r\n * This is an advanced setting.\r\n *\r\n * Chromium browsers seem to switch between WebGL rendering modes,\r\n * which changes the precision available to the noise shader.\r\n * This can change the noise calculation, causing parts of the output\r\n * to flicker unpredictably.\r\n * The `keepAwake` setting adds an imperceptible amount to the offset\r\n * during rendering, which seems to force Chromium to be consistent\r\n * and eliminate the flickering.\r\n *\r\n * Don't disable this unless you know what you're doing.\r\n * It prevents an unpredictable problem that might not appear in your\r\n * browser or device, but will appear for other users.\r\n *\r\n * @name Phaser.GameObjects.NoiseCell4D#keepAwake\r\n * @type {boolean}\r\n * @default true\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 369, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "Whether to jitter shader inputs to force continuous high precision.\rThis is an advanced setting.\r\rChromium browsers seem to switch between WebGL rendering modes,\rwhich changes the precision available to the noise shader.\rThis can change the noise calculation, causing parts of the output\rto flicker unpredictably.\rThe `keepAwake` setting adds an imperceptible amount to the offset\rduring rendering, which seems to force Chromium to be consistent\rand eliminate the flickering.\r\rDon't disable this unless you know what you're doing.\rIt prevents an unpredictable problem that might not appear in your\rbrowser or device, but will appear for other users.", "name": "keepAwake", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#keepAwake", "scope": "instance", "kind": "member", "___id": "T000002R013097", "___s": true }, { "comment": "/**\r\n * Set the colors of the noise, from a variety of color formats.\r\n *\r\n * - A number is expected to be a 24 or 32 bit RGB or ARGB value.\r\n * - A string is expected to be a hex code.\r\n * - An array of numbers is expected to be RGB or RGBA in the range 0-1.\r\n * - A Color object can be used.\r\n *\r\n * @method Phaser.GameObjects.NoiseCell4D#setNoiseColor\r\n * @since 4.0.0\r\n * @param {number | string | number[] | Phaser.Display.Color} [start=0x000000] - The color in the middle of the cells.\r\n * @param {number | string | number[] | Phaser.Display.Color} [end=0xffffff] - The color at the edge of the cells.\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "Set the colors of the noise, from a variety of color formats.\r\r- A number is expected to be a 24 or 32 bit RGB or ARGB value.\r- A string is expected to be a hex code.\r- An array of numbers is expected to be RGB or RGBA in the range 0-1.\r- A Color object can be used.", "kind": "function", "name": "setNoiseColor", "since": "4.0.0", "params": [ { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color in the middle of the cells.", "name": "start" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color at the edge of the cells.", "name": "end" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#setNoiseColor", "scope": "instance", "___id": "T000002R013099", "___s": true }, { "comment": "/**\r\n * Randomize the noise seed, creating a unique pattern.\r\n *\r\n * @method Phaser.GameObjects.NoiseCell4D#randomizeNoiseSeed\r\n * @since 4.0.0\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 459, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "Randomize the noise seed, creating a unique pattern.", "kind": "function", "name": "randomizeNoiseSeed", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#randomizeNoiseSeed", "scope": "instance", "___id": "T000002R013106", "___s": true }, { "comment": "/**\r\n * Set the noise texture to wrap seamlessly.\r\n *\r\n * This sets `noiseWrap` to equal `noiseCells` in all dimensions.\r\n *\r\n * @method Phaser.GameObjects.NoiseCell4D#wrapNoise\r\n * @since 4.0.0\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseCell4D.js", "lineno": 476, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "Set the noise texture to wrap seamlessly.\r\rThis sets `noiseWrap` to equal `noiseCells` in all dimensions.", "kind": "function", "name": "wrapNoise", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseCell4D", "longname": "Phaser.GameObjects.NoiseCell4D#wrapNoise", "scope": "instance", "___id": "T000002R013111", "___s": true }, { "comment": "/**\r\n * Creates a new NoiseCell4D Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the NoiseCell4D Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#noisecell4d\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.NoiseCell4D} The Game Object that was created.\r\n */", "meta": { "filename": "NoiseCell4DCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "Creates a new NoiseCell4D Game Object and returns it.\r\rNote: This method will only be available if the NoiseCell4D Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "noisecell4d", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.NoiseCell4D" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.NoiseCell4D" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#noisecell4d", "scope": "instance", "___id": "T000002R013138", "___s": true }, { "comment": "/**\r\n * Creates a new NoiseCell4D Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the NoiseCell4D Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#noisecell4d\r\n * @webglOnly\r\n * @since 4.0.0\r\n *\r\n * @param {(string|Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DQuadConfig)} [config] - The configuration object this NoiseCell4D will use. This defines the shape and appearance of the NoiseCell4D texture.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n *\r\n * @return {Phaser.GameObjects.NoiseCell4D} The Game Object that was created.\r\n */", "meta": { "filename": "NoiseCell4DFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d", "code": {} }, "description": "Creates a new NoiseCell4D Game Object and adds it to the Scene.\r\rNote: This method will only be available if the NoiseCell4D Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "noisecell4d", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DQuadConfig" } ] } }, "optional": true, "description": "The configuration object this NoiseCell4D will use. This defines the shape and appearance of the NoiseCell4D texture.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.NoiseCell4D" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.NoiseCell4D" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#noisecell4d", "scope": "instance", "___id": "T000002R013149", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.NoiseCell4D\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d\\typedefs", "code": {} }, "kind": "namespace", "name": "NoiseCell4D", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.NoiseCell4D", "scope": "static", "___id": "T000002R013150", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 4.0.0\r\n *\r\n * @property {string|Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DQuadConfig} [config] - The configuration object this NoiseCell4D will use.\r\n * @property {number} [width=128] - The width of the Game Object.\r\n * @property {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "NoiseCell4DConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d\\typedefs", "code": {} }, "kind": "typedef", "name": "NoiseCell4DConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "4.0.0", "properties": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DQuadConfig" } ] } }, "optional": true, "description": "The configuration object this NoiseCell4D will use.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "memberof": "Phaser.Types.GameObjects.NoiseCell4D", "longname": "Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DConfig", "scope": "static", "___id": "T000002R013151", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DQuadConfig\r\n * @since 4.0.0\r\n *\r\n * @property {number[]} [noiseCells=[ 32, 32, 32, 32 ]] - The number of cells in each dimension.\r\n * @property {number[]} [noiseWrap] - How many cells in each dimension before the pattern repeats. `noiseCells` must be integers for this to work properly. By default, this is the same as `noiseCells`.\r\n * @property {number[]} [noiseOffset=[ 0, 0, 0, 0 ]] - The offset of the noise texture.\r\n * @property {number[]} [noiseVariation=[ 1, 1, 1, 1 ]] - The variation of the cells away from a perfect grid.\r\n * @property {number} [noiseIterations=1] - How many octaves of noise to render, creating a more detailed output.\r\n * @property {number} [noiseMode=0] - Which mode to render. 0 is sharp edged cells. 1 is flat colored cells. 2 is soft edged cells.\r\n * @property {number} [noiseSmoothing=1] - How smooth to render in mode 2.\r\n * @property {boolean} [noiseNormalMap=false] - Whether to convert the noise to a normal map.\r\n * @property {number} [noiseNormalScale=1] - How much curvature to include in the normal map, if `noiseNormalMap` is enabled.\r\n * @property {number | string | number[] | Phaser.Display.Color} [noiseColorStart=0x000000] - The color at the middle of the cells.\r\n * @property {number | string | number[] | Phaser.Display.Color} [noiseColorEnd=0xffffff] - The color at the edge of the cells.\r\n * @property {number[]} [noiseSeed=[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]] - The seed which determines the cell pattern. A different seed creates an entirely different pattern.\r\n */", "meta": { "filename": "NoiseCell4DQuadConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisecell4d\\typedefs", "code": {} }, "kind": "typedef", "name": "NoiseCell4DQuadConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 32, 32, 32, 32 ]", "description": "The number of cells in each dimension.", "name": "noiseCells" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "How many cells in each dimension before the pattern repeats. `noiseCells` must be integers for this to work properly. By default, this is the same as `noiseCells`.", "name": "noiseWrap" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 0, 0, 0, 0 ]", "description": "The offset of the noise texture.", "name": "noiseOffset" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 1, 1, 1, 1 ]", "description": "The variation of the cells away from a perfect grid.", "name": "noiseVariation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How many octaves of noise to render, creating a more detailed output.", "name": "noiseIterations" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Which mode to render. 0 is sharp edged cells. 1 is flat colored cells. 2 is soft edged cells.", "name": "noiseMode" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How smooth to render in mode 2.", "name": "noiseSmoothing" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to convert the noise to a normal map.", "name": "noiseNormalMap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How much curvature to include in the normal map, if `noiseNormalMap` is enabled.", "name": "noiseNormalScale" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color at the middle of the cells.", "name": "noiseColorStart" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color at the edge of the cells.", "name": "noiseColorEnd" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]", "description": "The seed which determines the cell pattern. A different seed creates an entirely different pattern.", "name": "noiseSeed" } ], "memberof": "Phaser.Types.GameObjects.NoiseCell4D", "longname": "Phaser.Types.GameObjects.NoiseCell4D.NoiseCell4DQuadConfig", "scope": "static", "___id": "T000002R013152", "___s": true }, { "comment": "/**\r\n * Creates a new Noise Game Object and returns it.\r\n *\r\n * A Noise Game Object renders procedural noise — such as Perlin or simplex noise — directly\r\n * onto a WebGL quad using a shader. It is useful for generating dynamic visual effects such\r\n * as clouds, fog, terrain previews, animated backgrounds, or any effect that benefits from\r\n * smooth, organic-looking randomness. The noise pattern is generated entirely on the GPU,\r\n * making it very efficient to animate each frame.\r\n *\r\n * Note: This method will only be available if the Noise Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#noise\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Noise.NoiseConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Noise} The Game Object that was created.\r\n */", "meta": { "filename": "NoiseCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise", "code": {} }, "description": "Creates a new Noise Game Object and returns it.\r\rA Noise Game Object renders procedural noise — such as Perlin or simplex noise — directly\ronto a WebGL quad using a shader. It is useful for generating dynamic visual effects such\ras clouds, fog, terrain previews, animated backgrounds, or any effect that benefits from\rsmooth, organic-looking randomness. The noise pattern is generated entirely on the GPU,\rmaking it very efficient to animate each frame.\r\rNote: This method will only be available if the Noise Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "noise", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Noise.NoiseConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Noise.NoiseConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.Noise" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Noise" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#noise", "scope": "instance", "___id": "T000002R013157", "___s": true }, { "comment": "/**\r\n * Creates a new Noise Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Noise Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#noise\r\n * @webglOnly\r\n * @since 4.0.0\r\n *\r\n * @param {(string|Phaser.Types.GameObjects.Noise.NoiseQuadConfig)} [config] - The configuration object this Noise will use. This defines the shape and appearance of the noise texture.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object, in pixels.\r\n * @param {number} [height=128] - The height of the Game Object, in pixels.\r\n *\r\n * @return {Phaser.GameObjects.Noise} The Game Object that was created.\r\n */", "meta": { "filename": "NoiseFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise", "code": {} }, "description": "Creates a new Noise Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Noise Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "noise", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.Noise.NoiseQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Noise.NoiseQuadConfig" } ] } }, "optional": true, "description": "The configuration object this Noise will use. This defines the shape and appearance of the noise texture.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object, in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object, in pixels.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Noise" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Noise" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#noise", "scope": "instance", "___id": "T000002R013168", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A NoiseSimplex2D object.\r\n *\r\n * This game object is a quad which displays simplex noise.\r\n * You can manipulate this object like any other, make it interactive,\r\n * and use it in filters and masks to create visually stunning effects.\r\n *\r\n * Behind the scenes, a NoiseSimplex2D is a {@see Phaser.GameObjects.Shader}\r\n * using a specific shader program.\r\n *\r\n * Simplex noise is a smooth pattern ideal for soft, natural phenomena.\r\n * It is useful for clouds, flame, water, and many other effects.\r\n * Ken Perlin, the creator of Perlin Noise, created Simplex Noise\r\n * to improve performance and quality over the original.\r\n *\r\n * By default, the noise pattern is periodic: it repeats.\r\n * You can scroll in X and Y.\r\n * You can also change the `noiseFlow` value to evolve the pattern\r\n * along a periodic course.\r\n *\r\n * You can set the cell count, color and transparency of the pattern.\r\n * You can add fine detail with `noiseIterations`.\r\n * You can add turbulence with `noiseWarpAmount`.\r\n *\r\n * You can change the basic pattern with `noiseSeed`.\r\n * Different seeds create completely different patterns.\r\n *\r\n * You can set `noiseNormalMap` to output a normal map.\r\n * This is a quick way to add texture for lighting.\r\n *\r\n * For advanced users, you can configure the characteristics of octave iteration.\r\n * Use `noiseDetailPower`, `noiseFlowPower`, and `noiseContributionPower`\r\n * to adjust the exponential scaling rate of these values.\r\n * Use `noiseWarpDetailPower`, `noiseWarpFlowPower`, and\r\n * `noiseWarpContributionPower` to do the same for the warp effect.\r\n *\r\n * @class NoiseSimplex2D\r\n * @extends Phaser.GameObjects.Shader\r\n * @memberof Phaser.GameObjects\r\n * @since 4.0.0\r\n * @constructor\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DQuadConfig} [config] - The configuration for this Game Object.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "classdesc": "A NoiseSimplex2D object.\r\rThis game object is a quad which displays simplex noise.\rYou can manipulate this object like any other, make it interactive,\rand use it in filters and masks to create visually stunning effects.\r\rBehind the scenes, a NoiseSimplex2D is a {@see Phaser.GameObjects.Shader}\rusing a specific shader program.\r\rSimplex noise is a smooth pattern ideal for soft, natural phenomena.\rIt is useful for clouds, flame, water, and many other effects.\rKen Perlin, the creator of Perlin Noise, created Simplex Noise\rto improve performance and quality over the original.\r\rBy default, the noise pattern is periodic: it repeats.\rYou can scroll in X and Y.\rYou can also change the `noiseFlow` value to evolve the pattern\ralong a periodic course.\r\rYou can set the cell count, color and transparency of the pattern.\rYou can add fine detail with `noiseIterations`.\rYou can add turbulence with `noiseWarpAmount`.\r\rYou can change the basic pattern with `noiseSeed`.\rDifferent seeds create completely different patterns.\r\rYou can set `noiseNormalMap` to output a normal map.\rThis is a quick way to add texture for lighting.\r\rFor advanced users, you can configure the characteristics of octave iteration.\rUse `noiseDetailPower`, `noiseFlowPower`, and `noiseContributionPower`\rto adjust the exponential scaling rate of these values.\rUse `noiseWarpDetailPower`, `noiseWarpFlowPower`, and\r`noiseWarpContributionPower` to do the same for the warp effect.", "kind": "class", "name": "NoiseSimplex2D", "augments": [ "Phaser.GameObjects.Shader" ], "memberof": "Phaser.GameObjects", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DQuadConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DQuadConfig" } }, "optional": true, "description": "The configuration for this Game Object.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "scope": "static", "longname": "Phaser.GameObjects.NoiseSimplex2D", "___id": "T000002R013173", "___s": true }, { "comment": "/**\r\n * The number of cells in each dimension.\r\n *\r\n * This must be an array of 2 numbers.\r\n *\r\n * Try to keep the cell count between 2\r\n * and about an eighth of the resolution of the texture.\r\n * A cell count greater than the resolution of the texture\r\n * will essentially be expensive white noise.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseCells\r\n * @type {number[]}\r\n * @default [ 32, 32 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 97, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "The number of cells in each dimension.\r\rThis must be an array of 2 numbers.\r\rTry to keep the cell count between 2\rand about an eighth of the resolution of the texture.\rA cell count greater than the resolution of the texture\rwill essentially be expensive white noise.", "name": "noiseCells", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 32, 32 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseCells", "scope": "instance", "kind": "member", "___id": "T000002R013194", "___s": true }, { "comment": "/**\r\n * The number of cells before the pattern wraps.\r\n *\r\n * This must be an array of 2 numbers.\r\n *\r\n * By default, this is the same as `noiseCells`.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noisePeriod\r\n * @type {number[]}\r\n * @default [ 32, 32 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "The number of cells before the pattern wraps.\r\rThis must be an array of 2 numbers.\r\rBy default, this is the same as `noiseCells`.", "name": "noisePeriod", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 32, 32 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noisePeriod", "scope": "instance", "kind": "member", "___id": "T000002R013196", "___s": true }, { "comment": "/**\r\n * The offset of the noise in each dimension: [ x, y ].\r\n * Animate x and y to scroll the noise pattern.\r\n *\r\n * This must be an array of 2 numbers.\r\n *\r\n * @example\r\n * // Scroll the noise pattern without changing the pattern.\r\n * noise.noiseOffset[0] = Math.sin(scene.time.now / 10000);\r\n * noise.noiseOffset[1] = Math.cos(scene.time.now / 10000);\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseOffset\r\n * @type {number[]}\r\n * @default [ 0, 0 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 135, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "The offset of the noise in each dimension: [ x, y ].\rAnimate x and y to scroll the noise pattern.\r\rThis must be an array of 2 numbers.", "examples": [ "// Scroll the noise pattern without changing the pattern.\rnoise.noiseOffset[0] = Math.sin(scene.time.now / 10000);\rnoise.noiseOffset[1] = Math.cos(scene.time.now / 10000);" ], "name": "noiseOffset", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 0, 0 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseOffset", "scope": "instance", "kind": "member", "___id": "T000002R013199", "___s": true }, { "comment": "/**\r\n * The current flow of the noise field.\r\n * The pattern changes in place with flow.\r\n * This is a rotation, so the pattern returns to its original state\r\n * after flow increases by PI * 2.\r\n *\r\n * Use flow to evolve the pattern over time with periodic repeats.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseFlow\r\n * @type {number}\r\n * @default 0\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 157, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "The current flow of the noise field.\rThe pattern changes in place with flow.\rThis is a rotation, so the pattern returns to its original state\rafter flow increases by PI * 2.\r\rUse flow to evolve the pattern over time with periodic repeats.", "name": "noiseFlow", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseFlow", "scope": "instance", "kind": "member", "___id": "T000002R013202", "___s": true }, { "comment": "/**\r\n * How much to warp the noise texture.\r\n * Warp can add a sense of turbulence to the output.\r\n *\r\n * This runs several octaves of noise to generate a random warp offset.\r\n * It adds to the expense of the shader.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseWarpAmount\r\n * @type {number}\r\n * @default 0\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 172, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "How much to warp the noise texture.\rWarp can add a sense of turbulence to the output.\r\rThis runs several octaves of noise to generate a random warp offset.\rIt adds to the expense of the shader.", "name": "noiseWarpAmount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseWarpAmount", "scope": "instance", "kind": "member", "___id": "T000002R013204", "___s": true }, { "comment": "/**\r\n * How many octaves of noise to apply.\r\n * This adds fine detail to the noise, at the cost of performance.\r\n *\r\n * This value should be an integer of 1 or higher.\r\n * Values above 5 or so have increasingly little effect.\r\n * Each iteration has a cost, so only use as much as you need!\r\n *\r\n * Use `noiseDetailPower`, `noiseFlowPower` and `noiseContributionPower`\r\n * to configure differences between octaves.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseIterations\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "How many octaves of noise to apply.\rThis adds fine detail to the noise, at the cost of performance.\r\rThis value should be an integer of 1 or higher.\rValues above 5 or so have increasingly little effect.\rEach iteration has a cost, so only use as much as you need!\r\rUse `noiseDetailPower`, `noiseFlowPower` and `noiseContributionPower`\rto configure differences between octaves.", "name": "noiseIterations", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseIterations", "scope": "instance", "kind": "member", "___id": "T000002R013206", "___s": true }, { "comment": "/**\r\n * How many octaves of noise to apply when warping the noise.\r\n *\r\n * This behaves much like `noiseIterations`,\r\n * but is used in the warp calculations instead.\r\n * It is only used when `noiseWarpAmount` is not 0.\r\n * You may need fewer warp iterations than regular iterations.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseWarpIterations\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 204, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "How many octaves of noise to apply when warping the noise.\r\rThis behaves much like `noiseIterations`,\rbut is used in the warp calculations instead.\rIt is only used when `noiseWarpAmount` is not 0.\rYou may need fewer warp iterations than regular iterations.", "name": "noiseWarpIterations", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseWarpIterations", "scope": "instance", "kind": "member", "___id": "T000002R013208", "___s": true }, { "comment": "/**\r\n * How much to increase detail frequency between noise octaves.\r\n *\r\n * This is used as the base of an exponent.\r\n * The default 2 doubles the frequency every octave.\r\n * Lower values scale slower.\r\n * Higher values scale higher.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseDetailPower\r\n * @type {number}\r\n * @default 2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 219, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "How much to increase detail frequency between noise octaves.\r\rThis is used as the base of an exponent.\rThe default 2 doubles the frequency every octave.\rLower values scale slower.\rHigher values scale higher.", "name": "noiseDetailPower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseDetailPower", "scope": "instance", "kind": "member", "___id": "T000002R013210", "___s": true }, { "comment": "/**\r\n * How much to increase flow progression between noise octaves.\r\n *\r\n * This is used as the base of an exponent.\r\n * The default 2 doubles the flow progression every octave.\r\n * Lower values scale slower.\r\n * Higher values scale higher.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseFlowPower\r\n * @type {number}\r\n * @default 2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "How much to increase flow progression between noise octaves.\r\rThis is used as the base of an exponent.\rThe default 2 doubles the flow progression every octave.\rLower values scale slower.\rHigher values scale higher.", "name": "noiseFlowPower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseFlowPower", "scope": "instance", "kind": "member", "___id": "T000002R013212", "___s": true }, { "comment": "/**\r\n * How much value to take from subsequent noise octaves.\r\n *\r\n * This is used as the base of an exponent.\r\n * The default 2 halves the contribution every octave.\r\n * Lower values decay slower, prioritize high frequency detail.\r\n * Higher values decay faster, prioritize low frequency detail.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseContributionPower\r\n * @type {number}\r\n * @default 2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 249, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "How much value to take from subsequent noise octaves.\r\rThis is used as the base of an exponent.\rThe default 2 halves the contribution every octave.\rLower values decay slower, prioritize high frequency detail.\rHigher values decay faster, prioritize low frequency detail.", "name": "noiseContributionPower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseContributionPower", "scope": "instance", "kind": "member", "___id": "T000002R013214", "___s": true }, { "comment": "/**\r\n * How much to increase detail frequency between noise octaves\r\n * in the warp.\r\n *\r\n * This is used as the base of an exponent.\r\n * The default 2 doubles the frequency every octave.\r\n * Lower values scale slower.\r\n * Higher values scale higher.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseWarpDetailPower\r\n * @type {number}\r\n * @default 2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 264, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "How much to increase detail frequency between noise octaves\rin the warp.\r\rThis is used as the base of an exponent.\rThe default 2 doubles the frequency every octave.\rLower values scale slower.\rHigher values scale higher.", "name": "noiseWarpDetailPower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseWarpDetailPower", "scope": "instance", "kind": "member", "___id": "T000002R013216", "___s": true }, { "comment": "/**\r\n * How much to increase flow progression between noise octaves\r\n * in the warp.\r\n *\r\n * This is used as the base of an exponent.\r\n * The default 2 doubles the flow progression every octave.\r\n * Lower values scale slower.\r\n * Higher values scale higher.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseWarpFlowPower\r\n * @type {number}\r\n * @default 2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 280, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "How much to increase flow progression between noise octaves\rin the warp.\r\rThis is used as the base of an exponent.\rThe default 2 doubles the flow progression every octave.\rLower values scale slower.\rHigher values scale higher.", "name": "noiseWarpFlowPower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseWarpFlowPower", "scope": "instance", "kind": "member", "___id": "T000002R013218", "___s": true }, { "comment": "/**\r\n * How much value to take from subsequent noise octaves\r\n * in the warp.\r\n *\r\n * This is used as the base of an exponent.\r\n * The default 2 halves the contribution every octave.\r\n * Lower values decay slower, prioritize high frequency detail.\r\n * Higher values decay faster, prioritize low frequency detail.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseWarpContributionPower\r\n * @type {number}\r\n * @default 2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 296, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "How much value to take from subsequent noise octaves\rin the warp.\r\rThis is used as the base of an exponent.\rThe default 2 halves the contribution every octave.\rLower values decay slower, prioritize high frequency detail.\rHigher values decay faster, prioritize low frequency detail.", "name": "noiseWarpContributionPower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseWarpContributionPower", "scope": "instance", "kind": "member", "___id": "T000002R013220", "___s": true }, { "comment": "/**\r\n * Whether to convert the noise output to a normal map.\r\n *\r\n * Control the curvature strength with `noiseNormalScale`.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseNormalMap\r\n * @type {boolean}\r\n * @default false\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 312, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "Whether to convert the noise output to a normal map.\r\rControl the curvature strength with `noiseNormalScale`.", "name": "noiseNormalMap", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseNormalMap", "scope": "instance", "kind": "member", "___id": "T000002R013222", "___s": true }, { "comment": "/**\r\n * Curvature strength of normal map output.\r\n * This is used when `noiseNormalMap` is enabled.\r\n *\r\n * The default is 1. Higher values produce more curvature;\r\n * lower values are flatter.\r\n *\r\n * Surface angle is determined by the rate of change of the noise.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseNormalScale\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 324, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "Curvature strength of normal map output.\rThis is used when `noiseNormalMap` is enabled.\r\rThe default is 1. Higher values produce more curvature;\rlower values are flatter.\r\rSurface angle is determined by the rate of change of the noise.", "name": "noiseNormalScale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseNormalScale", "scope": "instance", "kind": "member", "___id": "T000002R013224", "___s": true }, { "comment": "/**\r\n * Factor applied to the raw noise output.\r\n *\r\n * Raw noise is emitted in the range -1 to 1.\r\n * It is adjusted by (rawNoise * noiseValueFactor + noiseValueAdd) ^ noiseValuePower.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseValueFactor\r\n * @type {number}\r\n * @default 0.5\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 344, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "Factor applied to the raw noise output.\r\rRaw noise is emitted in the range -1 to 1.\rIt is adjusted by (rawNoise * noiseValueFactor + noiseValueAdd) ^ noiseValuePower.", "name": "noiseValueFactor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.5", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseValueFactor", "scope": "instance", "kind": "member", "___id": "T000002R013227", "___s": true }, { "comment": "/**\r\n * Value added to the raw noise output.\r\n *\r\n * Raw noise is emitted in the range -1 to 1.\r\n * It is adjusted by (rawNoise * noiseValueFactor + noiseValueAdd) ^ noiseValuePower.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseValueAdd\r\n * @type {number}\r\n * @default 0.5\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 357, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "Value added to the raw noise output.\r\rRaw noise is emitted in the range -1 to 1.\rIt is adjusted by (rawNoise * noiseValueFactor + noiseValueAdd) ^ noiseValuePower.", "name": "noiseValueAdd", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.5", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseValueAdd", "scope": "instance", "kind": "member", "___id": "T000002R013229", "___s": true }, { "comment": "/**\r\n * Exponent applied to the raw noise output.\r\n *\r\n * Raw noise is emitted in the range -1 to 1.\r\n * It is adjusted by (rawNoise * noiseValueFactor + noiseValueAdd) ^ noiseValuePower.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseValuePower\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 370, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "Exponent applied to the raw noise output.\r\rRaw noise is emitted in the range -1 to 1.\rIt is adjusted by (rawNoise * noiseValueFactor + noiseValueAdd) ^ noiseValuePower.", "name": "noiseValuePower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseValuePower", "scope": "instance", "kind": "member", "___id": "T000002R013231", "___s": true }, { "comment": "/**\r\n * The color when the adjusted noise value is 0.\r\n * This blends with noiseColorEnd.\r\n *\r\n * The default is black. You can set any color, and change the alpha.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseColorStart\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 383, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "The color when the adjusted noise value is 0.\rThis blends with noiseColorEnd.\r\rThe default is black. You can set any color, and change the alpha.", "name": "noiseColorStart", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseColorStart", "scope": "instance", "kind": "member", "___id": "T000002R013233", "___s": true }, { "comment": "/**\r\n * The color when the adjusted noise value is 1.\r\n * This blends with noiseColorStart.\r\n *\r\n * The default is white. You can set any color, and change the alpha.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseColorEnd\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 395, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "The color when the adjusted noise value is 1.\rThis blends with noiseColorStart.\r\rThe default is white. You can set any color, and change the alpha.", "name": "noiseColorEnd", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseColorEnd", "scope": "instance", "kind": "member", "___id": "T000002R013235", "___s": true }, { "comment": "/**\r\n * The seed for the noise.\r\n *\r\n * This offsets the simplex grid, causing its hashes to evaluate\r\n * differently. Any change to the seed results in a new pattern.\r\n * It must be an array of 2 numbers.\r\n *\r\n * Use a custom seed to create different, but reproducible,\r\n * randomness.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex2D#noiseSeed\r\n * @type {number[]}\r\n * @default [ 1, 2 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 412, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "The seed for the noise.\r\rThis offsets the simplex grid, causing its hashes to evaluate\rdifferently. Any change to the seed results in a new pattern.\rIt must be an array of 2 numbers.\r\rUse a custom seed to create different, but reproducible,\rrandomness.", "name": "noiseSeed", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 1, 2 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#noiseSeed", "scope": "instance", "kind": "member", "___id": "T000002R013237", "___s": true }, { "comment": "/**\r\n * Set the colors of the noise, from a variety of color formats.\r\n *\r\n * - A number is expected to be a 24 or 32 bit RGB or ARGB value.\r\n * - A string is expected to be a hex code.\r\n * - An array of numbers is expected to be RGB or RGBA in the range 0-1.\r\n * - A Color object can be used.\r\n *\r\n * @method Phaser.GameObjects.NoiseSimplex2D#setNoiseColor\r\n * @since 4.0.0\r\n * @param {number | string | number[] | Phaser.Display.Color} [start=0x000000] - The color when the noise value is 0, corresponding to `noiseColorStart`.\r\n * @param {number | string | number[] | Phaser.Display.Color} [end=0xffffff] - The color when the noise value is 1, corresponding to `noiseColorEnd`.\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "Set the colors of the noise, from a variety of color formats.\r\r- A number is expected to be a 24 or 32 bit RGB or ARGB value.\r- A string is expected to be a hex code.\r- An array of numbers is expected to be RGB or RGBA in the range 0-1.\r- A Color object can be used.", "kind": "function", "name": "setNoiseColor", "since": "4.0.0", "params": [ { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color when the noise value is 0, corresponding to `noiseColorStart`.", "name": "start" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color when the noise value is 1, corresponding to `noiseColorEnd`.", "name": "end" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#setNoiseColor", "scope": "instance", "___id": "T000002R013239", "___s": true }, { "comment": "/**\r\n * Randomize the noise seed, creating a unique pattern.\r\n *\r\n * @method Phaser.GameObjects.NoiseSimplex2D#randomizeNoiseSeed\r\n * @since 4.0.0\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 496, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "Randomize the noise seed, creating a unique pattern.", "kind": "function", "name": "randomizeNoiseSeed", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#randomizeNoiseSeed", "scope": "instance", "___id": "T000002R013246", "___s": true }, { "comment": "/**\r\n * Set the noise texture to wrap seamlessly.\r\n *\r\n * This sets `noisePeriod` to equal `noiseCells` in all dimensions.\r\n *\r\n * @method Phaser.GameObjects.NoiseSimplex2D#wrapNoise\r\n * @since 4.0.0\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseSimplex2D.js", "lineno": 513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "Set the noise texture to wrap seamlessly.\r\rThis sets `noisePeriod` to equal `noiseCells` in all dimensions.", "kind": "function", "name": "wrapNoise", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseSimplex2D", "longname": "Phaser.GameObjects.NoiseSimplex2D#wrapNoise", "scope": "instance", "___id": "T000002R013251", "___s": true }, { "comment": "/**\r\n * Creates a new NoiseSimplex2D Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the NoiseSimplex2D Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#noisesimplex2d\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.NoiseSimplex2D} The Game Object that was created.\r\n */", "meta": { "filename": "NoiseSimplex2DCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "Creates a new NoiseSimplex2D Game Object and returns it.\r\rNote: This method will only be available if the NoiseSimplex2D Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "noisesimplex2d", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.NoiseSimplex2D" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.NoiseSimplex2D" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#noisesimplex2d", "scope": "instance", "___id": "T000002R013272", "___s": true }, { "comment": "/**\r\n * Creates a new NoiseSimplex2D Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the NoiseSimplex2D Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#noisesimplex2d\r\n * @webglOnly\r\n * @since 4.0.0\r\n *\r\n * @param {(string|Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DQuadConfig)} [config] - The configuration object this NoiseSimplex2D will use. This defines the shape and appearance of the NoiseSimplex2D texture.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n *\r\n * @return {Phaser.GameObjects.NoiseSimplex2D} The Game Object that was created.\r\n */", "meta": { "filename": "NoiseSimplex2DFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d", "code": {} }, "description": "Creates a new NoiseSimplex2D Game Object and adds it to the Scene.\r\rNote: This method will only be available if the NoiseSimplex2D Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "noisesimplex2d", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DQuadConfig" } ] } }, "optional": true, "description": "The configuration object this NoiseSimplex2D will use. This defines the shape and appearance of the NoiseSimplex2D texture.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.NoiseSimplex2D" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.NoiseSimplex2D" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#noisesimplex2d", "scope": "instance", "___id": "T000002R013283", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.NoiseSimplex2D\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d\\typedefs", "code": {} }, "kind": "namespace", "name": "NoiseSimplex2D", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.NoiseSimplex2D", "scope": "static", "___id": "T000002R013284", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 4.0.0\r\n *\r\n * @property {string|Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DQuadConfig} [config] - The configuration object this NoiseSimplex2D will use.\r\n * @property {number} [width=128] - The width of the Game Object.\r\n * @property {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "NoiseSimplex2DConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d\\typedefs", "code": {} }, "kind": "typedef", "name": "NoiseSimplex2DConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "4.0.0", "properties": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DQuadConfig" } ] } }, "optional": true, "description": "The configuration object this NoiseSimplex2D will use.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "memberof": "Phaser.Types.GameObjects.NoiseSimplex2D", "longname": "Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DConfig", "scope": "static", "___id": "T000002R013285", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DQuadConfig\r\n * @since 4.0.0\r\n *\r\n * @property {number[]} [noiseCells=[ 32, 32 ]] - The number of cells in each dimension.\r\n * @property {number[]} [noisePeriod] - How many cells in each dimension before the pattern repeats. By default, this is the same as `noiseCells`.\r\n * @property {number[]} [noiseOffset=[ 0, 0 ]] - The offset of the noise texture.\r\n * @property {number} [noiseFlow=0] - The initial flow of the noise field. Use this to evolve the field along a period.\r\n * @property {number} [noiseWarpAmount=0] - How much turbulence to apply to the noise field.\r\n * @property {number} [noiseIterations=1] - How many octaves of noise to render, creating a more detailed output.\r\n * @property {number} [noiseWarpIterations=1] - How many octaves of noise to apply as turbulence, if `noiseWarpAmount` is greater than 0.\r\n * @property {boolean} [noiseNormalMap=false] - Whether to convert the noise to a normal map.\r\n * @property {number} [noiseNormalScale=1] - How much curvature to include in the normal map, if `noiseNormalMap` is enabled.\r\n * @property {number | string | number[] | Phaser.Display.Color} [noiseColorStart=0x000000] - The color at the middle of the cells.\r\n * @property {number | string | number[] | Phaser.Display.Color} [noiseColorEnd=0xffffff] - The color at the edge of the cells.\r\n * @property {number} [noiseDetailPower=2] - How much to increase detail per octave.\r\n * @property {number} [noiseFlowPower=2] - How much to increase flow per octave.\r\n * @property {number} [noiseContributionPower=2] - How much to shrink the contribution per octave.\r\n * @property {number} [noiseWarpDetailPower=2] - How much to increase warp detail per octave.\r\n * @property {number} [noiseWarpFlowPower=2] - How much to increase warp flow per octave.\r\n * @property {number} [noiseWarpContributionPower=2] - How much to shrink the warp contribution per octave.\r\n * @property {number} [noiseValueFactor=0.5] - How much to scale the noise value for output.\r\n * @property {number} [noiseValueAdd=0.5] - How much to add to the noise value for output.\r\n * @property {number} [noiseValuePower=1] - Exponent to apply to the noise value for output.\r\n * @property {number[]} [noiseSeed=[ 1, 2 ]] - The hash seed. Each seed creates a different pattern.\r\n */", "meta": { "filename": "NoiseSimplex2DQuadConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex2d\\typedefs", "code": {} }, "kind": "typedef", "name": "NoiseSimplex2DQuadConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 32, 32 ]", "description": "The number of cells in each dimension.", "name": "noiseCells" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "How many cells in each dimension before the pattern repeats. By default, this is the same as `noiseCells`.", "name": "noisePeriod" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 0, 0 ]", "description": "The offset of the noise texture.", "name": "noiseOffset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The initial flow of the noise field. Use this to evolve the field along a period.", "name": "noiseFlow" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "How much turbulence to apply to the noise field.", "name": "noiseWarpAmount" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How many octaves of noise to render, creating a more detailed output.", "name": "noiseIterations" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How many octaves of noise to apply as turbulence, if `noiseWarpAmount` is greater than 0.", "name": "noiseWarpIterations" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to convert the noise to a normal map.", "name": "noiseNormalMap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How much curvature to include in the normal map, if `noiseNormalMap` is enabled.", "name": "noiseNormalScale" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color at the middle of the cells.", "name": "noiseColorStart" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color at the edge of the cells.", "name": "noiseColorEnd" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "How much to increase detail per octave.", "name": "noiseDetailPower" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "How much to increase flow per octave.", "name": "noiseFlowPower" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "How much to shrink the contribution per octave.", "name": "noiseContributionPower" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "How much to increase warp detail per octave.", "name": "noiseWarpDetailPower" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "How much to increase warp flow per octave.", "name": "noiseWarpFlowPower" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "How much to shrink the warp contribution per octave.", "name": "noiseWarpContributionPower" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "How much to scale the noise value for output.", "name": "noiseValueFactor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "How much to add to the noise value for output.", "name": "noiseValueAdd" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Exponent to apply to the noise value for output.", "name": "noiseValuePower" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 1, 2 ]", "description": "The hash seed. Each seed creates a different pattern.", "name": "noiseSeed" } ], "memberof": "Phaser.Types.GameObjects.NoiseSimplex2D", "longname": "Phaser.Types.GameObjects.NoiseSimplex2D.NoiseSimplex2DQuadConfig", "scope": "static", "___id": "T000002R013286", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A NoiseSimplex3D object.\r\n *\r\n * This game object is a quad which displays simplex noise.\r\n * You can manipulate this object like any other, make it interactive,\r\n * and use it in filters and masks to create visually stunning effects.\r\n *\r\n * Behind the scenes, a NoiseSimplex3D is a {@see Phaser.GameObjects.Shader}\r\n * using a specific shader program.\r\n *\r\n * Simplex noise is a smooth pattern ideal for soft, natural phenomena.\r\n * It is useful for clouds, flame, water, and many other effects.\r\n * Ken Perlin, the creator of Perlin Noise, created Simplex Noise\r\n * to improve performance and quality over the original.\r\n *\r\n * By default, the noise pattern is periodic: it repeats.\r\n * You can scroll in X, Y, and Z.\r\n * You can also change the `noiseFlow` value to evolve the pattern\r\n * along a periodic course. This is useful to avoid scrolling into\r\n * regions of reduced floating-point precision with very large numbers.\r\n *\r\n * You can set the cell count, color and transparency of the pattern.\r\n * You can add fine detail with `noiseIterations`.\r\n * You can add turbulence with `noiseWarpAmount`.\r\n *\r\n * You can change the basic pattern with `noiseSeed`.\r\n * Different seeds create completely different patterns.\r\n * You must use integers for the seed, or bad things will happen.\r\n *\r\n * You can set `noiseNormalMap` to output a normal map.\r\n * This is a quick way to add texture for lighting.\r\n *\r\n * For advanced users, you can configure the characteristics of octave iteration.\r\n * Use `noiseDetailPower`, `noiseFlowPower`, and `noiseContributionPower`\r\n * to adjust the exponential scaling rate of these values.\r\n * Use `noiseWarpDetailPower`, `noiseWarpFlowPower`, and\r\n * `noiseWarpContributionPower` to do the same for the warp effect.\r\n *\r\n * @class NoiseSimplex3D\r\n * @extends Phaser.GameObjects.Shader\r\n * @memberof Phaser.GameObjects\r\n * @since 4.0.0\r\n * @constructor\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DQuadConfig} [config] - The configuration for this Game Object.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "classdesc": "A NoiseSimplex3D object.\r\rThis game object is a quad which displays simplex noise.\rYou can manipulate this object like any other, make it interactive,\rand use it in filters and masks to create visually stunning effects.\r\rBehind the scenes, a NoiseSimplex3D is a {@see Phaser.GameObjects.Shader}\rusing a specific shader program.\r\rSimplex noise is a smooth pattern ideal for soft, natural phenomena.\rIt is useful for clouds, flame, water, and many other effects.\rKen Perlin, the creator of Perlin Noise, created Simplex Noise\rto improve performance and quality over the original.\r\rBy default, the noise pattern is periodic: it repeats.\rYou can scroll in X, Y, and Z.\rYou can also change the `noiseFlow` value to evolve the pattern\ralong a periodic course. This is useful to avoid scrolling into\rregions of reduced floating-point precision with very large numbers.\r\rYou can set the cell count, color and transparency of the pattern.\rYou can add fine detail with `noiseIterations`.\rYou can add turbulence with `noiseWarpAmount`.\r\rYou can change the basic pattern with `noiseSeed`.\rDifferent seeds create completely different patterns.\rYou must use integers for the seed, or bad things will happen.\r\rYou can set `noiseNormalMap` to output a normal map.\rThis is a quick way to add texture for lighting.\r\rFor advanced users, you can configure the characteristics of octave iteration.\rUse `noiseDetailPower`, `noiseFlowPower`, and `noiseContributionPower`\rto adjust the exponential scaling rate of these values.\rUse `noiseWarpDetailPower`, `noiseWarpFlowPower`, and\r`noiseWarpContributionPower` to do the same for the warp effect.", "kind": "class", "name": "NoiseSimplex3D", "augments": [ "Phaser.GameObjects.Shader" ], "memberof": "Phaser.GameObjects", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DQuadConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DQuadConfig" } }, "optional": true, "description": "The configuration for this Game Object.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "scope": "static", "longname": "Phaser.GameObjects.NoiseSimplex3D", "___id": "T000002R013291", "___s": true }, { "comment": "/**\r\n * The number of cells in each dimension.\r\n *\r\n * This must be an array of 3 numbers.\r\n *\r\n * Try to keep the cell count between 2\r\n * and about an eighth of the resolution of the texture.\r\n * A cell count greater than the resolution of the texture\r\n * will essentially be expensive white noise.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseCells\r\n * @type {number[]}\r\n * @default [ 32, 32, 32 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "The number of cells in each dimension.\r\rThis must be an array of 3 numbers.\r\rTry to keep the cell count between 2\rand about an eighth of the resolution of the texture.\rA cell count greater than the resolution of the texture\rwill essentially be expensive white noise.", "name": "noiseCells", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 32, 32, 32 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseCells", "scope": "instance", "kind": "member", "___id": "T000002R013312", "___s": true }, { "comment": "/**\r\n * The number of cells before the pattern wraps.\r\n *\r\n * This must be an array of 3 numbers.\r\n *\r\n * By default, this is the same as `noiseCells`.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noisePeriod\r\n * @type {number[]}\r\n * @default [ 32, 32, 32 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "The number of cells before the pattern wraps.\r\rThis must be an array of 3 numbers.\r\rBy default, this is the same as `noiseCells`.", "name": "noisePeriod", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 32, 32, 32 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noisePeriod", "scope": "instance", "kind": "member", "___id": "T000002R013314", "___s": true }, { "comment": "/**\r\n * The offset of the noise in each dimension: [ x, y, z ].\r\n * Animate x and y to scroll the noise pattern.\r\n * Animate z to change the noise pattern by shifting the volume slice.\r\n *\r\n * This must be an array of 3 numbers.\r\n *\r\n * @example\r\n * // Scroll the noise pattern without changing the pattern.\r\n * noise.noiseOffset[0] = Math.sin(scene.time.now / 10000);\r\n * noise.noiseOffset[1] = Math.cos(scene.time.now / 10000);\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseOffset\r\n * @type {number[]}\r\n * @default [ 0, 0, 0 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 138, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "The offset of the noise in each dimension: [ x, y, z ].\rAnimate x and y to scroll the noise pattern.\rAnimate z to change the noise pattern by shifting the volume slice.\r\rThis must be an array of 3 numbers.", "examples": [ "// Scroll the noise pattern without changing the pattern.\rnoise.noiseOffset[0] = Math.sin(scene.time.now / 10000);\rnoise.noiseOffset[1] = Math.cos(scene.time.now / 10000);" ], "name": "noiseOffset", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 0, 0, 0 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseOffset", "scope": "instance", "kind": "member", "___id": "T000002R013317", "___s": true }, { "comment": "/**\r\n * The current flow of the noise field.\r\n * The pattern changes in place with flow.\r\n * This is a rotation, so the pattern returns to its original state\r\n * after flow increases by PI * 2.\r\n *\r\n * Use flow to evolve the pattern over time with periodic repeats.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseFlow\r\n * @type {number}\r\n * @default 0\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "The current flow of the noise field.\rThe pattern changes in place with flow.\rThis is a rotation, so the pattern returns to its original state\rafter flow increases by PI * 2.\r\rUse flow to evolve the pattern over time with periodic repeats.", "name": "noiseFlow", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseFlow", "scope": "instance", "kind": "member", "___id": "T000002R013320", "___s": true }, { "comment": "/**\r\n * How much to warp the noise texture.\r\n * Warp can add a sense of turbulence to the output.\r\n *\r\n * This runs several octaves of noise to generate a random warp offset.\r\n * It adds to the expense of the shader.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseWarpAmount\r\n * @type {number}\r\n * @default 0\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "How much to warp the noise texture.\rWarp can add a sense of turbulence to the output.\r\rThis runs several octaves of noise to generate a random warp offset.\rIt adds to the expense of the shader.", "name": "noiseWarpAmount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseWarpAmount", "scope": "instance", "kind": "member", "___id": "T000002R013322", "___s": true }, { "comment": "/**\r\n * How many octaves of noise to apply.\r\n * This adds fine detail to the noise, at the cost of performance.\r\n *\r\n * This value should be an integer of 1 or higher.\r\n * Values above 5 or so have increasingly little effect.\r\n * Each iteration has a cost, so only use as much as you need!\r\n *\r\n * Use `noiseDetailPower`, `noiseFlowPower` and `noiseContributionPower`\r\n * to configure differences between octaves.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseIterations\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 190, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "How many octaves of noise to apply.\rThis adds fine detail to the noise, at the cost of performance.\r\rThis value should be an integer of 1 or higher.\rValues above 5 or so have increasingly little effect.\rEach iteration has a cost, so only use as much as you need!\r\rUse `noiseDetailPower`, `noiseFlowPower` and `noiseContributionPower`\rto configure differences between octaves.", "name": "noiseIterations", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseIterations", "scope": "instance", "kind": "member", "___id": "T000002R013324", "___s": true }, { "comment": "/**\r\n * How many octaves of noise to apply when warping the noise.\r\n *\r\n * This behaves much like `noiseIterations`,\r\n * but is used in the warp calculations instead.\r\n * It is only used when `noiseWarpAmount` is not 0.\r\n * You may need fewer warp iterations than regular iterations.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseWarpIterations\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 208, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "How many octaves of noise to apply when warping the noise.\r\rThis behaves much like `noiseIterations`,\rbut is used in the warp calculations instead.\rIt is only used when `noiseWarpAmount` is not 0.\rYou may need fewer warp iterations than regular iterations.", "name": "noiseWarpIterations", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseWarpIterations", "scope": "instance", "kind": "member", "___id": "T000002R013326", "___s": true }, { "comment": "/**\r\n * How much to increase detail frequency between noise octaves.\r\n *\r\n * This is used as the base of an exponent.\r\n * The default 2 doubles the frequency every octave.\r\n * Lower values scale slower.\r\n * Higher values scale higher.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseDetailPower\r\n * @type {number}\r\n * @default 2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 223, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "How much to increase detail frequency between noise octaves.\r\rThis is used as the base of an exponent.\rThe default 2 doubles the frequency every octave.\rLower values scale slower.\rHigher values scale higher.", "name": "noiseDetailPower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseDetailPower", "scope": "instance", "kind": "member", "___id": "T000002R013328", "___s": true }, { "comment": "/**\r\n * How much to increase flow progression between noise octaves.\r\n *\r\n * This is used as the base of an exponent.\r\n * The default 2 doubles the frequency every octave.\r\n * Lower values scale slower.\r\n * Higher values scale higher.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseFlowPower\r\n * @type {number}\r\n * @default 2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 238, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "How much to increase flow progression between noise octaves.\r\rThis is used as the base of an exponent.\rThe default 2 doubles the frequency every octave.\rLower values scale slower.\rHigher values scale higher.", "name": "noiseFlowPower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseFlowPower", "scope": "instance", "kind": "member", "___id": "T000002R013330", "___s": true }, { "comment": "/**\r\n * How much value to take from subsequent noise octaves.\r\n *\r\n * This is used as the base of an exponent.\r\n * The default 2 halves the contribution every octave.\r\n * Lower values decay slower, prioritize high frequency detail.\r\n * Higher values decay faster, prioritize low frequency detail.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseContributionPower\r\n * @type {number}\r\n * @default 2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 253, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "How much value to take from subsequent noise octaves.\r\rThis is used as the base of an exponent.\rThe default 2 halves the contribution every octave.\rLower values decay slower, prioritize high frequency detail.\rHigher values decay faster, prioritize low frequency detail.", "name": "noiseContributionPower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseContributionPower", "scope": "instance", "kind": "member", "___id": "T000002R013332", "___s": true }, { "comment": "/**\r\n * How much to increase detail frequency between noise octaves\r\n * in the warp.\r\n *\r\n * This is used as the base of an exponent.\r\n * The default 2 doubles the frequency every octave.\r\n * Lower values scale slower.\r\n * Higher values scale higher.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseWarpDetailPower\r\n * @type {number}\r\n * @default 2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 268, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "How much to increase detail frequency between noise octaves\rin the warp.\r\rThis is used as the base of an exponent.\rThe default 2 doubles the frequency every octave.\rLower values scale slower.\rHigher values scale higher.", "name": "noiseWarpDetailPower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseWarpDetailPower", "scope": "instance", "kind": "member", "___id": "T000002R013334", "___s": true }, { "comment": "/**\r\n * How much to increase flow progression between noise octaves\r\n * in the warp.\r\n *\r\n * This is used as the base of an exponent.\r\n * The default 2 doubles the frequency every octave.\r\n * Lower values scale slower.\r\n * Higher values scale higher.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseWarpFlowPower\r\n * @type {number}\r\n * @default 2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 284, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "How much to increase flow progression between noise octaves\rin the warp.\r\rThis is used as the base of an exponent.\rThe default 2 doubles the frequency every octave.\rLower values scale slower.\rHigher values scale higher.", "name": "noiseWarpFlowPower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseWarpFlowPower", "scope": "instance", "kind": "member", "___id": "T000002R013336", "___s": true }, { "comment": "/**\r\n * How much value to take from subsequent noise octaves\r\n * in the warp.\r\n *\r\n * This is used as the base of an exponent.\r\n * The default 2 halves the contribution every octave.\r\n * Lower values decay slower, prioritize high frequency detail.\r\n * Higher values decay faster, prioritize low frequency detail.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseWarpContributionPower\r\n * @type {number}\r\n * @default 2\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 300, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "How much value to take from subsequent noise octaves\rin the warp.\r\rThis is used as the base of an exponent.\rThe default 2 halves the contribution every octave.\rLower values decay slower, prioritize high frequency detail.\rHigher values decay faster, prioritize low frequency detail.", "name": "noiseWarpContributionPower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseWarpContributionPower", "scope": "instance", "kind": "member", "___id": "T000002R013338", "___s": true }, { "comment": "/**\r\n * Whether to convert the noise output to a normal map.\r\n *\r\n * Control the curvature strength with `noiseNormalScale`.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseNormalMap\r\n * @type {boolean}\r\n * @default false\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 316, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "Whether to convert the noise output to a normal map.\r\rControl the curvature strength with `noiseNormalScale`.", "name": "noiseNormalMap", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseNormalMap", "scope": "instance", "kind": "member", "___id": "T000002R013340", "___s": true }, { "comment": "/**\r\n * Curvature strength of normal map output.\r\n * This is used when `noiseNormalMap` is enabled.\r\n *\r\n * The default is 1. Higher values produce more curvature;\r\n * lower values are flatter.\r\n *\r\n * Surface angle is determined by the rate of change of the noise.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseNormalScale\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 328, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "Curvature strength of normal map output.\rThis is used when `noiseNormalMap` is enabled.\r\rThe default is 1. Higher values produce more curvature;\rlower values are flatter.\r\rSurface angle is determined by the rate of change of the noise.", "name": "noiseNormalScale", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseNormalScale", "scope": "instance", "kind": "member", "___id": "T000002R013342", "___s": true }, { "comment": "/**\r\n * Factor applied to the raw noise output.\r\n *\r\n * Raw noise is emitted in the range -1 to 1.\r\n * It is adjusted by (rawNoise * noiseValueFactor + noiseValueAdd) ^ noiseValuePower.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseValueFactor\r\n * @type {number}\r\n * @default 0.5\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 348, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "Factor applied to the raw noise output.\r\rRaw noise is emitted in the range -1 to 1.\rIt is adjusted by (rawNoise * noiseValueFactor + noiseValueAdd) ^ noiseValuePower.", "name": "noiseValueFactor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.5", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseValueFactor", "scope": "instance", "kind": "member", "___id": "T000002R013345", "___s": true }, { "comment": "/**\r\n * Value added to the raw noise output.\r\n *\r\n * Raw noise is emitted in the range -1 to 1.\r\n * It is adjusted by (rawNoise * noiseValueFactor + noiseValueAdd) ^ noiseValuePower.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseValueAdd\r\n * @type {number}\r\n * @default 0.5\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 361, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "Value added to the raw noise output.\r\rRaw noise is emitted in the range -1 to 1.\rIt is adjusted by (rawNoise * noiseValueFactor + noiseValueAdd) ^ noiseValuePower.", "name": "noiseValueAdd", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.5", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseValueAdd", "scope": "instance", "kind": "member", "___id": "T000002R013347", "___s": true }, { "comment": "/**\r\n * Exponent applied to the raw noise output.\r\n *\r\n * Raw noise is emitted in the range -1 to 1.\r\n * It is adjusted by (rawNoise * noiseValueFactor + noiseValueAdd) ^ noiseValuePower.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseValuePower\r\n * @type {number}\r\n * @default 1\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 374, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "Exponent applied to the raw noise output.\r\rRaw noise is emitted in the range -1 to 1.\rIt is adjusted by (rawNoise * noiseValueFactor + noiseValueAdd) ^ noiseValuePower.", "name": "noiseValuePower", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseValuePower", "scope": "instance", "kind": "member", "___id": "T000002R013349", "___s": true }, { "comment": "/**\r\n * The color when the adjusted noise value is 0.\r\n * This blends with noiseColorEnd.\r\n *\r\n * The default is black. You can set any color, and change the alpha.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseColorStart\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 387, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "The color when the adjusted noise value is 0.\rThis blends with noiseColorEnd.\r\rThe default is black. You can set any color, and change the alpha.", "name": "noiseColorStart", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseColorStart", "scope": "instance", "kind": "member", "___id": "T000002R013351", "___s": true }, { "comment": "/**\r\n * The color when the adjusted noise value is 1.\r\n * This blends with noiseColorStart.\r\n *\r\n * The default is white. You can set any color, and change the alpha.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseColorEnd\r\n * @type {Phaser.Display.Color}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 399, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "The color when the adjusted noise value is 1.\rThis blends with noiseColorStart.\r\rThe default is white. You can set any color, and change the alpha.", "name": "noiseColorEnd", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseColorEnd", "scope": "instance", "kind": "member", "___id": "T000002R013353", "___s": true }, { "comment": "/**\r\n * The seed for the noise.\r\n *\r\n * This offsets the simplex grid, causing its hashes to evaluate\r\n * differently. Any change to the seed results in a new pattern.\r\n * It must be an array of 3 integers.\r\n *\r\n * Use a custom seed to create different, but reproducible,\r\n * randomness.\r\n *\r\n * @name Phaser.GameObjects.NoiseSimplex3D#noiseSeed\r\n * @type {number[]}\r\n * @default [ 1, 2, 3 ]\r\n * @since 4.0.0\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 416, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "The seed for the noise.\r\rThis offsets the simplex grid, causing its hashes to evaluate\rdifferently. Any change to the seed results in a new pattern.\rIt must be an array of 3 integers.\r\rUse a custom seed to create different, but reproducible,\rrandomness.", "name": "noiseSeed", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "defaultvalue": "[ 1, 2, 3 ]", "since": "4.0.0", "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#noiseSeed", "scope": "instance", "kind": "member", "___id": "T000002R013355", "___s": true }, { "comment": "/**\r\n * Set the colors of the noise, from a variety of color formats.\r\n *\r\n * - A number is expected to be a 24 or 32 bit RGB or ARGB value.\r\n * - A string is expected to be a hex code.\r\n * - An array of numbers is expected to be RGB or RGBA in the range 0-1.\r\n * - A Color object can be used.\r\n *\r\n * @method Phaser.GameObjects.NoiseSimplex3D#setNoiseColor\r\n * @since 4.0.0\r\n * @param {number | string | number[] | Phaser.Display.Color} [start=0x000000] - The color when the adjusted noise value is 0 (minimum). Defaults to black.\r\n * @param {number | string | number[] | Phaser.Display.Color} [end=0xffffff] - The color when the adjusted noise value is 1 (maximum). Defaults to white.\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 434, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "Set the colors of the noise, from a variety of color formats.\r\r- A number is expected to be a 24 or 32 bit RGB or ARGB value.\r- A string is expected to be a hex code.\r- An array of numbers is expected to be RGB or RGBA in the range 0-1.\r- A Color object can be used.", "kind": "function", "name": "setNoiseColor", "since": "4.0.0", "params": [ { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color when the adjusted noise value is 0 (minimum). Defaults to black.", "name": "start" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color when the adjusted noise value is 1 (maximum). Defaults to white.", "name": "end" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#setNoiseColor", "scope": "instance", "___id": "T000002R013357", "___s": true }, { "comment": "/**\r\n * Randomize the noise seed, creating a unique pattern.\r\n *\r\n * @method Phaser.GameObjects.NoiseSimplex3D#randomizeNoiseSeed\r\n * @since 4.0.0\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 500, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "Randomize the noise seed, creating a unique pattern.", "kind": "function", "name": "randomizeNoiseSeed", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#randomizeNoiseSeed", "scope": "instance", "___id": "T000002R013364", "___s": true }, { "comment": "/**\r\n * Set the noise texture to wrap seamlessly.\r\n *\r\n * This sets `noisePeriod` to equal `noiseCells` in all dimensions.\r\n *\r\n * @method Phaser.GameObjects.NoiseSimplex3D#wrapNoise\r\n * @since 4.0.0\r\n * @return {this} This game object.\r\n */", "meta": { "filename": "NoiseSimplex3D.js", "lineno": 517, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "Set the noise texture to wrap seamlessly.\r\rThis sets `noisePeriod` to equal `noiseCells` in all dimensions.", "kind": "function", "name": "wrapNoise", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This game object." } ], "memberof": "Phaser.GameObjects.NoiseSimplex3D", "longname": "Phaser.GameObjects.NoiseSimplex3D#wrapNoise", "scope": "instance", "___id": "T000002R013369", "___s": true }, { "comment": "/**\r\n * Creates a new NoiseSimplex3D Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the NoiseSimplex3D Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#noisesimplex3d\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.NoiseSimplex3D} The Game Object that was created.\r\n */", "meta": { "filename": "NoiseSimplex3DCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "Creates a new NoiseSimplex3D Game Object and returns it.\r\rNote: This method will only be available if the NoiseSimplex3D Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "noisesimplex3d", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.NoiseSimplex3D" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.NoiseSimplex3D" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#noisesimplex3d", "scope": "instance", "___id": "T000002R013390", "___s": true }, { "comment": "/**\r\n * Creates a new NoiseSimplex3D Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the NoiseSimplex3D Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#noisesimplex3d\r\n * @webglOnly\r\n * @since 4.0.0\r\n *\r\n * @param {(string|Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DQuadConfig)} [config] - The configuration object this NoiseSimplex3D will use. This defines the shape and appearance of the NoiseSimplex3D texture.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n *\r\n * @return {Phaser.GameObjects.NoiseSimplex3D} The Game Object that was created.\r\n */", "meta": { "filename": "NoiseSimplex3DFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d", "code": {} }, "description": "Creates a new NoiseSimplex3D Game Object and adds it to the Scene.\r\rNote: This method will only be available if the NoiseSimplex3D Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "noisesimplex3d", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DQuadConfig" } ] } }, "optional": true, "description": "The configuration object this NoiseSimplex3D will use. This defines the shape and appearance of the NoiseSimplex3D texture.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.NoiseSimplex3D" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.NoiseSimplex3D" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#noisesimplex3d", "scope": "instance", "___id": "T000002R013401", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.NoiseSimplex3D\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d\\typedefs", "code": {} }, "kind": "namespace", "name": "NoiseSimplex3D", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.NoiseSimplex3D", "scope": "static", "___id": "T000002R013402", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 4.0.0\r\n *\r\n * @property {string|Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DQuadConfig} [config] - The configuration object this NoiseSimplex3D will use.\r\n * @property {number} [width=128] - The width of the Game Object.\r\n * @property {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "NoiseSimplex3DConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d\\typedefs", "code": {} }, "kind": "typedef", "name": "NoiseSimplex3DConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "4.0.0", "properties": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DQuadConfig" } ] } }, "optional": true, "description": "The configuration object this NoiseSimplex3D will use.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "memberof": "Phaser.Types.GameObjects.NoiseSimplex3D", "longname": "Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DConfig", "scope": "static", "___id": "T000002R013403", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DQuadConfig\r\n * @since 4.0.0\r\n *\r\n * @property {number[]} [noiseCells=[ 32, 32, 32 ]] - The number of cells in each dimension.\r\n * @property {number[]} [noisePeriod] - How many cells in each dimension before the pattern repeats. By default, this is the same as `noiseCells`.\r\n * @property {number[]} [noiseOffset=[ 0, 0, 0 ]] - The offset of the noise texture.\r\n * @property {number} [noiseFlow=0] - The initial flow of the noise field. Use this to evolve the field along a period.\r\n * @property {number} [noiseWarpAmount=0] - How much turbulence to apply to the noise field.\r\n * @property {number} [noiseIterations=1] - How many octaves of noise to render, creating a more detailed output.\r\n * @property {number} [noiseWarpIterations=1] - How many octaves of noise to apply as turbulence, if `noiseWarpAmount` is greater than 0.\r\n * @property {boolean} [noiseNormalMap=false] - Whether to convert the noise to a normal map.\r\n * @property {number} [noiseNormalScale=1] - How much curvature to include in the normal map, if `noiseNormalMap` is enabled.\r\n * @property {number | string | number[] | Phaser.Display.Color} [noiseColorStart=0x000000] - The color at the middle of the cells.\r\n * @property {number | string | number[] | Phaser.Display.Color} [noiseColorEnd=0xffffff] - The color at the edge of the cells.\r\n * @property {number} [noiseDetailPower=2] - How much to increase detail per octave.\r\n * @property {number} [noiseFlowPower=2] - How much to increase flow per octave.\r\n * @property {number} [noiseContributionPower=2] - How much to shrink the contribution per octave.\r\n * @property {number} [noiseWarpDetailPower=2] - How much to increase warp detail per octave.\r\n * @property {number} [noiseWarpFlowPower=2] - How much to increase warp flow per octave.\r\n * @property {number} [noiseWarpContributionPower=2] - How much to shrink the warp contribution per octave.\r\n * @property {number} [noiseValueFactor=0.5] - How much to scale the noise value for output.\r\n * @property {number} [noiseValueAdd=0.5] - How much to add to the noise value for output.\r\n * @property {number} [noiseValuePower=1] - Exponent to apply to the noise value for output.\r\n * @property {number[]} [noiseSeed=[ 1, 2, 3 ]] - The hash seed. Each seed creates a different pattern. The numbers must be integers.\r\n */", "meta": { "filename": "NoiseSimplex3DQuadConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\noisesimplex3d\\typedefs", "code": {} }, "kind": "typedef", "name": "NoiseSimplex3DQuadConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 32, 32, 32 ]", "description": "The number of cells in each dimension.", "name": "noiseCells" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "How many cells in each dimension before the pattern repeats. By default, this is the same as `noiseCells`.", "name": "noisePeriod" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 0, 0, 0 ]", "description": "The offset of the noise texture.", "name": "noiseOffset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The initial flow of the noise field. Use this to evolve the field along a period.", "name": "noiseFlow" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "How much turbulence to apply to the noise field.", "name": "noiseWarpAmount" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How many octaves of noise to render, creating a more detailed output.", "name": "noiseIterations" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How many octaves of noise to apply as turbulence, if `noiseWarpAmount` is greater than 0.", "name": "noiseWarpIterations" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to convert the noise to a normal map.", "name": "noiseNormalMap" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How much curvature to include in the normal map, if `noiseNormalMap` is enabled.", "name": "noiseNormalScale" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color at the middle of the cells.", "name": "noiseColorStart" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color at the edge of the cells.", "name": "noiseColorEnd" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "How much to increase detail per octave.", "name": "noiseDetailPower" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "How much to increase flow per octave.", "name": "noiseFlowPower" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "How much to shrink the contribution per octave.", "name": "noiseContributionPower" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "How much to increase warp detail per octave.", "name": "noiseWarpDetailPower" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "How much to increase warp flow per octave.", "name": "noiseWarpFlowPower" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "How much to shrink the warp contribution per octave.", "name": "noiseWarpContributionPower" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "How much to scale the noise value for output.", "name": "noiseValueFactor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.5, "description": "How much to add to the noise value for output.", "name": "noiseValueAdd" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Exponent to apply to the noise value for output.", "name": "noiseValuePower" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 1, 2, 3 ]", "description": "The hash seed. Each seed creates a different pattern. The numbers must be integers.", "name": "noiseSeed" } ], "memberof": "Phaser.Types.GameObjects.NoiseSimplex3D", "longname": "Phaser.Types.GameObjects.NoiseSimplex3D.NoiseSimplex3DQuadConfig", "scope": "static", "___id": "T000002R013404", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Noise\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\typedefs", "code": {} }, "kind": "namespace", "name": "Noise", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Noise", "scope": "static", "___id": "T000002R013405", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Noise.NoiseConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 4.0.0\r\n *\r\n * @property {string|Phaser.Types.GameObjects.Noise.NoiseQuadConfig} [config] - The configuration object this Noise will use.\r\n * @property {number} [width=128] - The width of the Game Object.\r\n * @property {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "NoiseConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\typedefs", "code": {} }, "kind": "typedef", "name": "NoiseConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "4.0.0", "properties": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.Noise.NoiseQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Noise.NoiseQuadConfig" } ] } }, "optional": true, "description": "The configuration object this Noise will use.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "memberof": "Phaser.Types.GameObjects.Noise", "longname": "Phaser.Types.GameObjects.Noise.NoiseConfig", "scope": "static", "___id": "T000002R013406", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Noise.NoiseQuadConfig\r\n * @since 4.0.0\r\n *\r\n * @property {number[]} [noiseOffset=[ 0, 0 ]] - The offset of the noise texture.\r\n * @property {number} [noisePower] - The exponent of the noise values. Lower values remove low values; higher values remove high values.\r\n * @property {number | string | number[] | Phaser.Display.Color} [noiseColorStart=0x000000] - The color at the middle of the cells.\r\n * @property {number | string | number[] | Phaser.Display.Color} [noiseColorEnd=0xffffff] - The color at the edge of the cells.\r\n * @property {boolean} [noiseRandomChannels] - Whether to render random noise in each color channel.\r\n * @property {boolean} [noiseRandomNormal] - Whether to render random normal vectors. This overrides `noiseRandomChannels`.\r\n */", "meta": { "filename": "NoiseQuadConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\noise\\typedefs", "code": {} }, "kind": "typedef", "name": "NoiseQuadConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "defaultvalue": "[ 0, 0 ]", "description": "The offset of the noise texture.", "name": "noiseOffset" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The exponent of the noise values. Lower values remove low values; higher values remove high values.", "name": "noisePower" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0x000000", "description": "The color at the middle of the cells.", "name": "noiseColorStart" }, { "type": { "names": [ "number", "string", "Array.", "Phaser.Display.Color" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Display.Color" } ] } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color at the edge of the cells.", "name": "noiseColorEnd" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to render random noise in each color channel.", "name": "noiseRandomChannels" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to render random normal vectors. This overrides `noiseRandomChannels`.", "name": "noiseRandomNormal" } ], "memberof": "Phaser.Types.GameObjects.Noise", "longname": "Phaser.Types.GameObjects.Noise.NoiseQuadConfig", "scope": "static", "___id": "T000002R013407", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A specialized emitter op that manages the `color` property of a Particle over\r\n * its lifetime. Unlike scalar emitter ops, `EmitterColorOp` accepts an array of\r\n * hexadecimal color values (e.g. `[0xff0000, 0x00ff00, 0x0000ff]`) and smoothly\r\n * interpolates between them as the particle ages, producing gradient color\r\n * transitions from birth to death.\r\n *\r\n * The color array is decomposed into separate red, green, and blue component\r\n * arrays on configuration, and a linear interpolation function is used each\r\n * update step to recombine them into the current packed RGB color value.\r\n *\r\n * This class is created and managed automatically by the `ParticleEmitter` when\r\n * a `color` property is present in the emitter configuration; you do not normally\r\n * need to instantiate it directly.\r\n *\r\n * See the `ParticleEmitter` class for more details on emitter op configuration.\r\n *\r\n * @class EmitterColorOp\r\n * @extends Phaser.GameObjects.Particles.EmitterOp\r\n * @memberof Phaser.GameObjects.Particles\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The name of the property.\r\n */", "meta": { "filename": "EmitterColorOp.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "classdesc": "A specialized emitter op that manages the `color` property of a Particle over\rits lifetime. Unlike scalar emitter ops, `EmitterColorOp` accepts an array of\rhexadecimal color values (e.g. `[0xff0000, 0x00ff00, 0x0000ff]`) and smoothly\rinterpolates between them as the particle ages, producing gradient color\rtransitions from birth to death.\r\rThe color array is decomposed into separate red, green, and blue component\rarrays on configuration, and a linear interpolation function is used each\rupdate step to recombine them into the current packed RGB color value.\r\rThis class is created and managed automatically by the `ParticleEmitter` when\ra `color` property is present in the emitter configuration; you do not normally\rneed to instantiate it directly.\r\rSee the `ParticleEmitter` class for more details on emitter op configuration.", "kind": "class", "name": "EmitterColorOp", "augments": [ "Phaser.GameObjects.Particles.EmitterOp" ], "memberof": "Phaser.GameObjects.Particles", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property.", "name": "key" } ], "scope": "static", "longname": "Phaser.GameObjects.Particles.EmitterColorOp", "___id": "T000002R013414", "___s": true }, { "comment": "/**\r\n * An array containing the red color values.\r\n *\r\n * Populated during the `setMethods` method.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterColorOp#r\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "EmitterColorOp.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An array containing the red color values.\r\rPopulated during the `setMethods` method.", "name": "r", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.EmitterColorOp", "longname": "Phaser.GameObjects.Particles.EmitterColorOp#r", "scope": "instance", "kind": "member", "___id": "T000002R013420", "___s": true }, { "comment": "/**\r\n * An array containing the green color values.\r\n *\r\n * Populated during the `setMethods` method.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterColorOp#g\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "EmitterColorOp.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An array containing the green color values.\r\rPopulated during the `setMethods` method.", "name": "g", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.EmitterColorOp", "longname": "Phaser.GameObjects.Particles.EmitterColorOp#g", "scope": "instance", "kind": "member", "___id": "T000002R013422", "___s": true }, { "comment": "/**\r\n * An array containing the blue color values.\r\n *\r\n * Populated during the `setMethods` method.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterColorOp#b\r\n * @type {number[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "EmitterColorOp.js", "lineno": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An array containing the blue color values.\r\rPopulated during the `setMethods` method.", "name": "b", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.EmitterColorOp", "longname": "Phaser.GameObjects.Particles.EmitterColorOp#b", "scope": "instance", "kind": "member", "___id": "T000002R013424", "___s": true }, { "comment": "/**\r\n * Checks the type of `EmitterOp.propertyValue` to determine which\r\n * method is required in order to return values from this op function.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterColorOp#getMethod\r\n * @since 3.60.0\r\n *\r\n * @return {number} Either `0` if no color property value is set, or `9` if a color array is configured. The result should be passed to `setMethods`.\r\n */", "meta": { "filename": "EmitterColorOp.js", "lineno": 88, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Checks the type of `EmitterOp.propertyValue` to determine which\rmethod is required in order to return values from this op function.", "kind": "function", "name": "getMethod", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Either `0` if no color property value is set, or `9` if a color array is configured. The result should be passed to `setMethods`." } ], "memberof": "Phaser.GameObjects.Particles.EmitterColorOp", "longname": "Phaser.GameObjects.Particles.EmitterColorOp#getMethod", "scope": "instance", "overrides": "Phaser.GameObjects.Particles.EmitterOp#getMethod", "___id": "T000002R013426", "___s": true }, { "comment": "/**\r\n * Configures the emit and update callbacks for this color op based on the\r\n * current `method` value. When a color array is present (method 9), it\r\n * decomposes each packed hex color in `propertyValue` into separate red,\r\n * green, and blue component arrays, sets up the linear easing and\r\n * interpolation functions, and assigns the eased emit and update handlers.\r\n * If no color value is set (method 0), the default no-op handlers are used.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterColorOp#setMethods\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Emitter Op object.\r\n */", "meta": { "filename": "EmitterColorOp.js", "lineno": 102, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Configures the emit and update callbacks for this color op based on the\rcurrent `method` value. When a color array is present (method 9), it\rdecomposes each packed hex color in `propertyValue` into separate red,\rgreen, and blue component arrays, sets up the linear easing and\rinterpolation functions, and assigns the eased emit and update handlers.\rIf no color value is set (method 0), the default no-op handlers are used.", "kind": "function", "name": "setMethods", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Emitter Op object." } ], "memberof": "Phaser.GameObjects.Particles.EmitterColorOp", "longname": "Phaser.GameObjects.Particles.EmitterColorOp#setMethods", "scope": "instance", "overrides": "Phaser.GameObjects.Particles.EmitterOp#setMethods", "___id": "T000002R013428", "___s": true }, { "comment": "/**\r\n * Sets the Ease function to use for Color interpolation.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterColorOp#setEase\r\n * @since 3.60.0\r\n *\r\n * @param {string} ease - The string-based name of the Ease function to use.\r\n */", "meta": { "filename": "EmitterColorOp.js", "lineno": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sets the Ease function to use for Color interpolation.", "kind": "function", "name": "setEase", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based name of the Ease function to use.", "name": "ease" } ], "memberof": "Phaser.GameObjects.Particles.EmitterColorOp", "longname": "Phaser.GameObjects.Particles.EmitterColorOp#setEase", "scope": "instance", "___id": "T000002R013449", "___s": true }, { "comment": "/**\r\n * An `onEmit` callback for an eased property.\r\n *\r\n * It prepares the particle for easing by {@link Phaser.GameObjects.Particles.EmitterColorOp#easeValueUpdate}.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterColorOp#easedValueEmit\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle.\r\n * @param {string} key - The name of the property.\r\n *\r\n * @return {number} {@link Phaser.GameObjects.Particles.EmitterColorOp#start}, as the new value of the property.\r\n */", "meta": { "filename": "EmitterColorOp.js", "lineno": 173, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An `onEmit` callback for an eased property.\r\rIt prepares the particle for easing by {@link Phaser.GameObjects.Particles.EmitterColorOp#easeValueUpdate}.", "kind": "function", "name": "easedValueEmit", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle.", "name": "particle" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property.", "name": "key" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "{@link Phaser.GameObjects.Particles.EmitterColorOp#start}, as the new value of the property." } ], "memberof": "Phaser.GameObjects.Particles.EmitterColorOp", "longname": "Phaser.GameObjects.Particles.EmitterColorOp#easedValueEmit", "scope": "instance", "overrides": "Phaser.GameObjects.Particles.EmitterOp#easedValueEmit", "___id": "T000002R013453", "___s": true }, { "comment": "/**\r\n * An `onUpdate` callback that returns an interpolated packed RGB color value\r\n * across the configured color array, based on the particle's current\r\n * normalized lifetime.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterColorOp#easeValueUpdate\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle.\r\n * @param {string} key - The name of the property.\r\n * @param {number} t - The current normalized lifetime of the particle, between 0 (birth) and 1 (death).\r\n *\r\n * @return {number} The new value of the property.\r\n */", "meta": { "filename": "EmitterColorOp.js", "lineno": 193, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An `onUpdate` callback that returns an interpolated packed RGB color value\racross the configured color array, based on the particle's current\rnormalized lifetime.", "kind": "function", "name": "easeValueUpdate", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle.", "name": "particle" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current normalized lifetime of the particle, between 0 (birth) and 1 (death).", "name": "t" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the property." } ], "memberof": "Phaser.GameObjects.Particles.EmitterColorOp", "longname": "Phaser.GameObjects.Particles.EmitterColorOp#easeValueUpdate", "scope": "instance", "overrides": "Phaser.GameObjects.Particles.EmitterOp#easeValueUpdate", "___id": "T000002R013456", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * This class is responsible for taking control over a single property\r\n * in the Particle class and managing its emission and updating functions.\r\n *\r\n * Particles properties such as `x`, `y`, `scaleX`, `lifespan` and others all use\r\n * EmitterOp instances to manage them, as they can be given in a variety of\r\n * formats: from simple values, to functions, to dynamic callbacks.\r\n *\r\n * See the `ParticleEmitter` class for more details on emitter op configuration.\r\n *\r\n * @class EmitterOp\r\n * @memberof Phaser.GameObjects.Particles\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The name of the property.\r\n * @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} defaultValue - The default value of the property.\r\n * @param {boolean} [emitOnly=false] - Whether the property can only be modified when a Particle is emitted.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "classdesc": "This class is responsible for taking control over a single property\rin the Particle class and managing its emission and updating functions.\r\rParticles properties such as `x`, `y`, `scaleX`, `lifespan` and others all use\rEmitterOp instances to manage them, as they can be given in a variety of\rformats: from simple values, to functions, to dynamic callbacks.\r\rSee the `ParticleEmitter` class for more details on emitter op configuration.", "kind": "class", "name": "EmitterOp", "memberof": "Phaser.GameObjects.Particles", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property.", "name": "key" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "description": "The default value of the property.", "name": "defaultValue" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R013474", "___s": true }, { "comment": "/**\r\n * The name of this property.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#propertyKey\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The name of this property.", "name": "propertyKey", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#propertyKey", "scope": "instance", "kind": "member", "___id": "T000002R013478", "___s": true }, { "comment": "/**\r\n * The current value of this property.\r\n *\r\n * This can be a simple value, an array, a function or an onEmit\r\n * configuration object.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#propertyValue\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 54, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The current value of this property.\r\rThis can be a simple value, an array, a function or an onEmit\rconfiguration object.", "name": "propertyValue", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#propertyValue", "scope": "instance", "kind": "member", "___id": "T000002R013480", "___s": true }, { "comment": "/**\r\n * The default value of this property.\r\n *\r\n * This can be a simple value, an array, a function or an onEmit\r\n * configuration object.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#defaultValue\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The default value of this property.\r\rThis can be a simple value, an array, a function or an onEmit\rconfiguration object.", "name": "defaultValue", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#defaultValue", "scope": "instance", "kind": "member", "___id": "T000002R013482", "___s": true }, { "comment": "/**\r\n * The number of steps for stepped easing between {@link Phaser.GameObjects.Particles.EmitterOp#start} and\r\n * {@link Phaser.GameObjects.Particles.EmitterOp#end} values, per emit.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#steps\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 78, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The number of steps for stepped easing between {@link Phaser.GameObjects.Particles.EmitterOp#start} and\r{@link Phaser.GameObjects.Particles.EmitterOp#end} values, per emit.", "name": "steps", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#steps", "scope": "instance", "kind": "member", "___id": "T000002R013484", "___s": true }, { "comment": "/**\r\n * The step counter for stepped easing, per emit.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#counter\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 89, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The step counter for stepped easing, per emit.", "name": "counter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#counter", "scope": "instance", "kind": "member", "___id": "T000002R013486", "___s": true }, { "comment": "/**\r\n * When the step counter reaches its maximum, should it then\r\n * yoyo back to the start again, or flip over to it?\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#yoyo\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.60.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "When the step counter reaches its maximum, should it then\ryoyo back to the start again, or flip over to it?", "name": "yoyo", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#yoyo", "scope": "instance", "kind": "member", "___id": "T000002R013488", "___s": true }, { "comment": "/**\r\n * The counter direction. 0 for up and 1 for down.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#direction\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 110, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The counter direction. 0 for up and 1 for down.", "name": "direction", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#direction", "scope": "instance", "kind": "member", "___id": "T000002R013490", "___s": true }, { "comment": "/**\r\n * The start value for this property to ease between.\r\n *\r\n * If an interpolation this holds a reference to the number data array.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#start\r\n * @type {number|number[]}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 120, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The start value for this property to ease between.\r\rIf an interpolation this holds a reference to the number data array.", "name": "start", "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#start", "scope": "instance", "kind": "member", "___id": "T000002R013492", "___s": true }, { "comment": "/**\r\n * The most recently calculated value. Updated every time an\r\n * emission or update method is called. Treat as read-only.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#current\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The most recently calculated value. Updated every time an\remission or update method is called. Treat as read-only.", "name": "current", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#current", "scope": "instance", "kind": "member", "___id": "T000002R013494", "___s": true }, { "comment": "/**\r\n * The end value for this property to ease between.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#end\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The end value for this property to ease between.", "name": "end", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#end", "scope": "instance", "kind": "member", "___id": "T000002R013496", "___s": true }, { "comment": "/**\r\n * The easing function to use for updating this property, if any.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#ease\r\n * @type {?function}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The easing function to use for updating this property, if any.", "name": "ease", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [], "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#ease", "scope": "instance", "kind": "member", "___id": "T000002R013498", "___s": true }, { "comment": "/**\r\n * The interpolation function to use for updating this property, if any.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#interpolation\r\n * @type {?function}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The interpolation function to use for updating this property, if any.", "name": "interpolation", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [], "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#interpolation", "scope": "instance", "kind": "member", "___id": "T000002R013500", "___s": true }, { "comment": "/**\r\n * Whether this property can only be modified when a Particle is emitted.\r\n *\r\n * Set to `true` to allow only {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} callbacks to be set and\r\n * affect this property.\r\n *\r\n * Set to `false` to allow both {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} and\r\n * {@link Phaser.GameObjects.Particles.EmitterOp#onUpdate} callbacks to be set and affect this property.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#emitOnly\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 170, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Whether this property can only be modified when a Particle is emitted.\r\rSet to `true` to allow only {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} callbacks to be set and\raffect this property.\r\rSet to `false` to allow both {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} and\r{@link Phaser.GameObjects.Particles.EmitterOp#onUpdate} callbacks to be set and affect this property.", "name": "emitOnly", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#emitOnly", "scope": "instance", "kind": "member", "___id": "T000002R013502", "___s": true }, { "comment": "/**\r\n * The callback to run for Particles when they are emitted from the Particle Emitter.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#onEmit\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 185, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The callback to run for Particles when they are emitted from the Particle Emitter.", "name": "onEmit", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#onEmit", "scope": "instance", "kind": "member", "___id": "T000002R013504", "___s": true }, { "comment": "/**\r\n * The callback to run for Particles when they are updated.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#onUpdate\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 194, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The callback to run for Particles when they are updated.", "name": "onUpdate", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#onUpdate", "scope": "instance", "kind": "member", "___id": "T000002R013506", "___s": true }, { "comment": "/**\r\n * Set to `false` to disable this EmitterOp.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 203, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Set to `false` to disable this EmitterOp.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#active", "scope": "instance", "kind": "member", "___id": "T000002R013508", "___s": true }, { "comment": "/**\r\n * The onEmit method type of this EmitterOp.\r\n *\r\n * Set as part of `setMethod` and cached here to avoid\r\n * re-setting when only the value changes.\r\n *\r\n * @name Phaser.GameObjects.Particles.EmitterOp#method\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 212, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The onEmit method type of this EmitterOp.\r\rSet as part of `setMethod` and cached here to avoid\rre-setting when only the value changes.", "name": "method", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#method", "scope": "instance", "kind": "member", "___id": "T000002R013510", "___s": true }, { "comment": "/**\r\n * Load the property from a Particle Emitter configuration object.\r\n *\r\n * Optionally accepts a new property key to use, replacing the current one.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#loadConfig\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.ParticleEmitterConfig} [config] - Settings for the Particle Emitter that owns this property.\r\n * @param {string} [newKey] - The new key to use for this property, if any.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Load the property from a Particle Emitter configuration object.\r\rOptionally 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig" } }, "optional": true, "description": "Settings for the Particle Emitter that owns this property.", "name": "config" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R013516", "___s": true }, { "comment": "/**\r\n * Build a JSON representation of this Particle Emitter property.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {object} A JSON representation of this Particle Emitter property.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 287, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Build a JSON representation of this Particle Emitter property.", "kind": "function", "name": "toJSON", "since": "3.0.0", "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "A JSON representation of this Particle Emitter property." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#toJSON", "scope": "instance", "___id": "T000002R013523", "___s": true }, { "comment": "/**\r\n * Change the current value of the property and update its callback methods.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#onChange\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The new numeric value of this property.\r\n *\r\n * @return {this} This Emitter Op object.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 300, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new numeric value of this property.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Emitter Op object." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#onChange", "scope": "instance", "___id": "T000002R013525", "___s": true }, { "comment": "/**\r\n * Checks the type of `EmitterOp.propertyValue` to determine which\r\n * method is required in order to return values from this op function.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#getMethod\r\n * @since 3.60.0\r\n *\r\n * @return {number} A number between 0 and 9 which should be passed to `setMethods`.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 360, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Checks the type of `EmitterOp.propertyValue` to determine which\rmethod is required in order to return values from this op function.", "kind": "function", "name": "getMethod", "since": "3.60.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A number between 0 and 9 which should be passed to `setMethods`." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#getMethod", "scope": "instance", "___id": "T000002R013536", "___s": true }, { "comment": "/**\r\n * Update the {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} and\r\n * {@link Phaser.GameObjects.Particles.EmitterOp#onUpdate} callbacks based on the method returned\r\n * from `getMethod`. The method is stored in the `EmitterOp.method` property\r\n * and is a number between 0 and 9 inclusively.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#setMethods\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Emitter Op object.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 436, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Update the {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} and\r{@link Phaser.GameObjects.Particles.EmitterOp#onUpdate} callbacks based on the method returned\rfrom `getMethod`. The method is stored in the `EmitterOp.method` property\rand is a number between 0 and 9 inclusively.", "kind": "function", "name": "setMethods", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Emitter Op object." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#setMethods", "scope": "instance", "___id": "T000002R013540", "___s": true }, { "comment": "/**\r\n * Check whether an object has the given property.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#has\r\n * @since 3.0.0\r\n *\r\n * @param {object} object - The object to check.\r\n * @param {string} key - The key of the property to look for in the object.\r\n *\r\n * @return {boolean} `true` if the property exists in the object, `false` otherwise.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 548, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Check whether an object has the given property.", "kind": "function", "name": "has", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The object to check.", "name": "object" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the property to look for in the object.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R013591", "___s": true }, { "comment": "/**\r\n * Check whether an object has both of the given properties.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#hasBoth\r\n * @since 3.0.0\r\n *\r\n * @param {object} object - The object to check.\r\n * @param {string} key1 - The key of the first property to check the object for.\r\n * @param {string} key2 - The key of the second property to check the object for.\r\n *\r\n * @return {boolean} `true` if both properties exist in the object, `false` otherwise.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 564, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Check whether an object has both of the given properties.", "kind": "function", "name": "hasBoth", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The object to check.", "name": "object" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the first property to check the object for.", "name": "key1" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the second property to check the object for.", "name": "key2" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R013593", "___s": true }, { "comment": "/**\r\n * Check whether an object has at least one of the given properties.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#hasEither\r\n * @since 3.0.0\r\n *\r\n * @param {object} object - The object to check.\r\n * @param {string} key1 - The key of the first property to check the object for.\r\n * @param {string} key2 - The key of the second property to check the object for.\r\n *\r\n * @return {boolean} `true` if at least one of the properties exists in the object, `false` if neither exist.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 581, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The object to check.", "name": "object" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the first property to check the object for.", "name": "key1" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the second property to check the object for.", "name": "key2" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R013595", "___s": true }, { "comment": "/**\r\n * The returned value sets what the property will be at the START of the particle's life, on emit.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#defaultEmit\r\n * @since 3.0.0\r\n *\r\n * @return {number} The new value of the property.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 598, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The returned value sets what the property will be at the START of the particle's life, on emit.", "kind": "function", "name": "defaultEmit", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the property." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#defaultEmit", "scope": "instance", "___id": "T000002R013597", "___s": true }, { "comment": "/**\r\n * The returned value updates the property for the duration of the particle's life.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#defaultUpdate\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle.\r\n * @param {string} key - The name of the property.\r\n * @param {number} t - The current normalized lifetime of the particle, between 0 (birth) and 1 (death).\r\n * @param {number} value - The current value of the property.\r\n *\r\n * @return {number} The new value of the property.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 611, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The returned value updates the property for the duration of the particle's life.", "kind": "function", "name": "defaultUpdate", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle.", "name": "particle" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current normalized lifetime of the particle, between 0 (birth) and 1 (death).", "name": "t" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current value of the property.", "name": "value" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the property." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#defaultUpdate", "scope": "instance", "___id": "T000002R013599", "___s": true }, { "comment": "/**\r\n * The returned value sets what the property will be at the START of the particle's life, on emit.\r\n *\r\n * This method is only used when you have provided a custom emit callback.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#proxyEmit\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle.\r\n * @param {string} key - The name of the property.\r\n * @param {number} [value] - The current value of the property.\r\n *\r\n * @return {number} The new value of the property.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 629, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The returned value sets what the property will be at the START of the particle's life, on emit.\r\rThis method is only used when you have provided a custom emit callback.", "kind": "function", "name": "proxyEmit", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle.", "name": "particle" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The current value of the property.", "name": "value" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the property." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#proxyEmit", "scope": "instance", "___id": "T000002R013601", "___s": true }, { "comment": "/**\r\n * The returned value updates the property for the duration of the particle's life.\r\n *\r\n * This method is only used when you have provided a custom update callback.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#proxyUpdate\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle.\r\n * @param {string} key - The name of the property.\r\n * @param {number} t - The current normalized lifetime of the particle, between 0 (birth) and 1 (death).\r\n * @param {number} value - The current value of the property.\r\n *\r\n * @return {number} The new value of the property.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 652, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The returned value updates the property for the duration of the particle's life.\r\rThis method is only used when you have provided a custom update callback.", "kind": "function", "name": "proxyUpdate", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle.", "name": "particle" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current normalized lifetime of the particle, between 0 (birth) and 1 (death).", "name": "t" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current value of the property.", "name": "value" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the property." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#proxyUpdate", "scope": "instance", "___id": "T000002R013605", "___s": true }, { "comment": "/**\r\n * An `onEmit` callback that returns the current value of the property.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#staticValueEmit\r\n * @since 3.0.0\r\n *\r\n * @return {number} The current value of the property.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 676, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An `onEmit` callback that returns the current value of the property.", "kind": "function", "name": "staticValueEmit", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current value of the property." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#staticValueEmit", "scope": "instance", "___id": "T000002R013609", "___s": true }, { "comment": "/**\r\n * An `onUpdate` callback that returns the current value of the property.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#staticValueUpdate\r\n * @since 3.0.0\r\n *\r\n * @return {number} The current value of the property.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 689, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An `onUpdate` callback that returns the current value of the property.", "kind": "function", "name": "staticValueUpdate", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current value of the property." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#staticValueUpdate", "scope": "instance", "___id": "T000002R013611", "___s": true }, { "comment": "/**\r\n * An `onEmit` callback that returns a random value from the current value array.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#randomStaticValueEmit\r\n * @since 3.0.0\r\n *\r\n * @return {number} The new value of the property.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 702, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the property." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#randomStaticValueEmit", "scope": "instance", "___id": "T000002R013613", "___s": true }, { "comment": "/**\r\n * An `onEmit` callback that returns a value between the {@link Phaser.GameObjects.Particles.EmitterOp#start} and\r\n * {@link Phaser.GameObjects.Particles.EmitterOp#end} range.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#randomRangedValueEmit\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle.\r\n * @param {string} key - The key of the property.\r\n *\r\n * @return {number} The new value of the property.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 719, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An `onEmit` callback that returns a value between the {@link Phaser.GameObjects.Particles.EmitterOp#start} and\r{@link Phaser.GameObjects.Particles.EmitterOp#end} range.", "kind": "function", "name": "randomRangedValueEmit", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle.", "name": "particle" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the property.", "name": "key" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the property." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#randomRangedValueEmit", "scope": "instance", "___id": "T000002R013617", "___s": true }, { "comment": "/**\r\n * An `onEmit` callback that returns a random integer value between the {@link Phaser.GameObjects.Particles.EmitterOp#start} and\r\n * {@link Phaser.GameObjects.Particles.EmitterOp#end} range.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#randomRangedIntEmit\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle.\r\n * @param {string} key - The key of the property.\r\n *\r\n * @return {number} The new value of the property.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 746, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An `onEmit` callback that returns a random integer value between the {@link Phaser.GameObjects.Particles.EmitterOp#start} and\r{@link Phaser.GameObjects.Particles.EmitterOp#end} range.", "kind": "function", "name": "randomRangedIntEmit", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle.", "name": "particle" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the property.", "name": "key" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the property." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#randomRangedIntEmit", "scope": "instance", "___id": "T000002R013623", "___s": true }, { "comment": "/**\r\n * An `onEmit` callback that returns a stepped value between the\r\n * {@link Phaser.GameObjects.Particles.EmitterOp#start} and {@link Phaser.GameObjects.Particles.EmitterOp#end}\r\n * range.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#steppedEmit\r\n * @since 3.0.0\r\n *\r\n * @return {number} The new value of the property.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 773, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An `onEmit` callback that returns a stepped value between the\r{@link Phaser.GameObjects.Particles.EmitterOp#start} and {@link Phaser.GameObjects.Particles.EmitterOp#end}\rrange.", "kind": "function", "name": "steppedEmit", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the property." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#steppedEmit", "scope": "instance", "___id": "T000002R013629", "___s": true }, { "comment": "/**\r\n * An `onEmit` callback for an eased property.\r\n *\r\n * It prepares the particle for easing by {@link Phaser.GameObjects.Particles.EmitterOp#easeValueUpdate}.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#easedValueEmit\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle.\r\n * @param {string} key - The name of the property.\r\n *\r\n * @return {number} {@link Phaser.GameObjects.Particles.EmitterOp#start}, as the new value of the property.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 836, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An `onEmit` callback for an eased property.\r\rIt 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle.", "name": "particle" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property.", "name": "key" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R013646", "___s": true }, { "comment": "/**\r\n * An `onUpdate` callback that returns an eased value between the\r\n * {@link Phaser.GameObjects.Particles.EmitterOp#start} and {@link Phaser.GameObjects.Particles.EmitterOp#end}\r\n * range.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#easeValueUpdate\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle.\r\n * @param {string} key - The name of the property.\r\n * @param {number} t - The current normalized lifetime of the particle, between 0 (birth) and 1 (death).\r\n *\r\n * @return {number} The new value of the property.\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 864, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An `onUpdate` callback that returns an eased value between the\r{@link Phaser.GameObjects.Particles.EmitterOp#start} and {@link Phaser.GameObjects.Particles.EmitterOp#end}\rrange.", "kind": "function", "name": "easeValueUpdate", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle.", "name": "particle" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current normalized lifetime of the particle, between 0 (birth) and 1 (death).", "name": "t" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the property." } ], "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#easeValueUpdate", "scope": "instance", "___id": "T000002R013652", "___s": true }, { "comment": "/**\r\n * Destroys this EmitterOp instance and all of its references.\r\n *\r\n * Called automatically when the ParticleEmitter that owns this\r\n * EmitterOp is destroyed.\r\n *\r\n * @method Phaser.GameObjects.Particles.EmitterOp#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "EmitterOp.js", "lineno": 899, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Destroys this EmitterOp instance and all of its references.\r\rCalled automatically when the ParticleEmitter that owns this\rEmitterOp is destroyed.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.EmitterOp", "longname": "Phaser.GameObjects.Particles.EmitterOp#destroy", "scope": "instance", "___id": "T000002R013660", "___s": true }, { "comment": "/**\r\n * The Particle Emitter Complete Event.\r\n *\r\n * This event is dispatched when the final particle, emitted from a Particle Emitter that\r\n * has been stopped, dies. Upon receipt of this event you know that no particles are\r\n * still rendering at this point in time.\r\n *\r\n * Listen for it on a Particle Emitter instance using `ParticleEmitter.on('complete', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Particles.Events#COMPLETE\r\n * @type {string}\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.ParticleEmitter} emitter - A reference to the Particle Emitter that just completed.\r\n */", "meta": { "filename": "COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\events", "code": {} }, "description": "The Particle Emitter Complete Event.\r\rThis event is dispatched when the final particle, emitted from a Particle Emitter that\rhas been stopped, dies. Upon receipt of this event you know that no particles are\rstill rendering at this point in time.\r\rListen for it on a Particle Emitter instance using `ParticleEmitter.on('complete', listener)`.", "kind": "event", "name": "COMPLETE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleEmitter" } }, "description": "A reference to the Particle Emitter that just completed.", "name": "emitter" } ], "memberof": "Phaser.GameObjects.Particles.Events", "longname": "Phaser.GameObjects.Particles.Events#event:COMPLETE", "scope": "instance", "___id": "T000002R013669", "___s": true }, { "comment": "/**\r\n * The Particle Emitter Death Zone Event.\r\n *\r\n * This event is dispatched when a Death Zone kills a Particle instance.\r\n *\r\n * Listen for it on a Particle Emitter instance using `ParticleEmitter.on('deathzone', listener)`.\r\n *\r\n * If you wish to know when the final particle is killed, see the `COMPLETE` event.\r\n *\r\n * @event Phaser.GameObjects.Particles.Events#DEATH_ZONE\r\n * @type {string}\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.ParticleEmitter} emitter - A reference to the Particle Emitter that owns the Particle and Death Zone.\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The Particle that has been killed.\r\n * @param {Phaser.GameObjects.Particles.Zones.DeathZone} zone - The Death Zone that killed the particle.\r\n */", "meta": { "filename": "DEATH_ZONE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\events", "code": {} }, "description": "The Particle Emitter Death Zone Event.\r\rThis event is dispatched when a Death Zone kills a Particle instance.\r\rListen for it on a Particle Emitter instance using `ParticleEmitter.on('deathzone', listener)`.\r\rIf you wish to know when the final particle is killed, see the `COMPLETE` event.", "kind": "event", "name": "DEATH_ZONE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleEmitter" } }, "description": "A reference to the Particle Emitter that owns the Particle and Death Zone.", "name": "emitter" }, { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The Particle that has been killed.", "name": "particle" }, { "type": { "names": [ "Phaser.GameObjects.Particles.Zones.DeathZone" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Zones.DeathZone" } }, "description": "The Death Zone that killed the particle.", "name": "zone" } ], "memberof": "Phaser.GameObjects.Particles.Events", "longname": "Phaser.GameObjects.Particles.Events#event:DEATH_ZONE", "scope": "instance", "___id": "T000002R013671", "___s": true }, { "comment": "/**\r\n * The Particle Emitter Explode Event.\r\n *\r\n * This event is dispatched when a Particle Emitter explodes a set of particles.\r\n *\r\n * Listen for it on a Particle Emitter instance using `ParticleEmitter.on('explode', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Particles.Events#EXPLODE\r\n * @type {string}\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.ParticleEmitter} emitter - A reference to the Particle Emitter that just completed.\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The most recently emitted Particle.\r\n */", "meta": { "filename": "EXPLODE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\events", "code": {} }, "description": "The Particle Emitter Explode Event.\r\rThis event is dispatched when a Particle Emitter explodes a set of particles.\r\rListen for it on a Particle Emitter instance using `ParticleEmitter.on('explode', listener)`.", "kind": "event", "name": "EXPLODE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleEmitter" } }, "description": "A reference to the Particle Emitter that just completed.", "name": "emitter" }, { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The most recently emitted Particle.", "name": "particle" } ], "memberof": "Phaser.GameObjects.Particles.Events", "longname": "Phaser.GameObjects.Particles.Events#event:EXPLODE", "scope": "instance", "___id": "T000002R013673", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.GameObjects.Particles.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.GameObjects.Particles", "longname": "Phaser.GameObjects.Particles.Events", "scope": "static", "___id": "T000002R013675", "___s": true }, { "comment": "/**\r\n * The Particle Emitter Start Event.\r\n *\r\n * This event is dispatched when a Particle Emitter starts emission of particles.\r\n *\r\n * Listen for it on a Particle Emitter instance using `ParticleEmitter.on('start', listener)`.\r\n *\r\n * @event Phaser.GameObjects.Particles.Events#START\r\n * @type {string}\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.ParticleEmitter} emitter - A reference to the Particle Emitter that just completed.\r\n */", "meta": { "filename": "START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\events", "code": {} }, "description": "The Particle Emitter Start Event.\r\rThis event is dispatched when a Particle Emitter starts emission of particles.\r\rListen for it on a Particle Emitter instance using `ParticleEmitter.on('start', listener)`.", "kind": "event", "name": "START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleEmitter" } }, "description": "A reference to the Particle Emitter that just completed.", "name": "emitter" } ], "memberof": "Phaser.GameObjects.Particles.Events", "longname": "Phaser.GameObjects.Particles.Events#event:START", "scope": "instance", "___id": "T000002R013682", "___s": true }, { "comment": "/**\r\n * The Particle Emitter Stop Event.\r\n *\r\n * This event is dispatched when a Particle Emitter is stopped. This can happen either\r\n * when you directly call the `ParticleEmitter.stop` method, or if the emitter has\r\n * been configured to stop after a set time via the `duration` property, or after a\r\n * set number of particles via the `stopAfter` property.\r\n *\r\n * Listen for it on a Particle Emitter instance using `ParticleEmitter.on('stop', listener)`.\r\n *\r\n * Note that just because the emitter has stopped, that doesn't mean there aren't still\r\n * particles alive and rendering. It just means the emitter has stopped emitting particles.\r\n *\r\n * If you wish to know when the final particle is killed, see the `COMPLETE` event.\r\n *\r\n * @event Phaser.GameObjects.Particles.Events#STOP\r\n * @type {string}\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.ParticleEmitter} emitter - A reference to the Particle Emitter that just completed.\r\n */", "meta": { "filename": "STOP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\events", "code": {} }, "description": "The Particle Emitter Stop Event.\r\rThis event is dispatched when a Particle Emitter is stopped. This can happen either\rwhen you directly call the `ParticleEmitter.stop` method, or if the emitter has\rbeen configured to stop after a set time via the `duration` property, or after a\rset number of particles via the `stopAfter` property.\r\rListen for it on a Particle Emitter instance using `ParticleEmitter.on('stop', listener)`.\r\rNote that just because the emitter has stopped, that doesn't mean there aren't still\rparticles alive and rendering. It just means the emitter has stopped emitting particles.\r\rIf you wish to know when the final particle is killed, see the `COMPLETE` event.", "kind": "event", "name": "STOP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleEmitter" } }, "description": "A reference to the Particle Emitter that just completed.", "name": "emitter" } ], "memberof": "Phaser.GameObjects.Particles.Events", "longname": "Phaser.GameObjects.Particles.Events#event:STOP", "scope": "instance", "___id": "T000002R013684", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Gravity Well Particle Processor applies a force on the particles to draw\r\n * them towards, or repel them from, a single point.\r\n *\r\n * The force applied is inversely proportional to the square of the distance\r\n * from the particle to the point, in accordance with Newton's law of gravity.\r\n *\r\n * This simulates the effect of gravity over large distances (as between planets, for example).\r\n *\r\n * @class GravityWell\r\n * @extends Phaser.GameObjects.Particles.ParticleProcessor\r\n * @memberof Phaser.GameObjects.Particles\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {(number|Phaser.Types.GameObjects.Particles.GravityWellConfig)} [x=0] - The x coordinate of the Gravity Well, in world space.\r\n * @param {number} [y=0] - The y coordinate of the Gravity Well, in world space.\r\n * @param {number} [power=0] - The strength of the gravity force - larger numbers produce a stronger force.\r\n * @param {number} [epsilon=100] - The minimum distance for which the gravity force is calculated.\r\n * @param {number} [gravity=50] - The gravitational force of this Gravity Well.\r\n */", "meta": { "filename": "GravityWell.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "classdesc": "The Gravity Well Particle Processor applies a force on the particles to draw\rthem towards, or repel them from, a single point.\r\rThe force applied is inversely proportional to the square of the distance\rfrom the particle to the point, in accordance with Newton's law of gravity.\r\rThis simulates the effect of gravity over large distances (as between planets, for example).", "kind": "class", "name": "GravityWell", "augments": [ "Phaser.GameObjects.Particles.ParticleProcessor" ], "memberof": "Phaser.GameObjects.Particles", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "Phaser.Types.GameObjects.Particles.GravityWellConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the Gravity Well, in world space.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The strength of the gravity force - larger numbers produce a stronger force.", "name": "power" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 100, "description": "The minimum distance for which the gravity force is calculated.", "name": "epsilon" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 50, "description": "The gravitational force of this Gravity Well.", "name": "gravity" } ], "scope": "static", "longname": "Phaser.GameObjects.Particles.GravityWell", "___id": "T000002R013689", "___s": true }, { "comment": "/**\r\n * Takes a Particle and updates its velocity based on the gravitational force exerted\r\n * by this Gravity Well. The force is calculated using the squared distance between the\r\n * particle and the well, clamped by `epsilon` to avoid extreme forces at very close range,\r\n * then applied to the particle's horizontal and vertical velocity components.\r\n *\r\n * @method Phaser.GameObjects.Particles.GravityWell#update\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The Particle to update.\r\n * @param {number} delta - The delta time in ms.\r\n * @param {number} step - The delta value divided by 1000.\r\n */", "meta": { "filename": "GravityWell.js", "lineno": 95, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Takes a Particle and updates its velocity based on the gravitational force exerted\rby this Gravity Well. The force is calculated using the squared distance between the\rparticle and the well, clamped by `epsilon` to avoid extreme forces at very close range,\rthen applied to the particle's horizontal and vertical velocity components.", "kind": "function", "name": "update", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The Particle to update.", "name": "particle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time in ms.", "name": "delta" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value divided by 1000.", "name": "step" } ], "memberof": "Phaser.GameObjects.Particles.GravityWell", "longname": "Phaser.GameObjects.Particles.GravityWell#update", "scope": "instance", "overrides": "Phaser.GameObjects.Particles.ParticleProcessor#update", "___id": "T000002R013710", "___s": true }, { "comment": "/**\r\n * The minimum distance for which the gravity force is calculated, in pixels.\r\n *\r\n * This acts as a lower bound on the distance used in the gravity calculation,\r\n * preventing extreme or infinite forces when a particle passes very close to\r\n * the well's position. Increase this value to soften the effect at close range.\r\n *\r\n * Defaults to 100.\r\n *\r\n * @name Phaser.GameObjects.Particles.GravityWell#epsilon\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GravityWell.js", "lineno": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The minimum distance for which the gravity force is calculated, in pixels.\r\rThis acts as a lower bound on the distance used in the gravity calculation,\rpreventing extreme or infinite forces when a particle passes very close to\rthe well's position. Increase this value to soften the effect at close range.\r\rDefaults to 100.", "name": "epsilon", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.GravityWell", "longname": "Phaser.GameObjects.Particles.GravityWell#epsilon", "scope": "instance", "kind": "member", "___id": "T000002R013720", "___s": true }, { "comment": "/**\r\n * The strength of the gravity force - larger numbers produce a stronger attractive force.\r\n * Negative values reverse the effect, repelling particles away from the well instead.\r\n *\r\n * Internally this value is scaled by `gravity`, so changing `gravity` will also affect\r\n * the effective force even if `power` remains the same.\r\n *\r\n * Defaults to 0.\r\n *\r\n * @name Phaser.GameObjects.Particles.GravityWell#power\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GravityWell.js", "lineno": 159, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The strength of the gravity force - larger numbers produce a stronger attractive force.\rNegative values reverse the effect, repelling particles away from the well instead.\r\rInternally this value is scaled by `gravity`, so changing `gravity` will also affect\rthe effective force even if `power` remains the same.\r\rDefaults to 0.", "name": "power", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.GravityWell", "longname": "Phaser.GameObjects.Particles.GravityWell#power", "scope": "instance", "kind": "member", "___id": "T000002R013725", "___s": true }, { "comment": "/**\r\n * The base gravitational force of this Gravity Well. This value acts as a scalar\r\n * that is multiplied with `power` to determine the total force applied to particles.\r\n * Increasing `gravity` amplifies the effect of `power`; setting it to zero will\r\n * neutralise the well regardless of the `power` value.\r\n *\r\n * Defaults to 50.\r\n *\r\n * @name Phaser.GameObjects.Particles.GravityWell#gravity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "GravityWell.js", "lineno": 186, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The base gravitational force of this Gravity Well. This value acts as a scalar\rthat is multiplied with `power` to determine the total force applied to particles.\rIncreasing `gravity` amplifies the effect of `power`; setting it to zero will\rneutralise the well regardless of the `power` value.\r\rDefaults to 50.", "name": "gravity", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.GravityWell", "longname": "Phaser.GameObjects.Particles.GravityWell#gravity", "scope": "instance", "kind": "member", "___id": "T000002R013730", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.GameObjects.Particles\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "kind": "namespace", "name": "Particles", "memberof": "Phaser.GameObjects", "longname": "Phaser.GameObjects.Particles", "scope": "static", "___id": "T000002R013738", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Particle is a lightweight object owned and controlled by a ParticleEmitter. Each Particle\r\n * holds its own position, velocity, acceleration, rotation, scale, alpha, tint, and lifespan\r\n * values, which are updated each frame by the Emitter's configured EmitterOp instances.\r\n * Particles are pooled and recycled by the Emitter for performance. When a particle's lifespan\r\n * expires, it is deactivated and returned to the pool for reuse rather than being destroyed.\r\n * You do not normally create Particle instances directly; instead, the Emitter manages their\r\n * lifecycle. You can extend this class to add custom properties by providing a custom\r\n * `particleClass` in the emitter configuration.\r\n *\r\n * @class Particle\r\n * @memberof Phaser.GameObjects.Particles\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.ParticleEmitter} emitter - The Emitter to which this Particle belongs.\r\n */", "meta": { "filename": "Particle.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "classdesc": "A Particle is a lightweight object owned and controlled by a ParticleEmitter. Each Particle\rholds its own position, velocity, acceleration, rotation, scale, alpha, tint, and lifespan\rvalues, which are updated each frame by the Emitter's configured EmitterOp instances.\rParticles are pooled and recycled by the Emitter for performance. When a particle's lifespan\rexpires, it is deactivated and returned to the pool for reuse rather than being destroyed.\rYou do not normally create Particle instances directly; instead, the Emitter manages their\rlifecycle. You can extend this class to add custom properties by providing a custom\r`particleClass` in the emitter configuration.", "kind": "class", "name": "Particle", "memberof": "Phaser.GameObjects.Particles", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleEmitter" } }, "description": "The Emitter to which this Particle belongs.", "name": "emitter" } ], "scope": "static", "longname": "Phaser.GameObjects.Particles.Particle", "___id": "T000002R013756", "___s": true }, { "comment": "/**\r\n * The Emitter to which this Particle belongs.\r\n *\r\n * A Particle can only belong to a single Emitter and is created, updated and destroyed by it.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#emitter\r\n * @type {Phaser.GameObjects.Particles.ParticleEmitter}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The Emitter to which this Particle belongs.\r\rA Particle can only belong to a single Emitter and is created, updated and destroyed by it.", "name": "emitter", "type": { "names": [ "Phaser.GameObjects.Particles.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleEmitter" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#emitter", "scope": "instance", "kind": "member", "___id": "T000002R013759", "___s": true }, { "comment": "/**\r\n * The texture used by this Particle when it renders.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#texture\r\n * @type {Phaser.Textures.Texture}\r\n * @default null\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The texture used by this Particle when it renders.", "name": "texture", "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "defaultvalue": "null", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#texture", "scope": "instance", "kind": "member", "___id": "T000002R013761", "___s": true }, { "comment": "/**\r\n * The texture frame used by this Particle when it renders.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#frame\r\n * @type {Phaser.Textures.Frame}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 60, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The texture frame used by this Particle when it renders.", "name": "frame", "type": { "names": [ "Phaser.Textures.Frame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#frame", "scope": "instance", "kind": "member", "___id": "T000002R013763", "___s": true }, { "comment": "/**\r\n * The x coordinate of this Particle.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#x\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The x coordinate of this Particle.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#x", "scope": "instance", "kind": "member", "___id": "T000002R013765", "___s": true }, { "comment": "/**\r\n * The y coordinate of this Particle.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#y\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The y coordinate of this Particle.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#y", "scope": "instance", "kind": "member", "___id": "T000002R013767", "___s": true }, { "comment": "/**\r\n * The coordinates of this Particle in world space.\r\n *\r\n * Updated as part of `computeVelocity`.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#worldPosition\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 90, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The coordinates of this Particle in world space.\r\rUpdated as part of `computeVelocity`.", "name": "worldPosition", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#worldPosition", "scope": "instance", "kind": "member", "___id": "T000002R013769", "___s": true }, { "comment": "/**\r\n * The x velocity of this Particle, in pixels per second.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#velocityX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 101, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The x velocity of this Particle, in pixels per second.", "name": "velocityX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#velocityX", "scope": "instance", "kind": "member", "___id": "T000002R013771", "___s": true }, { "comment": "/**\r\n * The y velocity of this Particle, in pixels per second.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#velocityY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 111, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The y velocity of this Particle, in pixels per second.", "name": "velocityY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#velocityY", "scope": "instance", "kind": "member", "___id": "T000002R013773", "___s": true }, { "comment": "/**\r\n * The x acceleration of this Particle, in pixels per second squared.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#accelerationX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 121, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The x acceleration of this Particle, in pixels per second squared.", "name": "accelerationX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#accelerationX", "scope": "instance", "kind": "member", "___id": "T000002R013775", "___s": true }, { "comment": "/**\r\n * The y acceleration of this Particle, in pixels per second squared.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#accelerationY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The y acceleration of this Particle, in pixels per second squared.", "name": "accelerationY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#accelerationY", "scope": "instance", "kind": "member", "___id": "T000002R013777", "___s": true }, { "comment": "/**\r\n * The maximum horizontal velocity this Particle can travel at, in pixels per second.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#maxVelocityX\r\n * @type {number}\r\n * @default 10000\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 141, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The maximum horizontal velocity this Particle can travel at, in pixels per second.", "name": "maxVelocityX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "10000", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#maxVelocityX", "scope": "instance", "kind": "member", "___id": "T000002R013779", "___s": true }, { "comment": "/**\r\n * The maximum vertical velocity this Particle can travel at, in pixels per second.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#maxVelocityY\r\n * @type {number}\r\n * @default 10000\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 151, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The maximum vertical velocity this Particle can travel at, in pixels per second.", "name": "maxVelocityY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "10000", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#maxVelocityY", "scope": "instance", "kind": "member", "___id": "T000002R013781", "___s": true }, { "comment": "/**\r\n * The bounciness, or restitution, of this Particle.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#bounce\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The bounciness, or restitution, of this Particle.", "name": "bounce", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#bounce", "scope": "instance", "kind": "member", "___id": "T000002R013783", "___s": true }, { "comment": "/**\r\n * The horizontal scale of this Particle.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#scaleX\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 171, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The horizontal scale of this Particle.", "name": "scaleX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#scaleX", "scope": "instance", "kind": "member", "___id": "T000002R013785", "___s": true }, { "comment": "/**\r\n * The vertical scale of this Particle.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#scaleY\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 181, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The vertical scale of this Particle.", "name": "scaleY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#scaleY", "scope": "instance", "kind": "member", "___id": "T000002R013787", "___s": true }, { "comment": "/**\r\n * The alpha value of this Particle.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#alpha\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 191, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The alpha value of this Particle.", "name": "alpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#alpha", "scope": "instance", "kind": "member", "___id": "T000002R013789", "___s": true }, { "comment": "/**\r\n * The angle of this Particle in degrees.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#angle\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 201, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The angle of this Particle in degrees.", "name": "angle", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#angle", "scope": "instance", "kind": "member", "___id": "T000002R013791", "___s": true }, { "comment": "/**\r\n * The angle of this Particle in radians.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#rotation\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The angle of this Particle in radians.", "name": "rotation", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#rotation", "scope": "instance", "kind": "member", "___id": "T000002R013793", "___s": true }, { "comment": "/**\r\n * The tint applied to this Particle.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#tint\r\n * @type {number}\r\n * @webglOnly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 221, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The tint applied to this Particle.", "name": "tint", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#tint", "scope": "instance", "kind": "member", "___id": "T000002R013795", "___s": true }, { "comment": "/**\r\n * The lifespan of this Particle in ms.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#life\r\n * @type {number}\r\n * @default 1000\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 231, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The lifespan of this Particle in ms.", "name": "life", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1000", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#life", "scope": "instance", "kind": "member", "___id": "T000002R013797", "___s": true }, { "comment": "/**\r\n * The current life of this Particle in ms.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#lifeCurrent\r\n * @type {number}\r\n * @default 1000\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 241, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The current life of this Particle in ms.", "name": "lifeCurrent", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1000", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#lifeCurrent", "scope": "instance", "kind": "member", "___id": "T000002R013799", "___s": true }, { "comment": "/**\r\n * The delay applied to this Particle upon emission, in ms.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#delayCurrent\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 251, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The delay applied to this Particle upon emission, in ms.", "name": "delayCurrent", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#delayCurrent", "scope": "instance", "kind": "member", "___id": "T000002R013801", "___s": true }, { "comment": "/**\r\n * The hold applied to this Particle before it expires, in ms.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#holdCurrent\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 261, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The hold applied to this Particle before it expires, in ms.", "name": "holdCurrent", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#holdCurrent", "scope": "instance", "kind": "member", "___id": "T000002R013803", "___s": true }, { "comment": "/**\r\n * The normalized lifespan T value, where 0 is the start and 1 is the end.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#lifeT\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 271, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The normalized lifespan T value, where 0 is the start and 1 is the end.", "name": "lifeT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#lifeT", "scope": "instance", "kind": "member", "___id": "T000002R013805", "___s": true }, { "comment": "/**\r\n * An object that stores the min/max interpolation values for each of this Particle's\r\n * properties (such as alpha, tint, scaleX, rotate, etc.) as they are eased over the\r\n * particle's lifetime. These values are populated and used by the EmitterOp instances\r\n * on the parent Emitter.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#data\r\n * @type {Phaser.Types.GameObjects.Particles.ParticleData}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 281, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An object that stores the min/max interpolation values for each of this Particle's\rproperties (such as alpha, tint, scaleX, rotate, etc.) as they are eased over the\rparticle's lifetime. These values are populated and used by the EmitterOp instances\ron the parent Emitter.", "name": "data", "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleData" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleData" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#data", "scope": "instance", "kind": "member", "___id": "T000002R013807", "___s": true }, { "comment": "/**\r\n * A reference to the Scene to which this Game Object belongs.\r\n *\r\n * Game Objects can only belong to one Scene.\r\n *\r\n * You should consider this property as being read-only. You cannot move a\r\n * Game Object to another Scene by simply changing it.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 319, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "A reference to the Scene to which this Game Object belongs.\r\rGame Objects can only belong to one Scene.\r\rYou should consider this property as being read-only. You cannot move a\rGame Object to another Scene by simply changing it.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#scene", "scope": "instance", "kind": "member", "___id": "T000002R013853", "___s": true }, { "comment": "/**\r\n * The Animation State component of this Particle.\r\n *\r\n * This component provides features to apply animations to this Particle.\r\n * It is responsible for playing, loading, queuing animations for later playback,\r\n * mixing between animations and setting the current animation frame to this Particle.\r\n *\r\n * It is created only if the Particle's Emitter has at least one Animation.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#anims\r\n * @type {?Phaser.Animations.AnimationState}\r\n * @since 3.60.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setAnim\r\n */", "meta": { "filename": "Particle.js", "lineno": 333, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The Animation State component of this Particle.\r\rThis component provides features to apply animations to this Particle.\rIt is responsible for playing, loading, queuing animations for later playback,\rmixing between animations and setting the current animation frame to this Particle.\r\rIt is created only if the Particle's Emitter has at least one Animation.", "name": "anims", "type": { "names": [ "Phaser.Animations.AnimationState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationState", "nullable": true } }, "nullable": true, "since": "3.60.0", "see": [ "Phaser.GameObjects.Particles.ParticleEmitter#setAnim" ], "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#anims", "scope": "instance", "kind": "member", "___id": "T000002R013855", "___s": true }, { "comment": "/**\r\n * A rectangle that holds the bounds of this Particle after a call to\r\n * the `Particle.getBounds` method has been made.\r\n *\r\n * @name Phaser.GameObjects.Particles.Particle#bounds\r\n * @type {Phaser.Geom.Rectangle}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 354, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "A rectangle that holds the bounds of this Particle after a call to\rthe `Particle.getBounds` method has been made.", "name": "bounds", "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#bounds", "scope": "instance", "kind": "member", "___id": "T000002R013858", "___s": true }, { "comment": "/**\r\n * The Event Emitter proxy.\r\n *\r\n * Passes on all parameters to the `ParticleEmitter` to emit directly.\r\n *\r\n * @method Phaser.GameObjects.Particles.Particle#emit\r\n * @since 3.60.0\r\n *\r\n * @param {(string|Symbol)} event - The event name.\r\n * @param {any} [a1] - Optional argument 1.\r\n * @param {any} [a2] - Optional argument 2.\r\n * @param {any} [a3] - Optional argument 3.\r\n * @param {any} [a4] - Optional argument 4.\r\n * @param {any} [a5] - Optional argument 5.\r\n *\r\n * @return {boolean} `true` if the event had listeners, else `false`.\r\n */", "meta": { "filename": "Particle.js", "lineno": 365, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The Event Emitter proxy.\r\rPasses on all parameters to the `ParticleEmitter` to emit directly.", "kind": "function", "name": "emit", "since": "3.60.0", "params": [ { "type": { "names": [ "string", "Symbol" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Symbol" } ] } }, "description": "The event name.", "name": "event" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Optional argument 1.", "name": "a1" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Optional argument 2.", "name": "a2" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Optional argument 3.", "name": "a3" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Optional argument 4.", "name": "a4" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "Optional argument 5.", "name": "a5" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the event had listeners, else `false`." } ], "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#emit", "scope": "instance", "___id": "T000002R013860", "___s": true }, { "comment": "/**\r\n * Checks to see if this Particle is alive and updating.\r\n *\r\n * @method Phaser.GameObjects.Particles.Particle#isAlive\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if this Particle is alive and updating, otherwise `false`.\r\n */", "meta": { "filename": "Particle.js", "lineno": 387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Checks to see if this Particle is alive and updating.", "kind": "function", "name": "isAlive", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R013862", "___s": true }, { "comment": "/**\r\n * Kills this particle. This sets the `lifeCurrent` value to 0, which forces\r\n * the Particle to be removed the next time its parent Emitter runs an update.\r\n *\r\n * @method Phaser.GameObjects.Particles.Particle#kill\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 400, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Kills this particle. This sets the `lifeCurrent` value to 0, which forces\rthe Particle to be removed the next time its parent Emitter runs an update.", "kind": "function", "name": "kill", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#kill", "scope": "instance", "___id": "T000002R013864", "___s": true }, { "comment": "/**\r\n * Sets the position of this particle to the given x/y coordinates.\r\n *\r\n * If the parameters are left undefined, it resets the particle back to (0, 0).\r\n *\r\n * @method Phaser.GameObjects.Particles.Particle#setPosition\r\n * @since 3.60.0\r\n *\r\n * @param {number} [x=0] - The x coordinate to set this Particle to.\r\n * @param {number} [y=0] - The y coordinate to set this Particle to.\r\n */", "meta": { "filename": "Particle.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sets the position of this particle to the given x/y coordinates.\r\rIf the parameters are left undefined, it resets the particle back to (0, 0).", "kind": "function", "name": "setPosition", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate to set this Particle to.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate to set this Particle to.", "name": "y" } ], "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#setPosition", "scope": "instance", "___id": "T000002R013867", "___s": true }, { "comment": "/**\r\n * Starts this Particle from the given coordinates.\r\n *\r\n * @method Phaser.GameObjects.Particles.Particle#fire\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x] - The x coordinate to launch this Particle from.\r\n * @param {number} [y] - The y coordinate to launch this Particle from.\r\n *\r\n * @return {boolean} `true` if the Particle is alive, or `false` if it was spawned inside a DeathZone.\r\n */", "meta": { "filename": "Particle.js", "lineno": 432, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Starts this Particle from the given coordinates.", "kind": "function", "name": "fire", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x coordinate to launch this Particle from.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y coordinate to launch this Particle from.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Particle is alive, or `false` if it was spawned inside a DeathZone." } ], "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#fire", "scope": "instance", "___id": "T000002R013873", "___s": true }, { "comment": "/**\r\n * The main update method for this Particle.\r\n *\r\n * Updates its life values, computes the velocity and repositions the Particle.\r\n *\r\n * @method Phaser.GameObjects.Particles.Particle#update\r\n * @since 3.0.0\r\n *\r\n * @param {number} delta - The delta time in ms.\r\n * @param {number} step - The delta value divided by 1000.\r\n * @param {Phaser.GameObjects.Particles.ParticleProcessor[]} processors - An array of all active Particle Processors.\r\n *\r\n * @return {boolean} Returns `true` if this Particle has now expired and should be removed, otherwise `false` if still active.\r\n */", "meta": { "filename": "Particle.js", "lineno": 570, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The main update method for this Particle.\r\rUpdates its life values, computes the velocity and repositions the Particle.", "kind": "function", "name": "update", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time in ms.", "name": "delta" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value divided by 1000.", "name": "step" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Particles.ParticleProcessor", "type": "NameExpression" } ] } }, "description": "An array of all active Particle Processors.", "name": "processors" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R013916", "___s": true }, { "comment": "/**\r\n * An internal method that calculates the velocity of the Particle and\r\n * its world position. It also runs it against any active Processors\r\n * that are set on the Emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.Particle#computeVelocity\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.ParticleEmitter} emitter - The Emitter that is updating this Particle.\r\n * @param {number} delta - The delta time in ms.\r\n * @param {number} step - The delta value divided by 1000.\r\n * @param {Phaser.GameObjects.Particles.ParticleProcessor[]} processors - An array of all active Particle Processors.\r\n * @param {number} t - The current normalized lifetime of the particle, between 0 (birth) and 1 (death).\r\n */", "meta": { "filename": "Particle.js", "lineno": 675, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An internal method that calculates the velocity of the Particle and\rits world position. It also runs it against any active Processors\rthat are set on the Emitter.", "kind": "function", "name": "computeVelocity", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleEmitter" } }, "description": "The Emitter that is updating this Particle.", "name": "emitter" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time in ms.", "name": "delta" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value divided by 1000.", "name": "step" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Particles.ParticleProcessor", "type": "NameExpression" } ] } }, "description": "An array of all active Particle Processors.", "name": "processors" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current normalized lifetime of the particle, between 0 (birth) and 1 (death).", "name": "t" } ], "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#computeVelocity", "scope": "instance", "___id": "T000002R013941", "___s": true }, { "comment": "/**\r\n * This is a NOOP method and does nothing when called.\r\n *\r\n * @method Phaser.GameObjects.Particles.Particle#setSizeToFrame\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 731, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "This is a NOOP method and does nothing when called.", "kind": "function", "name": "setSizeToFrame", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#setSizeToFrame", "scope": "instance", "___id": "T000002R013961", "___s": true }, { "comment": "/**\r\n * Gets the bounds of this particle as a Geometry Rectangle, factoring in any\r\n * transforms of the parent emitter and anything else above it in the display list.\r\n *\r\n * Once calculated the bounds can be accessed via the `Particle.bounds` property.\r\n *\r\n * @method Phaser.GameObjects.Particles.Particle#getBounds\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [matrix] - Optional transform matrix to apply to this particle.\r\n *\r\n * @return {Phaser.Geom.Rectangle} A Rectangle containing the transformed bounds of this particle.\r\n */", "meta": { "filename": "Particle.js", "lineno": 742, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Gets the bounds of this particle as a Geometry Rectangle, factoring in any\rtransforms of the parent emitter and anything else above it in the display list.\r\rOnce calculated the bounds can be accessed via the `Particle.bounds` property.", "kind": "function", "name": "getBounds", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "Optional transform matrix to apply to this particle.", "name": "matrix" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "A Rectangle containing the transformed bounds of this particle." } ], "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#getBounds", "scope": "instance", "___id": "T000002R013963", "___s": true }, { "comment": "/**\r\n * Destroys this Particle by nulling its references to the emitter, texture, frame,\r\n * and scene. If this Particle has an AnimationState, it is also destroyed. After\r\n * calling this method the Particle should not be used again.\r\n *\r\n * @method Phaser.GameObjects.Particles.Particle#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Particle.js", "lineno": 796, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Destroys this Particle by nulling its references to the emitter, texture, frame,\rand scene. If this Particle has an AnimationState, it is also destroyed. After\rcalling this method the Particle should not be used again.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.Particle", "longname": "Phaser.GameObjects.Particles.Particle#destroy", "scope": "instance", "___id": "T000002R013982", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Particle Bounds Processor.\r\n *\r\n * Defines a rectangular region, in world space, within which particle movement\r\n * is restrained.\r\n *\r\n * Use the properties `collideLeft`, `collideRight`, `collideTop` and\r\n * `collideBottom` to control if a particle will rebound off the sides\r\n * of this boundary, or not.\r\n *\r\n * This happens when the particles worldPosition x/y coordinate hits the boundary.\r\n *\r\n * The strength of the rebound is determined by the `Particle.bounce` property.\r\n *\r\n * @class ParticleBounds\r\n * @extends Phaser.GameObjects.Particles.ParticleProcessor\r\n * @memberof Phaser.GameObjects.Particles\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The x position (top-left) of the bounds, in world space.\r\n * @param {number} y - The y position (top-left) of the bounds, in world space.\r\n * @param {number} width - The width of the bounds.\r\n * @param {number} height - The height of the bounds.\r\n * @param {boolean} [collideLeft=true] - Whether particles interact with the left edge of the bounds.\r\n * @param {boolean} [collideRight=true] - Whether particles interact with the right edge of the bounds.\r\n * @param {boolean} [collideTop=true] - Whether particles interact with the top edge of the bounds.\r\n * @param {boolean} [collideBottom=true] - Whether particles interact with the bottom edge of the bounds.\r\n */", "meta": { "filename": "ParticleBounds.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "classdesc": "The Particle Bounds Processor.\r\rDefines a rectangular region, in world space, within which particle movement\ris restrained.\r\rUse the properties `collideLeft`, `collideRight`, `collideTop` and\r`collideBottom` to control if a particle will rebound off the sides\rof this boundary, or not.\r\rThis happens when the particles worldPosition x/y coordinate hits the boundary.\r\rThe strength of the rebound is determined by the `Particle.bounce` property.", "kind": "class", "name": "ParticleBounds", "augments": [ "Phaser.GameObjects.Particles.ParticleProcessor" ], "memberof": "Phaser.GameObjects.Particles", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position (top-left) of the bounds, in world space.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position (top-left) of the bounds, in world space.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the bounds.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the bounds.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether particles interact with the left edge of the bounds.", "name": "collideLeft" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether particles interact with the right edge of the bounds.", "name": "collideRight" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether particles interact with the top edge of the bounds.", "name": "collideTop" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether particles interact with the bottom edge of the bounds.", "name": "collideBottom" } ], "scope": "static", "longname": "Phaser.GameObjects.Particles.ParticleBounds", "___id": "T000002R013993", "___s": true }, { "comment": "/**\r\n * A rectangular boundary constraining particle movement. Use the ParticleBounds properties `collideLeft`,\r\n * `collideRight`, `collideTop` and `collideBottom` to control if a particle will rebound off\r\n * the sides of this boundary, or not. This happens when the particles x/y coordinate hits\r\n * the boundary.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleBounds#bounds\r\n * @type {Phaser.Geom.Rectangle}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleBounds.js", "lineno": 56, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "A rectangular boundary constraining particle movement. Use the ParticleBounds properties `collideLeft`,\r`collideRight`, `collideTop` and `collideBottom` to control if a particle will rebound off\rthe sides of this boundary, or not. This happens when the particles x/y coordinate hits\rthe boundary.", "name": "bounds", "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleBounds", "longname": "Phaser.GameObjects.Particles.ParticleBounds#bounds", "scope": "instance", "kind": "member", "___id": "T000002R014001", "___s": true }, { "comment": "/**\r\n * Whether particles interact with the left edge of the {@link Phaser.GameObjects.Particles.ParticleBounds#bounds}.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleBounds#collideLeft\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleBounds.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Whether particles interact with the left edge of the {@link Phaser.GameObjects.Particles.ParticleBounds#bounds}.", "name": "collideLeft", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleBounds", "longname": "Phaser.GameObjects.Particles.ParticleBounds#collideLeft", "scope": "instance", "kind": "member", "___id": "T000002R014003", "___s": true }, { "comment": "/**\r\n * Whether particles interact with the right edge of the emitter {@link Phaser.GameObjects.Particles.ParticleBounds#bounds}.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleBounds#collideRight\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleBounds.js", "lineno": 78, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Whether particles interact with the right edge of the emitter {@link Phaser.GameObjects.Particles.ParticleBounds#bounds}.", "name": "collideRight", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleBounds", "longname": "Phaser.GameObjects.Particles.ParticleBounds#collideRight", "scope": "instance", "kind": "member", "___id": "T000002R014005", "___s": true }, { "comment": "/**\r\n * Whether particles interact with the top edge of the emitter {@link Phaser.GameObjects.Particles.ParticleBounds#bounds}.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleBounds#collideTop\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleBounds.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Whether particles interact with the top edge of the emitter {@link Phaser.GameObjects.Particles.ParticleBounds#bounds}.", "name": "collideTop", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleBounds", "longname": "Phaser.GameObjects.Particles.ParticleBounds#collideTop", "scope": "instance", "kind": "member", "___id": "T000002R014007", "___s": true }, { "comment": "/**\r\n * Whether particles interact with the bottom edge of the emitter {@link Phaser.GameObjects.Particles.ParticleBounds#bounds}.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleBounds#collideBottom\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleBounds.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Whether particles interact with the bottom edge of the emitter {@link Phaser.GameObjects.Particles.ParticleBounds#bounds}.", "name": "collideBottom", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleBounds", "longname": "Phaser.GameObjects.Particles.ParticleBounds#collideBottom", "scope": "instance", "kind": "member", "___id": "T000002R014009", "___s": true }, { "comment": "/**\r\n * Checks the given Particle against the boundary rectangle. If the particle's world position\r\n * crosses an active edge, its position is clamped back inside the boundary and its velocity\r\n * along that axis is negated and scaled by the particle's `bounce` value, causing it to rebound.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleBounds#update\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The Particle to update.\r\n */", "meta": { "filename": "ParticleBounds.js", "lineno": 109, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Checks the given Particle against the boundary rectangle. If the particle's world position\rcrosses an active edge, its position is clamped back inside the boundary and its velocity\ralong that axis is negated and scaled by the particle's `bounce` value, causing it to rebound.", "kind": "function", "name": "update", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The Particle to update.", "name": "particle" } ], "memberof": "Phaser.GameObjects.Particles.ParticleBounds", "longname": "Phaser.GameObjects.Particles.ParticleBounds#update", "scope": "instance", "overrides": "Phaser.GameObjects.Particles.ParticleProcessor#update", "___id": "T000002R014011", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Particle Emitter is a special kind of Game Object that controls a pool of {@link Phaser.GameObjects.Particles.Particle Particles}.\r\n *\r\n * Particle Emitters are created via a configuration object. The properties of this object\r\n * can be specified in a variety of formats, giving you plenty of scope over the values they\r\n * return, leading to complex visual effects. Here are the different forms of configuration\r\n * value you can give:\r\n *\r\n * ## An explicit static value:\r\n *\r\n * ```js\r\n * x: 400\r\n * ```\r\n *\r\n * The x value will always be 400 when the particle is spawned.\r\n *\r\n * ## A random value:\r\n *\r\n * ```js\r\n * x: [ 100, 200, 300, 400 ]\r\n * ```\r\n *\r\n * The x value will be one of the 4 elements in the given array, picked at random on emission.\r\n *\r\n * ## A custom callback:\r\n *\r\n * ```js\r\n * x: (particle, key, t, value) => {\r\n * return value + 50;\r\n * }\r\n * ```\r\n *\r\n * The x value is the result of calling this function. This is only used when the\r\n * particle is emitted, so it provides its initial starting value. It is not used\r\n * when the particle is updated (see the onUpdate callback for that)\r\n *\r\n * ## A start / end object:\r\n *\r\n * This allows you to control the change in value between the given start and\r\n * end parameters over the course of the particles lifetime:\r\n *\r\n * ```js\r\n * scale: { start: 0, end: 1 }\r\n * ```\r\n *\r\n * The particle scale will start at 0 when emitted and ease to a scale of 1\r\n * over the course of its lifetime. You can also specify the ease function\r\n * used for this change (the default is Linear):\r\n *\r\n * ```js\r\n * scale: { start: 0, end: 1, ease: 'bounce.out' }\r\n * ```\r\n *\r\n * ## A start / end random object:\r\n *\r\n * The start and end object can have an optional `random` parameter.\r\n * This forces it to pick a random value between the two values and use\r\n * this as the starting value, then easing to the 'end' parameter over\r\n * its lifetime.\r\n *\r\n * ```js\r\n * scale: { start: 4, end: 0.5, random: true }\r\n * ```\r\n *\r\n * The particle will start with a random scale between 0.5 and 4 and then\r\n * scale to the end value over its lifetime. You can combine the above\r\n * with the `ease` parameter as well to control the value easing.\r\n *\r\n * ## An interpolation object:\r\n *\r\n * You can provide an array of values which will be used for interpolation\r\n * during the particles lifetime. You can also define the interpolation\r\n * function to be used. There are three provided: `linear` (the default),\r\n * `bezier` and `catmull`, or you can provide your own function.\r\n *\r\n * ```js\r\n * x: { values: [ 50, 500, 200, 800 ], interpolation: 'catmull' }\r\n * ```\r\n *\r\n * The particle scale will interpolate from 50 when emitted to 800 via the other\r\n * points over the course of its lifetime. You can also specify an ease function\r\n * used to control the rate of change through the values (the default is Linear):\r\n *\r\n * ```js\r\n * x: { values: [ 50, 500, 200, 800 ], interpolation: 'catmull', ease: 'bounce.out }\r\n * ```\r\n *\r\n * ## A stepped emitter object:\r\n *\r\n * The `steps` parameter allows you to control the placement of sequential\r\n * particles across the start-end range:\r\n *\r\n * ```js\r\n * x: { steps: 32, start: 0, end: 576 }\r\n * ```\r\n *\r\n * Here we have a range of 576 (start to end). This is divided into 32 steps.\r\n *\r\n * The first particle will emit at the x position of 0. The next will emit\r\n * at the next 'step' along, which would be 18. The following particle will emit\r\n * at the next step, which is 36, and so on. Because the range of 576 has been\r\n * divided by 32, creating 18 pixels steps. When a particle reaches the 'end'\r\n * value the next one will start from the beginning again.\r\n *\r\n * ## A stepped emitter object with yoyo:\r\n *\r\n * You can add the optional `yoyo` property to a stepped object:\r\n *\r\n * ```js\r\n * x: { steps: 32, start: 0, end: 576, yoyo: true }\r\n * ```\r\n *\r\n * As with the stepped emitter, particles are emitted in sequence, from 'start'\r\n * to 'end' in step sized jumps. Normally, when a stepped emitter reaches the\r\n * end it snaps around to the start value again. However, if you provide the 'yoyo'\r\n * parameter then when it reaches the end it will reverse direction and start\r\n * emitting back down to 'start' again. Depending on the effect you require this\r\n * can often look better.\r\n *\r\n * ## A min / max object:\r\n *\r\n * This allows you to pick a random float value between the min and max properties:\r\n *\r\n * ```js\r\n * x: { min: 100, max: 700 }\r\n * ```\r\n *\r\n * The x value will be a random float between min and max.\r\n *\r\n * You can force it select an integer by setting the 'int' flag:\r\n *\r\n * ```js\r\n * x: { min: 100, max: 700, int: true }\r\n * ```\r\n *\r\n * Or, you could use the 'random' array approach (see below)\r\n *\r\n * ## A random object:\r\n *\r\n * This allows you to pick a random integer value between the first and second array elements:\r\n *\r\n * ```js\r\n * x: { random: [ 100, 700 ] }\r\n * ```\r\n *\r\n * The x value will be a random integer between 100 and 700 as it takes the first\r\n * element in the 'random' array as the 'min' value and the 2nd element as the 'max' value.\r\n *\r\n * ## Custom onEmit and onUpdate callbacks:\r\n *\r\n * If the above won't give you the effect you're after, you can provide your own\r\n * callbacks that will be used when the particle is both emitted and updated:\r\n *\r\n * ```js\r\n * x: {\r\n * onEmit: (particle, key, t, value) => {\r\n * return value;\r\n * },\r\n * onUpdate: (particle, key, t, value) => {\r\n * return value;\r\n * }\r\n * }\r\n * ```\r\n *\r\n * You can provide either one or both functions. The `onEmit` is called at the\r\n * start of the particles life and defines the value of the property on birth.\r\n *\r\n * The `onUpdate` function is called every time the Particle Emitter updates\r\n * until the particle dies. Both must return a value.\r\n *\r\n * The properties are:\r\n *\r\n * particle - A reference to the Particle instance.\r\n * key - The string based key of the property, i.e. 'x' or 'lifespan'.\r\n * t - The current normalized lifetime of the particle, between 0 (birth) and 1 (death).\r\n * value - The current property value. At a minimum you should return this.\r\n *\r\n * By using the above configuration options you have an unlimited amount of\r\n * control over how your particles behave.\r\n *\r\n * ## v3.60 Differences\r\n *\r\n * Prior to v3.60 Phaser used a `ParticleEmitterManager`. This was removed in v3.60\r\n * and now calling `this.add.particles` returns a `ParticleEmitter` instance instead.\r\n *\r\n * In order to streamline memory and the display list we have removed the\r\n * `ParticleEmitterManager` entirely. When you call `this.add.particles` you're now\r\n * creating a `ParticleEmitter` instance, which is being added directly to the\r\n * display list and can be manipulated just like any other Game Object, i.e.\r\n * scaled, rotated, positioned, added to a Container, etc. It now extends the\r\n * `GameObject` base class, meaning it's also an event emitter, which allowed us\r\n * to create some handy new events for particles.\r\n *\r\n * So, to create an emitter, you now give it an xy coordinate, a texture and an\r\n * emitter configuration object (you can also set this later, but most commonly\r\n * you'd do it on creation). I.e.:\r\n *\r\n * ```js\r\n * const emitter = this.add.particles(100, 300, 'flares', {\r\n * frame: 'red',\r\n * angle: { min: -30, max: 30 },\r\n * speed: 150\r\n * });\r\n * ```\r\n *\r\n * This will create a 'red flare' emitter at 100 x 300.\r\n *\r\n * Please update your code to ensure it adheres to the new function signatures.\r\n *\r\n * @class ParticleEmitter\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects.Particles\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @extends Phaser.GameObjects.Components.AlphaSingle\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Lighting\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Texture\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y] - The vertical position of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {Phaser.Types.GameObjects.Particles.ParticleEmitterConfig} [config] - Settings for this emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 107, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "classdesc": "A Particle Emitter is a special kind of Game Object that controls a pool of {@link Phaser.GameObjects.Particles.Particle Particles}.\r\rParticle Emitters are created via a configuration object. The properties of this object\rcan be specified in a variety of formats, giving you plenty of scope over the values they\rreturn, leading to complex visual effects. Here are the different forms of configuration\rvalue you can give:\r\r## An explicit static value:\r\r```js\rx: 400\r```\r\rThe x value will always be 400 when the particle is spawned.\r\r## A random value:\r\r```js\rx: [ 100, 200, 300, 400 ]\r```\r\rThe x value will be one of the 4 elements in the given array, picked at random on emission.\r\r## A custom callback:\r\r```js\rx: (particle, key, t, value) => {\r return value + 50;\r}\r```\r\rThe x value is the result of calling this function. This is only used when the\rparticle is emitted, so it provides its initial starting value. It is not used\rwhen the particle is updated (see the onUpdate callback for that)\r\r## A start / end object:\r\rThis allows you to control the change in value between the given start and\rend parameters over the course of the particles lifetime:\r\r```js\rscale: { start: 0, end: 1 }\r```\r\rThe particle scale will start at 0 when emitted and ease to a scale of 1\rover the course of its lifetime. You can also specify the ease function\rused for this change (the default is Linear):\r\r```js\rscale: { start: 0, end: 1, ease: 'bounce.out' }\r```\r\r## A start / end random object:\r\rThe start and end object can have an optional `random` parameter.\rThis forces it to pick a random value between the two values and use\rthis as the starting value, then easing to the 'end' parameter over\rits lifetime.\r\r```js\rscale: { start: 4, end: 0.5, random: true }\r```\r\rThe particle will start with a random scale between 0.5 and 4 and then\rscale to the end value over its lifetime. You can combine the above\rwith the `ease` parameter as well to control the value easing.\r\r## An interpolation object:\r\rYou can provide an array of values which will be used for interpolation\rduring the particles lifetime. You can also define the interpolation\rfunction to be used. There are three provided: `linear` (the default),\r`bezier` and `catmull`, or you can provide your own function.\r\r```js\rx: { values: [ 50, 500, 200, 800 ], interpolation: 'catmull' }\r```\r\rThe particle scale will interpolate from 50 when emitted to 800 via the other\rpoints over the course of its lifetime. You can also specify an ease function\rused to control the rate of change through the values (the default is Linear):\r\r```js\rx: { values: [ 50, 500, 200, 800 ], interpolation: 'catmull', ease: 'bounce.out }\r```\r\r## A stepped emitter object:\r\rThe `steps` parameter allows you to control the placement of sequential\rparticles across the start-end range:\r\r```js\rx: { steps: 32, start: 0, end: 576 }\r```\r\rHere we have a range of 576 (start to end). This is divided into 32 steps.\r\rThe first particle will emit at the x position of 0. The next will emit\rat the next 'step' along, which would be 18. The following particle will emit\rat the next step, which is 36, and so on. Because the range of 576 has been\rdivided by 32, creating 18 pixels steps. When a particle reaches the 'end'\rvalue the next one will start from the beginning again.\r\r## A stepped emitter object with yoyo:\r\rYou can add the optional `yoyo` property to a stepped object:\r\r```js\rx: { steps: 32, start: 0, end: 576, yoyo: true }\r```\r\rAs with the stepped emitter, particles are emitted in sequence, from 'start'\rto 'end' in step sized jumps. Normally, when a stepped emitter reaches the\rend it snaps around to the start value again. However, if you provide the 'yoyo'\rparameter then when it reaches the end it will reverse direction and start\remitting back down to 'start' again. Depending on the effect you require this\rcan often look better.\r\r## A min / max object:\r\rThis allows you to pick a random float value between the min and max properties:\r\r```js\rx: { min: 100, max: 700 }\r```\r\rThe x value will be a random float between min and max.\r\rYou can force it select an integer by setting the 'int' flag:\r\r```js\rx: { min: 100, max: 700, int: true }\r```\r\rOr, you could use the 'random' array approach (see below)\r\r## A random object:\r\rThis allows you to pick a random integer value between the first and second array elements:\r\r```js\rx: { random: [ 100, 700 ] }\r```\r\rThe x value will be a random integer between 100 and 700 as it takes the first\relement in the 'random' array as the 'min' value and the 2nd element as the 'max' value.\r\r## Custom onEmit and onUpdate callbacks:\r\rIf the above won't give you the effect you're after, you can provide your own\rcallbacks that will be used when the particle is both emitted and updated:\r\r```js\rx: {\r onEmit: (particle, key, t, value) => {\r return value;\r },\r onUpdate: (particle, key, t, value) => {\r return value;\r }\r}\r```\r\rYou can provide either one or both functions. The `onEmit` is called at the\rstart of the particles life and defines the value of the property on birth.\r\rThe `onUpdate` function is called every time the Particle Emitter updates\runtil the particle dies. Both must return a value.\r\rThe properties are:\r\rparticle - A reference to the Particle instance.\rkey - The string based key of the property, i.e. 'x' or 'lifespan'.\rt - The current normalized lifetime of the particle, between 0 (birth) and 1 (death).\rvalue - The current property value. At a minimum you should return this.\r\rBy using the above configuration options you have an unlimited amount of\rcontrol over how your particles behave.\r\r## v3.60 Differences\r\rPrior to v3.60 Phaser used a `ParticleEmitterManager`. This was removed in v3.60\rand now calling `this.add.particles` returns a `ParticleEmitter` instance instead.\r\rIn order to streamline memory and the display list we have removed the\r`ParticleEmitterManager` entirely. When you call `this.add.particles` you're now\rcreating a `ParticleEmitter` instance, which is being added directly to the\rdisplay list and can be manipulated just like any other Game Object, i.e.\rscaled, rotated, positioned, added to a Container, etc. It now extends the\r`GameObject` base class, meaning it's also an event emitter, which allowed us\rto create some handy new events for particles.\r\rSo, to create an emitter, you now give it an xy coordinate, a texture and an\remitter configuration object (you can also set this later, but most commonly\ryou'd do it on creation). I.e.:\r\r```js\rconst emitter = this.add.particles(100, 300, 'flares', {\r frame: 'red',\r angle: { min: -30, max: 30 },\r speed: 150\r});\r```\r\rThis will create a 'red flare' emitter at 100 x 300.\r\rPlease update your code to ensure it adheres to the new function signatures.", "kind": "class", "name": "ParticleEmitter", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.AlphaSingle", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.Lighting", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.RenderNodes", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Texture", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.GameObjects.Particles", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig" } }, "optional": true, "description": "Settings for this emitter.", "name": "config" } ], "scope": "static", "longname": "Phaser.GameObjects.Particles.ParticleEmitter", "___id": "T000002R014060", "___s": true }, { "comment": "/**\r\n * The Particle Class which will be emitted by this Emitter.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#particleClass\r\n * @type {function}\r\n * @default Phaser.GameObjects.Particles.Particle\r\n * @since 3.0.0\r\n * @see Phaser.Types.GameObjects.Particles.ParticleClassConstructor\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 364, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The Particle Class which will be emitted by this Emitter.", "name": "particleClass", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "defaultvalue": "Phaser.GameObjects.Particles.Particle", "since": "3.0.0", "see": [ "Phaser.Types.GameObjects.Particles.ParticleClassConstructor" ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#particleClass", "scope": "instance", "kind": "member", "___id": "T000002R014065", "___s": true }, { "comment": "/**\r\n * An internal object holding the configuration for the Emitter.\r\n *\r\n * These are populated as part of the Emitter configuration parsing.\r\n *\r\n * You typically do not access them directly, but instead use the\r\n * `ParticleEmitter.setConfig` or `ParticleEmitter.updateConfig` methods.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#config\r\n * @type {Phaser.Types.GameObjects.Particles.ParticleEmitterConfig}\r\n * @since 3.85.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 375, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An internal object holding the configuration for the Emitter.\r\rThese are populated as part of the Emitter configuration parsing.\r\rYou typically do not access them directly, but instead use the\r`ParticleEmitter.setConfig` or `ParticleEmitter.updateConfig` methods.", "name": "config", "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig" } }, "since": "3.85.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#config", "scope": "instance", "kind": "member", "___id": "T000002R014067", "___s": true }, { "comment": "/**\r\n * An internal object holding all of the EmitterOp instances.\r\n *\r\n * These are populated as part of the Emitter configuration parsing.\r\n *\r\n * You typically do not access them directly, but instead use the\r\n * provided getters and setters on this class, such as `ParticleEmitter.speedX` etc.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#ops\r\n * @type {Phaser.Types.GameObjects.Particles.ParticleEmitterOps}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 389, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An internal object holding all of the EmitterOp instances.\r\rThese are populated as part of the Emitter configuration parsing.\r\rYou typically do not access them directly, but instead use the\rprovided getters and setters on this class, such as `ParticleEmitter.speedX` etc.", "name": "ops", "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleEmitterOps" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterOps" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#ops", "scope": "instance", "kind": "member", "___id": "T000002R014069", "___s": true }, { "comment": "/**\r\n * A radial emitter will emit particles in all directions between angle min and max,\r\n * using {@link Phaser.GameObjects.Particles.ParticleEmitter#speed} as the value. If set to false then this acts as a point Emitter.\r\n * A point emitter will emit particles only in the direction derived from the speedX and speedY values.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#radial\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setRadial\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 426, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "A radial emitter will emit particles in all directions between angle min and max,\rusing {@link Phaser.GameObjects.Particles.ParticleEmitter#speed} as the value. If set to false then this acts as a point Emitter.\rA point emitter will emit particles only in the direction derived from the speedX and speedY values.", "name": "radial", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014095", "___s": true }, { "comment": "/**\r\n * Horizontal acceleration applied to emitted particles, in pixels per second squared.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#gravityX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setGravity\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 439, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Horizontal acceleration applied to emitted particles, in pixels per second squared.", "name": "gravityX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014097", "___s": true }, { "comment": "/**\r\n * Vertical acceleration applied to emitted particles, in pixels per second squared.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#gravityY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setGravity\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 450, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Vertical acceleration applied to emitted particles, in pixels per second squared.", "name": "gravityY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014099", "___s": true }, { "comment": "/**\r\n * Whether accelerationX and accelerationY are non-zero. Set automatically during configuration.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#acceleration\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 461, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Whether accelerationX and accelerationY are non-zero. Set automatically during configuration.", "name": "acceleration", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#acceleration", "scope": "instance", "kind": "member", "___id": "T000002R014101", "___s": true }, { "comment": "/**\r\n * Whether moveToX and moveToY are set. Set automatically during configuration.\r\n *\r\n * When true the particles move toward the moveToX and moveToY coordinates and arrive at the end of their life.\r\n * Emitter angle, speedX, and speedY are ignored.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#moveTo\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 471, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Whether moveToX and moveToY are set. Set automatically during configuration.\r\rWhen true the particles move toward the moveToX and moveToY coordinates and arrive at the end of their life.\rEmitter angle, speedX, and speedY are ignored.", "name": "moveTo", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#moveTo", "scope": "instance", "kind": "member", "___id": "T000002R014103", "___s": true }, { "comment": "/**\r\n * A function to call when a particle is emitted.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#emitCallback\r\n * @type {?Phaser.Types.GameObjects.Particles.ParticleEmitterCallback}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 484, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "A function to call when a particle is emitted.", "name": "emitCallback", "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleEmitterCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterCallback", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#emitCallback", "scope": "instance", "kind": "member", "___id": "T000002R014105", "___s": true }, { "comment": "/**\r\n * The calling context for {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallback}.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope\r\n * @type {?*}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 494, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The calling context for {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallback}.", "name": "emitCallbackScope", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope", "scope": "instance", "kind": "member", "___id": "T000002R014107", "___s": true }, { "comment": "/**\r\n * A function to call when a particle dies.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#deathCallback\r\n * @type {?Phaser.Types.GameObjects.Particles.ParticleDeathCallback}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 504, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "A function to call when a particle dies.", "name": "deathCallback", "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDeathCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDeathCallback", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#deathCallback", "scope": "instance", "kind": "member", "___id": "T000002R014109", "___s": true }, { "comment": "/**\r\n * The calling context for {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallback}.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope\r\n * @type {?*}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 514, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The calling context for {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallback}.", "name": "deathCallbackScope", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope", "scope": "instance", "kind": "member", "___id": "T000002R014111", "___s": true }, { "comment": "/**\r\n * Set to hard limit the amount of particle objects this emitter is allowed to create\r\n * in total. This is the number of `Particle` instances it can create, not the number\r\n * of 'alive' particles.\r\n *\r\n * 0 means unlimited.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#maxParticles\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 524, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Set to hard limit the amount of particle objects this emitter is allowed to create\rin total. This is the number of `Particle` instances it can create, not the number\rof 'alive' particles.\r\r0 means unlimited.", "name": "maxParticles", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#maxParticles", "scope": "instance", "kind": "member", "___id": "T000002R014113", "___s": true }, { "comment": "/**\r\n * The maximum number of alive and rendering particles this emitter will update.\r\n * When this limit is reached, a particle needs to die before another can be emitted.\r\n *\r\n * 0 means no limits.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#maxAliveParticles\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 538, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The maximum number of alive and rendering particles this emitter will update.\rWhen this limit is reached, a particle needs to die before another can be emitted.\r\r0 means no limits.", "name": "maxAliveParticles", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#maxAliveParticles", "scope": "instance", "kind": "member", "___id": "T000002R014115", "___s": true }, { "comment": "/**\r\n * If set, either via the Emitter config, or by directly setting this property,\r\n * the Particle Emitter will stop emitting particles once this total has been\r\n * reached. It will then enter a 'stopped' state, firing the `STOP`\r\n * event. Note that entering a stopped state doesn't mean all the particles\r\n * have finished, just that it's not emitting any further ones.\r\n *\r\n * To know when the final particle expires, listen for the COMPLETE event.\r\n *\r\n * Use this if you wish to launch an exact number of particles and then stop\r\n * your emitter afterwards.\r\n *\r\n * The counter is reset each time the `ParticleEmitter.start` method is called.\r\n *\r\n * 0 means the emitter will not stop based on total emitted particles.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#stopAfter\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 551, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "If set, either via the Emitter config, or by directly setting this property,\rthe Particle Emitter will stop emitting particles once this total has been\rreached. It will then enter a 'stopped' state, firing the `STOP`\revent. Note that entering a stopped state doesn't mean all the particles\rhave finished, just that it's not emitting any further ones.\r\rTo know when the final particle expires, listen for the COMPLETE event.\r\rUse this if you wish to launch an exact number of particles and then stop\ryour emitter afterwards.\r\rThe counter is reset each time the `ParticleEmitter.start` method is called.\r\r0 means the emitter will not stop based on total emitted particles.", "name": "stopAfter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#stopAfter", "scope": "instance", "kind": "member", "___id": "T000002R014117", "___s": true }, { "comment": "/**\r\n * The number of milliseconds this emitter will emit particles for when in flow mode,\r\n * before it stops emission. A value of 0 (the default) means there is no duration.\r\n *\r\n * When the duration expires the `STOP` event is emitted. Note that entering a\r\n * stopped state doesn't mean all the particles have finished, just that it's\r\n * not emitting any further ones.\r\n *\r\n * To know when the final particle expires, listen for the COMPLETE event.\r\n *\r\n * The counter is reset each time the `ParticleEmitter.start` method is called.\r\n *\r\n * 0 means the emitter will not stop based on duration.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#duration\r\n * @type {number}\r\n * @default 0\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 574, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The number of milliseconds this emitter will emit particles for when in flow mode,\rbefore it stops emission. A value of 0 (the default) means there is no duration.\r\rWhen the duration expires the `STOP` event is emitted. Note that entering a\rstopped state doesn't mean all the particles have finished, just that it's\rnot emitting any further ones.\r\rTo know when the final particle expires, listen for the COMPLETE event.\r\rThe counter is reset each time the `ParticleEmitter.start` method is called.\r\r0 means the emitter will not stop based on duration.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#duration", "scope": "instance", "kind": "member", "___id": "T000002R014119", "___s": true }, { "comment": "/**\r\n * For a flow emitter, the time interval (>= 0) between particle flow cycles in ms.\r\n * A value of 0 means there is one particle flow cycle for each logic update (the maximum flow frequency). This is the default setting.\r\n * For an exploding emitter, this value will be -1.\r\n * Calling {@link Phaser.GameObjects.Particles.ParticleEmitter#flow} also puts the emitter in flow mode (frequency >= 0).\r\n * Calling {@link Phaser.GameObjects.Particles.ParticleEmitter#explode} also puts the emitter in explode mode (frequency = -1).\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#frequency\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setFrequency\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 595, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "For a flow emitter, the time interval (>= 0) between particle flow cycles in ms.\rA value of 0 means there is one particle flow cycle for each logic update (the maximum flow frequency). This is the default setting.\rFor an exploding emitter, this value will be -1.\rCalling {@link Phaser.GameObjects.Particles.ParticleEmitter#flow} also puts the emitter in flow mode (frequency >= 0).\rCalling {@link Phaser.GameObjects.Particles.ParticleEmitter#explode} also puts the emitter in explode mode (frequency = -1).", "name": "frequency", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014121", "___s": true }, { "comment": "/**\r\n * Controls if the emitter is currently emitting a particle flow (when frequency >= 0).\r\n *\r\n * Already alive particles will continue to update until they expire.\r\n *\r\n * Controlled by {@link Phaser.GameObjects.Particles.ParticleEmitter#start} and {@link Phaser.GameObjects.Particles.ParticleEmitter#stop}.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#emitting\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 610, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Controls if the emitter is currently emitting a particle flow (when frequency >= 0).\r\rAlready alive particles will continue to update until they expire.\r\rControlled by {@link Phaser.GameObjects.Particles.ParticleEmitter#start} and {@link Phaser.GameObjects.Particles.ParticleEmitter#stop}.", "name": "emitting", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#emitting", "scope": "instance", "kind": "member", "___id": "T000002R014123", "___s": true }, { "comment": "/**\r\n * Newly emitted particles are added to the top of the particle list, i.e. rendered above those already alive.\r\n *\r\n * Set to false to send them to the back.\r\n *\r\n * Also see the `sortOrder` property for more complex particle sorting.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#particleBringToTop\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 624, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Newly emitted particles are added to the top of the particle list, i.e. rendered above those already alive.\r\rSet to false to send them to the back.\r\rAlso see the `sortOrder` property for more complex particle sorting.", "name": "particleBringToTop", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#particleBringToTop", "scope": "instance", "kind": "member", "___id": "T000002R014125", "___s": true }, { "comment": "/**\r\n * The time rate applied to active particles, affecting lifespan, movement, and tweens. Values larger than 1 are faster than normal.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#timeScale\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 638, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#timeScale", "scope": "instance", "kind": "member", "___id": "T000002R014127", "___s": true }, { "comment": "/**\r\n * An array containing Particle Emission Zones. These can be either EdgeZones or RandomZones.\r\n *\r\n * Particles are emitted from a randomly selected zone from this array.\r\n *\r\n * Prior to Phaser v3.60 an Emitter could only have one single Emission Zone.\r\n * In 3.60 they can now have an array of Emission Zones.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#emitZones\r\n * @type {Phaser.Types.GameObjects.Particles.EmitZoneObject[]}\r\n * @since 3.60.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 648, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An array containing Particle Emission Zones. These can be either EdgeZones or RandomZones.\r\rParticles are emitted from a randomly selected zone from this array.\r\rPrior to Phaser v3.60 an Emitter could only have one single Emission Zone.\rIn 3.60 they can now have an array of Emission Zones.", "name": "emitZones", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.GameObjects.Particles.EmitZoneObject", "type": "NameExpression" } ] } }, "since": "3.60.0", "see": [ "Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone" ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#emitZones", "scope": "instance", "kind": "member", "___id": "T000002R014129", "___s": true }, { "comment": "/**\r\n * An array containing Particle Death Zone objects. A particle is immediately killed as soon as its x/y coordinates\r\n * intersect with any of the configured Death Zones.\r\n *\r\n * Prior to Phaser v3.60 an Emitter could only have one single Death Zone.\r\n * In 3.60 they can now have an array of Death Zones.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#deathZones\r\n * @type {Phaser.GameObjects.Particles.Zones.DeathZone[]}\r\n * @since 3.60.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setDeathZone\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 663, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An array containing Particle Death Zone objects. A particle is immediately killed as soon as its x/y coordinates\rintersect with any of the configured Death Zones.\r\rPrior to Phaser v3.60 an Emitter could only have one single Death Zone.\rIn 3.60 they can now have an array of Death Zones.", "name": "deathZones", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Particles.Zones.DeathZone", "type": "NameExpression" } ] } }, "since": "3.60.0", "see": [ "Phaser.GameObjects.Particles.ParticleEmitter#setDeathZone" ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#deathZones", "scope": "instance", "kind": "member", "___id": "T000002R014131", "___s": true }, { "comment": "/**\r\n * An optional Rectangle object that is used during rendering to cull Particles from\r\n * display. For example, if your particles are limited to only move within a 300x300\r\n * sized area from their origin, then you can set this Rectangle to those dimensions.\r\n *\r\n * The renderer will check to see if the `viewBounds` Rectangle intersects with the\r\n * Camera bounds during the render step and if not it will skip rendering the Emitter\r\n * entirely.\r\n *\r\n * This allows you to create many emitters in a Scene without the cost of\r\n * rendering if the contents aren't visible.\r\n *\r\n * Note that the Emitter will not perform any checks to see if the Particles themselves\r\n * are outside of these bounds, or not. It will simply check the bounds against the\r\n * camera. Use the `getBounds` method with the `advance` parameter to help define\r\n * the location and placement of the view bounds.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#viewBounds\r\n * @type {?Phaser.Geom.Rectangle}\r\n * @default null\r\n * @since 3.60.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setViewBounds\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 677, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An optional Rectangle object that is used during rendering to cull Particles from\rdisplay. For example, if your particles are limited to only move within a 300x300\rsized area from their origin, then you can set this Rectangle to those dimensions.\r\rThe renderer will check to see if the `viewBounds` Rectangle intersects with the\rCamera bounds during the render step and if not it will skip rendering the Emitter\rentirely.\r\rThis allows you to create many emitters in a Scene without the cost of\rrendering if the contents aren't visible.\r\rNote that the Emitter will not perform any checks to see if the Particles themselves\rare outside of these bounds, or not. It will simply check the bounds against the\rcamera. Use the `getBounds` method with the `advance` parameter to help define\rthe location and placement of the view bounds.", "name": "viewBounds", "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle", "nullable": true } }, "nullable": true, "defaultvalue": "null", "since": "3.60.0", "see": [ "Phaser.GameObjects.Particles.ParticleEmitter#setViewBounds" ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#viewBounds", "scope": "instance", "kind": "member", "___id": "T000002R014133", "___s": true }, { "comment": "/**\r\n * A Game Object whose position is used as the particle origin.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#follow\r\n * @type {?Phaser.Types.Math.Vector2Like}\r\n * @default null\r\n * @since 3.0.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#startFollow\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#stopFollow\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 702, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "A Game Object whose position is used as the particle origin.", "name": "follow", "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like", "nullable": true } }, "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", "___id": "T000002R014135", "___s": true }, { "comment": "/**\r\n * The offset of the particle origin from the {@link Phaser.GameObjects.Particles.ParticleEmitter#follow} target.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#followOffset\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.0.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#startFollow\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 714, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The offset of the particle origin from the {@link Phaser.GameObjects.Particles.ParticleEmitter#follow} target.", "name": "followOffset", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014137", "___s": true }, { "comment": "/**\r\n * Whether the emitter's {@link Phaser.GameObjects.Particles.ParticleEmitter#visible} state will track\r\n * the {@link Phaser.GameObjects.Particles.ParticleEmitter#follow} target's visibility state.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#trackVisible\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#startFollow\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 724, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Whether the emitter's {@link Phaser.GameObjects.Particles.ParticleEmitter#visible} state will track\rthe {@link Phaser.GameObjects.Particles.ParticleEmitter#follow} target's visibility state.", "name": "trackVisible", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014139", "___s": true }, { "comment": "/**\r\n * The texture frames assigned to particles.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#frames\r\n * @type {Phaser.Textures.Frame[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 736, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The texture frames assigned to particles.", "name": "frames", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Textures.Frame", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#frames", "scope": "instance", "kind": "member", "___id": "T000002R014141", "___s": true }, { "comment": "/**\r\n * Whether texture {@link Phaser.GameObjects.Particles.ParticleEmitter#frames} are selected at random.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#randomFrame\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setEmitterFrame\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 745, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Whether texture {@link Phaser.GameObjects.Particles.ParticleEmitter#frames} are selected at random.", "name": "randomFrame", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "see": [ "Phaser.GameObjects.Particles.ParticleEmitter#setEmitterFrame" ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#randomFrame", "scope": "instance", "kind": "member", "___id": "T000002R014143", "___s": true }, { "comment": "/**\r\n * The number of consecutive particles that receive a single texture frame (per frame cycle).\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#frameQuantity\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setEmitterFrame\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 756, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The number of consecutive particles that receive a single texture frame (per frame cycle).", "name": "frameQuantity", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "see": [ "Phaser.GameObjects.Particles.ParticleEmitter#setEmitterFrame" ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#frameQuantity", "scope": "instance", "kind": "member", "___id": "T000002R014145", "___s": true }, { "comment": "/**\r\n * The animations assigned to particles.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#anims\r\n * @type {string[]}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 767, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The animations assigned to particles.", "name": "anims", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#anims", "scope": "instance", "kind": "member", "___id": "T000002R014147", "___s": true }, { "comment": "/**\r\n * Whether animations {@link Phaser.GameObjects.Particles.ParticleEmitter#anims} are selected at random.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#randomAnim\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.60.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setAnim\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 776, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Whether animations {@link Phaser.GameObjects.Particles.ParticleEmitter#anims} are selected at random.", "name": "randomAnim", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.60.0", "see": [ "Phaser.GameObjects.Particles.ParticleEmitter#setAnim" ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#randomAnim", "scope": "instance", "kind": "member", "___id": "T000002R014149", "___s": true }, { "comment": "/**\r\n * The number of consecutive particles that receive a single animation (per frame cycle).\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#animQuantity\r\n * @type {number}\r\n * @default 1\r\n * @since 3.60.0\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setAnim\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 787, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The number of consecutive particles that receive a single animation (per frame cycle).", "name": "animQuantity", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.60.0", "see": [ "Phaser.GameObjects.Particles.ParticleEmitter#setAnim" ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#animQuantity", "scope": "instance", "kind": "member", "___id": "T000002R014151", "___s": true }, { "comment": "/**\r\n * An internal property used to tell when the emitter is in fast-forward mode.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#skipping\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 839, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An internal property used to tell when the emitter is in fast-forward mode.", "name": "skipping", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#skipping", "scope": "instance", "kind": "member", "___id": "T000002R014159", "___s": true }, { "comment": "/**\r\n * An internal Transform Matrix used to cache this emitters world matrix.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#worldMatrix\r\n * @type {Phaser.GameObjects.Components.TransformMatrix}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 849, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "An internal Transform Matrix used to cache this emitters world matrix.", "name": "worldMatrix", "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#worldMatrix", "scope": "instance", "kind": "member", "___id": "T000002R014161", "___s": true }, { "comment": "/**\r\n * Optionally sort the particles before they render based on this\r\n * property. The property must exist on the `Particle` class, such\r\n * as `y`, `lifeT`, `scaleX`, etc.\r\n *\r\n * When set this overrides the `particleBringToTop` setting.\r\n *\r\n * To reset this and disable sorting, set this property to an empty string.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#sortProperty\r\n * @type {string}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 858, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Optionally sort the particles before they render based on this\rproperty. The property must exist on the `Particle` class, such\ras `y`, `lifeT`, `scaleX`, etc.\r\rWhen set this overrides the `particleBringToTop` setting.\r\rTo reset this and disable sorting, set this property to an empty string.", "name": "sortProperty", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#sortProperty", "scope": "instance", "kind": "member", "___id": "T000002R014163", "___s": true }, { "comment": "/**\r\n * When `sortProperty` is defined this controls the sorting order,\r\n * either ascending or descending. Toggle to control the visual effect.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#sortOrderAsc\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 873, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "When `sortProperty` is defined this controls the sorting order,\reither ascending or descending. Toggle to control the visual effect.", "name": "sortOrderAsc", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#sortOrderAsc", "scope": "instance", "kind": "member", "___id": "T000002R014165", "___s": true }, { "comment": "/**\r\n * The callback used to sort the particles. Only used if `sortProperty`\r\n * has been set. Set this via the `setSortCallback` method.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#sortCallback\r\n * @type {?Phaser.Types.GameObjects.Particles.ParticleSortCallback}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 883, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The callback used to sort the particles. Only used if `sortProperty`\rhas been set. Set this via the `setSortCallback` method.", "name": "sortCallback", "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleSortCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleSortCallback", "nullable": true } }, "nullable": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#sortCallback", "scope": "instance", "kind": "member", "___id": "T000002R014167", "___s": true }, { "comment": "/**\r\n * A list of Particle Processors being managed by this Emitter.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#processors\r\n * @type {Phaser.Structs.List.}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 893, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "A list of Particle Processors being managed by this Emitter.", "name": "processors", "type": { "names": [ "Phaser.Structs.List." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Phaser.Structs.List" }, "applications": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleProcessor" } ] } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#processors", "scope": "instance", "kind": "member", "___id": "T000002R014169", "___s": true }, { "comment": "/**\r\n * The tint mode used by the Particles in this Emitter.\r\n *\r\n * Available modes are:\r\n * - Phaser.TintModes.MULTIPLY (default)\r\n * - Phaser.TintModes.FILL\r\n * - Phaser.TintModes.ADD\r\n * - Phaser.TintModes.SCREEN\r\n * - Phaser.TintModes.OVERLAY\r\n * - Phaser.TintModes.HARD_LIGHT\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#tintMode\r\n * @type {Phaser.TintModes}\r\n * @default Phaser.TintModes.MULTIPLY\r\n * @since 4.0.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 902, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The tint mode used by the Particles in this Emitter.\r\rAvailable modes are:\r- Phaser.TintModes.MULTIPLY (default)\r- Phaser.TintModes.FILL\r- Phaser.TintModes.ADD\r- Phaser.TintModes.SCREEN\r- Phaser.TintModes.OVERLAY\r- Phaser.TintModes.HARD_LIGHT", "name": "tintMode", "type": { "names": [ "Phaser.TintModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.TintModes" } }, "defaultvalue": "Phaser.TintModes.MULTIPLY", "since": "4.0.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#tintMode", "scope": "instance", "kind": "member", "___id": "T000002R014171", "___s": true }, { "comment": "/**\r\n * Called when this Game Object is added to a Scene. Registers this emitter\r\n * with the Scene's update list so it receives `preUpdate` calls each frame.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#addedToScene\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 948, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Called when this Game Object is added to a Scene. Registers this emitter\rwith the Scene's update list so it receives `preUpdate` calls each frame.", "kind": "function", "name": "addedToScene", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#addedToScene", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#addedToScene", "___id": "T000002R014176", "___s": true }, { "comment": "/**\r\n * Called when this Game Object is removed from a Scene. Unregisters this\r\n * emitter from the Scene's update list so it no longer receives `preUpdate` calls.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#removedFromScene\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 960, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Called when this Game Object is removed from a Scene. Unregisters this\remitter from the Scene's update list so it no longer receives `preUpdate` calls.", "kind": "function", "name": "removedFromScene", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#removedFromScene", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#removedFromScene", "___id": "T000002R014178", "___s": true }, { "comment": "/**\r\n * Takes an Emitter Configuration file and resets this Emitter, using any\r\n * properties defined in the config to then set it up again.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setConfig\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.ParticleEmitterConfig} config - Settings for this emitter.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 972, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Takes an Emitter Configuration file and resets this Emitter, using any\rproperties defined in the config to then set it up again.", "kind": "function", "name": "setConfig", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig" } }, "description": "Settings for this emitter.", "name": "config" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setConfig", "scope": "instance", "___id": "T000002R014180", "___s": true }, { "comment": "/**\r\n * Takes an existing Emitter Configuration file and updates this Emitter.\r\n * Existing properties are overridden while new properties are added. The\r\n * updated configuration is then passed to the `setConfig` method to reset\r\n * the Emitter with the updated configuration.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#updateConfig\r\n * @since 3.85.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.ParticleEmitterConfig} config - Settings for this emitter.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Takes an existing Emitter Configuration file and updates this Emitter.\rExisting properties are overridden while new properties are added. The\rupdated configuration is then passed to the `setConfig` method to reset\rthe Emitter with the updated configuration.", "kind": "function", "name": "updateConfig", "since": "3.85.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig" } }, "description": "Settings for this emitter.", "name": "config" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#updateConfig", "scope": "instance", "___id": "T000002R014204", "___s": true }, { "comment": "/**\r\n * Creates a description of this emitter suitable for JSON serialization.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.GameObjects.JSONGameObject} A JSON representation of the Game Object.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1138, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Creates a description of this emitter suitable for JSON serialization.", "kind": "function", "name": "toJSON", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.JSONGameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.JSONGameObject" } }, "description": "A JSON representation of the Game Object." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#toJSON", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#toJSON", "___id": "T000002R014206", "___s": true }, { "comment": "/**\r\n * Resets the internal counter trackers.\r\n *\r\n * You shouldn't ever need to call this directly.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#resetCounters\r\n * @since 3.60.0\r\n *\r\n * @param {number} frequency - The frequency counter.\r\n * @param {boolean} on - Set the complete flag.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1189, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Resets the internal counter trackers.\r\rYou shouldn't ever need to call this directly.", "kind": "function", "name": "resetCounters", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The frequency counter.", "name": "frequency" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set the complete flag.", "name": "on" } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#resetCounters", "scope": "instance", "___id": "T000002R014220", "___s": true }, { "comment": "/**\r\n * Continuously moves the particle origin to follow a Game Object's position.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#startFollow\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} target - The Object to follow.\r\n * @param {number} [offsetX=0] - Horizontal offset of the particle origin from the Game Object.\r\n * @param {number} [offsetY=0] - Vertical offset of the particle origin from the Game Object.\r\n * @param {boolean} [trackVisible=false] - Whether the emitter's visible state will track the target's visible state.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1214, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "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.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The Object to follow.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Horizontal offset of the particle origin from the Game Object.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Vertical offset of the particle origin from the Game Object.", "name": "offsetY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether the emitter's visible state will track the target's visible state.", "name": "trackVisible" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#startFollow", "scope": "instance", "___id": "T000002R014225", "___s": true }, { "comment": "/**\r\n * Stops following a Game Object.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#stopFollow\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1240, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Stops following a Game Object.", "kind": "function", "name": "stopFollow", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#stopFollow", "scope": "instance", "___id": "T000002R014232", "___s": true }, { "comment": "/**\r\n * Chooses a texture frame from {@link Phaser.GameObjects.Particles.ParticleEmitter#frames}.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#getFrame\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Textures.Frame} The texture frame.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Frame" } }, "description": "The texture frame." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getFrame", "scope": "instance", "___id": "T000002R014236", "___s": true }, { "comment": "/**\r\n * Sets a pattern for assigning texture frames to emitted particles. The `frames` configuration can be any of:\r\n *\r\n * frame: 0\r\n * frame: 'red'\r\n * frame: [ 0, 1, 2, 3 ]\r\n * frame: [ 'red', 'green', 'blue', 'pink', 'white' ]\r\n * frame: { frames: [ 'red', 'green', 'blue', 'pink', 'white' ], [cycle: bool], [quantity: int] }\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setEmitterFrame\r\n * @since 3.0.0\r\n *\r\n * @param {(array|string|number|Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig)} frames - One or more texture frames, or a configuration object.\r\n * @param {boolean} [pickRandom=true] - Whether frames should be assigned at random from `frames`.\r\n * @param {number} [quantity=1] - The number of consecutive particles that will receive each frame.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sets a pattern for assigning texture frames to emitted particles. The `frames` configuration can be any of:\r\rframe: 0\rframe: 'red'\rframe: [ 0, 1, 2, 3 ]\rframe: [ 'red', 'green', 'blue', 'pink', 'white' ]\rframe: { frames: [ 'red', 'green', 'blue', 'pink', 'white' ], [cycle: bool], [quantity: int] }", "kind": "function", "name": "setEmitterFrame", "since": "3.0.0", "params": [ { "type": { "names": [ "array", "string", "number", "Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig" } ] } }, "description": "One or more texture frames, or a configuration object.", "name": "frames" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether frames should be assigned at random from `frames`.", "name": "pickRandom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The number of consecutive particles that will receive each frame.", "name": "quantity" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setEmitterFrame", "scope": "instance", "___id": "T000002R014246", "___s": true }, { "comment": "/**\r\n * Chooses an animation from {@link Phaser.GameObjects.Particles.ParticleEmitter#anims}, if populated.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#getAnim\r\n * @since 3.60.0\r\n *\r\n * @return {string} The animation to play, or `null` if there aren't any.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Chooses an animation from {@link Phaser.GameObjects.Particles.ParticleEmitter#anims}, if populated.", "kind": "function", "name": "getAnim", "since": "3.60.0", "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The animation to play, or `null` if there aren't any." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getAnim", "scope": "instance", "___id": "T000002R014264", "___s": true }, { "comment": "/**\r\n * Sets a pattern for assigning animations to emitted particles. The `anims` configuration can be any of:\r\n *\r\n * anim: 'red'\r\n * anim: [ 'red', 'green', 'blue', 'pink', 'white' ]\r\n * anim: { anims: [ 'red', 'green', 'blue', 'pink', 'white' ], [cycle: bool], [quantity: int] }\r\n *\r\n * Call this method at least once before any particles are created, or set `anim` in the Particle Emitter's configuration when creating the Emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setAnim\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|Phaser.Types.GameObjects.Particles.ParticleEmitterAnimConfig)} anims - One or more animations, or a configuration object.\r\n * @param {boolean} [pickRandom=true] - Whether animations should be assigned at random from `anims`. If a config object is given, this parameter is ignored.\r\n * @param {number} [quantity=1] - The number of consecutive particles that will receive each animation. If a config object is given, this parameter is ignored.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1409, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sets a pattern for assigning animations to emitted particles. The `anims` configuration can be any of:\r\ranim: 'red'\ranim: [ 'red', 'green', 'blue', 'pink', 'white' ]\ranim: { anims: [ 'red', 'green', 'blue', 'pink', 'white' ], [cycle: bool], [quantity: int] }\r\rCall this method at least once before any particles are created, or set `anim` in the Particle Emitter's configuration when creating the Emitter.", "kind": "function", "name": "setAnim", "since": "3.60.0", "params": [ { "type": { "names": [ "string", "Array.", "Phaser.Types.GameObjects.Particles.ParticleEmitterAnimConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterAnimConfig" } ] } }, "description": "One or more animations, or a configuration object.", "name": "anims" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether animations should be assigned at random from `anims`. If a config object is given, this parameter is ignored.", "name": "pickRandom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The number of consecutive particles that will receive each animation. If a config object is given, this parameter is ignored.", "name": "quantity" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setAnim", "scope": "instance", "___id": "T000002R014271", "___s": true }, { "comment": "/**\r\n * Turns {@link Phaser.GameObjects.Particles.ParticleEmitter#radial} particle movement on or off.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setRadial\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} [value=true] - Radial mode (true) or point mode (false).\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1476, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Radial mode (true) or point mode (false).", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setRadial", "scope": "instance", "___id": "T000002R014289", "___s": true }, { "comment": "/**\r\n * Creates a Particle Bounds processor and adds it to this Emitter.\r\n *\r\n * This processor will check to see if any of the active Particles hit\r\n * the defined boundary, as specified by a Rectangle shape in world-space.\r\n *\r\n * If so, they are 'rebounded' back again by having their velocity adjusted.\r\n *\r\n * The strength of the rebound is controlled by the `Particle.bounce`\r\n * property.\r\n *\r\n * You should be careful to ensure that you emit particles within a bounds,\r\n * if set, otherwise it will lead to unpredictable visual results as the\r\n * particles are hastily repositioned.\r\n *\r\n * The Particle Bounds processor is returned from this method. If you wish\r\n * to modify the area you can directly change its `bounds` property, along\r\n * with the `collideLeft` etc values.\r\n *\r\n * To disable the bounds you can either set its `active` property to `false`,\r\n * or if you no longer require it, call `ParticleEmitter.removeParticleProcessor`.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#addParticleBounds\r\n * @since 3.60.0\r\n *\r\n * @param {(number|Phaser.Types.GameObjects.Particles.ParticleEmitterBounds|Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt)} x - The x-coordinate of the left edge of the boundary, or an object representing a rectangle.\r\n * @param {number} [y] - The y-coordinate of the top edge of the boundary.\r\n * @param {number} [width] - The width of the boundary.\r\n * @param {number} [height] - The height of the boundary.\r\n * @param {boolean} [collideLeft=true] - Whether particles interact with the left edge of the bounds.\r\n * @param {boolean} [collideRight=true] - Whether particles interact with the right edge of the bounds.\r\n * @param {boolean} [collideTop=true] - Whether particles interact with the top edge of the bounds.\r\n * @param {boolean} [collideBottom=true] - Whether particles interact with the bottom edge of the bounds.\r\n *\r\n * @return {Phaser.GameObjects.Particles.ParticleBounds} The Particle Bounds processor.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1495, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Creates a Particle Bounds processor and adds it to this Emitter.\r\rThis processor will check to see if any of the active Particles hit\rthe defined boundary, as specified by a Rectangle shape in world-space.\r\rIf so, they are 'rebounded' back again by having their velocity adjusted.\r\rThe strength of the rebound is controlled by the `Particle.bounce`\rproperty.\r\rYou should be careful to ensure that you emit particles within a bounds,\rif set, otherwise it will lead to unpredictable visual results as the\rparticles are hastily repositioned.\r\rThe Particle Bounds processor is returned from this method. If you wish\rto modify the area you can directly change its `bounds` property, along\rwith the `collideLeft` etc values.\r\rTo disable the bounds you can either set its `active` property to `false`,\ror if you no longer require it, call `ParticleEmitter.removeParticleProcessor`.", "kind": "function", "name": "addParticleBounds", "since": "3.60.0", "params": [ { "type": { "names": [ "number", "Phaser.Types.GameObjects.Particles.ParticleEmitterBounds", "Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterBounds" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y-coordinate of the top edge of the boundary.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the boundary.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the boundary.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether particles interact with the left edge of the bounds.", "name": "collideLeft" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether particles interact with the right edge of the bounds.", "name": "collideRight" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether particles interact with the top edge of the bounds.", "name": "collideTop" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether particles interact with the bottom edge of the bounds.", "name": "collideBottom" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Particles.ParticleBounds" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleBounds" } }, "description": "The Particle Bounds processor." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#addParticleBounds", "scope": "instance", "___id": "T000002R014293", "___s": true }, { "comment": "/**\r\n * Sets the initial radial speed of emitted particles.\r\n *\r\n * Changes the emitter to radial mode.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setParticleSpeed\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - The horizontal speed of the emitted Particles.\r\n * @param {number} [y=x] - The vertical speed of emitted Particles. If not set it will use the `x` value.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1546, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sets the initial radial speed of emitted particles.\r\rChanges the emitter to radial mode.", "kind": "function", "name": "setParticleSpeed", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal speed of the emitted Particles.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical speed of emitted Particles. If not set it will use the `x` value.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setParticleSpeed", "scope": "instance", "___id": "T000002R014300", "___s": true }, { "comment": "/**\r\n * Sets the vertical and horizontal scale of the emitted particles.\r\n *\r\n * You can also set the scale of the entire emitter via `setScale`.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setParticleScale\r\n * @since 3.60.0\r\n *\r\n * @param {number} [x=1] - The horizontal scale of the emitted Particles.\r\n * @param {number} [y=x] - The vertical scale of emitted Particles. If not set it will use the `x` value.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1580, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sets the vertical and horizontal scale of the emitted particles.\r\rYou can also set the scale of the entire emitter via `setScale`.", "kind": "function", "name": "setParticleScale", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The horizontal scale of the emitted Particles.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The vertical scale of emitted Particles. If not set it will use the `x` value.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setParticleScale", "scope": "instance", "___id": "T000002R014305", "___s": true }, { "comment": "/**\r\n * Sets the gravity applied to emitted particles.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setParticleGravity\r\n * @since 3.60.0\r\n *\r\n * @param {number} x - Horizontal acceleration due to gravity, in pixels per second squared. Set to zero for no gravity.\r\n * @param {number} y - Vertical acceleration due to gravity, in pixels per second squared. Set to zero for no gravity.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sets the gravity applied to emitted particles.", "kind": "function", "name": "setParticleGravity", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Horizontal acceleration due to gravity, in pixels per second squared. Set to zero for no gravity.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Vertical acceleration due to gravity, in pixels per second squared. Set to zero for no gravity.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setParticleGravity", "scope": "instance", "___id": "T000002R014309", "___s": true }, { "comment": "/**\r\n * Sets the opacity (alpha) of emitted particles.\r\n *\r\n * You can also set the alpha of the entire emitter via `setAlpha`.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setParticleAlpha\r\n * @since 3.60.0\r\n *\r\n * @param {(Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType)} value - A value between 0 (transparent) and 1 (opaque).\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1623, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sets the opacity (alpha) of emitted particles.\r\rYou can also set the alpha of the entire emitter via `setAlpha`.", "kind": "function", "name": "setParticleAlpha", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "description": "A value between 0 (transparent) and 1 (opaque).", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setParticleAlpha", "scope": "instance", "___id": "T000002R014313", "___s": true }, { "comment": "/**\r\n * Sets the color tint of emitted particles.\r\n *\r\n * This is a WebGL only feature.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setParticleTint\r\n * @since 3.60.0\r\n * @webglOnly\r\n *\r\n * @param {(Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType)} value - A value between 0 and 0xffffff.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1642, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sets the color tint of emitted particles.\r\rThis is a WebGL only feature.", "kind": "function", "name": "setParticleTint", "since": "3.60.0", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "description": "A value between 0 and 0xffffff.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setParticleTint", "scope": "instance", "___id": "T000002R014315", "___s": true }, { "comment": "/**\r\n * Sets the angle of a {@link Phaser.GameObjects.Particles.ParticleEmitter#radial} particle stream.\r\n *\r\n * The value is given in degrees using Phaser's right-handed coordinate system.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setEmitterAngle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} value - The angle of the initial velocity of emitted particles, in degrees.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1662, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sets the angle of a {@link Phaser.GameObjects.Particles.ParticleEmitter#radial} particle stream.\r\rThe value is given in degrees using Phaser's right-handed coordinate system.", "kind": "function", "name": "setEmitterAngle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "description": "The angle of the initial velocity of emitted particles, in degrees.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setEmitterAngle", "scope": "instance", "___id": "T000002R014317", "___s": true }, { "comment": "/**\r\n * Sets the lifespan of newly emitted particles in milliseconds.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setParticleLifespan\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} value - The lifespan of a particle, in ms.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1681, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sets the lifespan of newly emitted particles in milliseconds.", "kind": "function", "name": "setParticleLifespan", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "description": "The lifespan of a particle, in ms.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setParticleLifespan", "scope": "instance", "___id": "T000002R014319", "___s": true }, { "comment": "/**\r\n * Sets the number of particles released at each flow cycle or explosion.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setQuantity\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} quantity - The number of particles to release at each flow cycle or explosion.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1698, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "description": "The number of particles to release at each flow cycle or explosion.", "name": "quantity" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setQuantity", "scope": "instance", "___id": "T000002R014321", "___s": true }, { "comment": "/**\r\n * Sets the emitter's {@link Phaser.GameObjects.Particles.ParticleEmitter#frequency}\r\n * and {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity}.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setFrequency\r\n * @since 3.0.0\r\n *\r\n * @param {number} frequency - The time interval (>= 0) of each flow cycle, in ms; or -1 to put the emitter in explosion mode.\r\n * @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} [quantity] - The number of particles to release at each flow cycle or explosion.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1715, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sets the emitter's {@link Phaser.GameObjects.Particles.ParticleEmitter#frequency}\rand {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity}.", "kind": "function", "name": "setFrequency", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setFrequency", "scope": "instance", "___id": "T000002R014324", "___s": true }, { "comment": "/**\r\n * Adds a new Particle Death Zone to this Emitter.\r\n *\r\n * A particle is immediately killed as soon as its x/y coordinates intersect\r\n * with any of the configured Death Zones.\r\n *\r\n * The `source` can be a Geometry Shape, such as a Circle, Rectangle or Triangle.\r\n * Any valid object from the `Phaser.Geometry` namespace is allowed, as long as\r\n * it supports a `contains` function. You can set the `type` to be either `onEnter`\r\n * or `onLeave`.\r\n *\r\n * A single Death Zone instance can only exist once within this Emitter, but can belong\r\n * to multiple Emitters.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#addDeathZone\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.DeathZoneObject|Phaser.Types.GameObjects.Particles.DeathZoneObject[]} config - A Death Zone configuration object, a Death Zone instance, a valid Geometry object or an array of them.\r\n *\r\n * @return {Phaser.GameObjects.Particles.Zones.DeathZone[]} An array of the Death Zones that were added to this Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1741, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Adds a new Particle Death Zone to this Emitter.\r\rA particle is immediately killed as soon as its x/y coordinates intersect\rwith any of the configured Death Zones.\r\rThe `source` can be a Geometry Shape, such as a Circle, Rectangle or Triangle.\rAny valid object from the `Phaser.Geometry` namespace is allowed, as long as\rit supports a `contains` function. You can set the `type` to be either `onEnter`\ror `onLeave`.\r\rA single Death Zone instance can only exist once within this Emitter, but can belong\rto multiple Emitters.", "kind": "function", "name": "addDeathZone", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.DeathZoneObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.DeathZoneObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.GameObjects.Particles.DeathZoneObject", "type": "NameExpression" } ] } ] } }, "description": "A Death Zone configuration object, a Death Zone instance, a valid Geometry object or an array of them.", "name": "config" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Particles.Zones.DeathZone", "type": "NameExpression" } ] } }, "description": "An array of the Death Zones that were added to this Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#addDeathZone", "scope": "instance", "___id": "T000002R014329", "___s": true }, { "comment": "/**\r\n * Removes the given Particle Death Zone from this Emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#removeDeathZone\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Zones.DeathZone} zone - The Death Zone that should be removed from this Emitter.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1807, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Removes the given Particle Death Zone from this Emitter.", "kind": "function", "name": "removeDeathZone", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Zones.DeathZone" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Zones.DeathZone" } }, "description": "The Death Zone that should be removed from this Emitter.", "name": "zone" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#removeDeathZone", "scope": "instance", "___id": "T000002R014342", "___s": true }, { "comment": "/**\r\n * Clear all Death Zones from this Particle Emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#clearDeathZones\r\n * @since 3.70.0\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1824, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Clear all Death Zones from this Particle Emitter.", "kind": "function", "name": "clearDeathZones", "since": "3.70.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#clearDeathZones", "scope": "instance", "___id": "T000002R014344", "___s": true }, { "comment": "/**\r\n * Adds a new Particle Emission Zone to this Emitter.\r\n *\r\n * An {@link Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig EdgeZone} places particles on its edges.\r\n * Its {@link Phaser.Types.GameObjects.Particles.EdgeZoneSource source} can be a Curve, Path, Circle, Ellipse, Line, Polygon, Rectangle, or Triangle;\r\n * or any object with a suitable {@link Phaser.Types.GameObjects.Particles.EdgeZoneSourceCallback getPoints} method.\r\n *\r\n * A {@link Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig RandomZone} places the particles randomly within its interior.\r\n * Its {@link Phaser.GameObjects.Particles.Zones.RandomZone#source 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.\r\n *\r\n * An Emission Zone can only exist once within this Emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#addEmitZone\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.EmitZoneData|Phaser.Types.GameObjects.Particles.EmitZoneData[]} zone - An Emission Zone configuration object, a RandomZone or EdgeZone instance, or an array of them.\r\n *\r\n * @return {Phaser.Types.GameObjects.Particles.EmitZoneObject[]} An array of the Emission Zones that were added to this Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1839, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Adds a new Particle Emission Zone to this Emitter.\r\rAn {@link Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig EdgeZone} places particles on its edges.\rIts {@link Phaser.Types.GameObjects.Particles.EdgeZoneSource source} can be a Curve, Path, Circle, Ellipse, Line, Polygon, Rectangle, or Triangle;\ror any object with a suitable {@link Phaser.Types.GameObjects.Particles.EdgeZoneSourceCallback getPoints} method.\r\rA {@link Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig RandomZone} places the particles randomly within its interior.\rIts {@link Phaser.GameObjects.Particles.Zones.RandomZone#source 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.\r\rAn Emission Zone can only exist once within this Emitter.", "kind": "function", "name": "addEmitZone", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitZoneData", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitZoneData" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.GameObjects.Particles.EmitZoneData", "type": "NameExpression" } ] } ] } }, "description": "An Emission Zone configuration object, a RandomZone or EdgeZone instance, or an array of them.", "name": "zone" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.GameObjects.Particles.EmitZoneObject", "type": "NameExpression" } ] } }, "description": "An array of the Emission Zones that were added to this Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#addEmitZone", "scope": "instance", "___id": "T000002R014347", "___s": true }, { "comment": "/**\r\n * Removes the given Particle Emission Zone from this Emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#removeEmitZone\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Zones.EdgeZone|Phaser.GameObjects.Particles.Zones.RandomZone} zone - The Emission Zone that should be removed from this Emitter.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1915, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Removes the given Particle Emission Zone from this Emitter.", "kind": "function", "name": "removeEmitZone", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Zones.EdgeZone", "Phaser.GameObjects.Particles.Zones.RandomZone" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Zones.EdgeZone" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Zones.RandomZone" } ] } }, "description": "The Emission Zone that should be removed from this Emitter.", "name": "zone" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#removeEmitZone", "scope": "instance", "___id": "T000002R014364", "___s": true }, { "comment": "/**\r\n * Clear all Emission Zones from this Particle Emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#clearEmitZones\r\n * @since 3.70.0\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1934, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Clear all Emission Zones from this Particle Emitter.", "kind": "function", "name": "clearEmitZones", "since": "3.70.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#clearEmitZones", "scope": "instance", "___id": "T000002R014367", "___s": true }, { "comment": "/**\r\n * Takes the given particle and sets its x/y coordinates to match the next available\r\n * emission zone, if any have been configured. This method is called automatically\r\n * as part of the `Particle.fire` process.\r\n *\r\n * The Emit Zones are iterated in sequence. Once a zone has had a particle emitted\r\n * from it, then the next zone is used and so on, in a loop.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#getEmitZone\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle to set the emission zone for.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1951, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Takes the given particle and sets its x/y coordinates to match the next available\remission zone, if any have been configured. This method is called automatically\ras part of the `Particle.fire` process.\r\rThe Emit Zones are iterated in sequence. Once a zone has had a particle emitted\rfrom it, then the next zone is used and so on, in a loop.", "kind": "function", "name": "getEmitZone", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle to set the emission zone for.", "name": "particle" } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getEmitZone", "scope": "instance", "___id": "T000002R014371", "___s": true }, { "comment": "/**\r\n * Takes the given particle and checks to see if any of the configured Death Zones\r\n * will kill it and returns the result. This method is called automatically as part\r\n * of the `Particle.update` process.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#getDeathZone\r\n * @fires Phaser.GameObjects.Particles.Events#DEATH_ZONE\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle to test against the Death Zones.\r\n *\r\n * @return {boolean} `true` if the particle should be killed, otherwise `false`.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 1998, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Takes the given particle and checks to see if any of the configured Death Zones\rwill kill it and returns the result. This method is called automatically as part\rof the `Particle.update` process.", "kind": "function", "name": "getDeathZone", "fires": [ "Phaser.GameObjects.Particles.Events#event:DEATH_ZONE" ], "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle to test against the Death Zones.", "name": "particle" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the particle should be killed, otherwise `false`." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getDeathZone", "scope": "instance", "___id": "T000002R014378", "___s": true }, { "comment": "/**\r\n * Changes the currently active Emission Zone. The zones should have already\r\n * been added to this Emitter either via the emitter config, or the\r\n * `addEmitZone` method.\r\n *\r\n * Call this method by passing either a numeric zone index value, or\r\n * the zone instance itself.\r\n *\r\n * Prior to v3.60 an Emitter could only have a single Emit Zone and this\r\n * method was how you set it. From 3.60 and up it now performs a different\r\n * function and swaps between all available active zones.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone\r\n * @since 3.0.0\r\n *\r\n * @param {number|Phaser.GameObjects.Particles.Zones.EdgeZone|Phaser.GameObjects.Particles.Zones.RandomZone} zone - The Emit Zone to set as the active zone.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2030, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Changes the currently active Emission Zone. The zones should have already\rbeen added to this Emitter either via the emitter config, or the\r`addEmitZone` method.\r\rCall this method by passing either a numeric zone index value, or\rthe zone instance itself.\r\rPrior to v3.60 an Emitter could only have a single Emit Zone and this\rmethod was how you set it. From 3.60 and up it now performs a different\rfunction and swaps between all available active zones.", "kind": "function", "name": "setEmitZone", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "Phaser.GameObjects.Particles.Zones.EdgeZone", "Phaser.GameObjects.Particles.Zones.RandomZone" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Zones.EdgeZone" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Zones.RandomZone" } ] } }, "description": "The Emit Zone to set as the active zone.", "name": "zone" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone", "scope": "instance", "___id": "T000002R014383", "___s": true }, { "comment": "/**\r\n * Adds a Particle Processor, such as a Gravity Well, to this Emitter.\r\n *\r\n * It will start processing particles from the next update as long as its `active`\r\n * property is set.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#addParticleProcessor\r\n * @since 3.60.0\r\n *\r\n * @generic {Phaser.GameObjects.Particles.ParticleProcessor} T\r\n * @param {T} processor - The Particle Processor to add to this Emitter Manager.\r\n *\r\n * @return {T} The Particle Processor that was added to this Emitter Manager.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2070, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Adds a Particle Processor, such as a Gravity Well, to this Emitter.\r\rIt will start processing particles from the next update as long as its `active`\rproperty is set.", "kind": "function", "name": "addParticleProcessor", "since": "3.60.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.Particles.ParticleProcessor} T", "value": "{Phaser.GameObjects.Particles.ParticleProcessor} T" } ], "params": [ { "type": { "names": [ "T" ], "parsedType": { "type": "NameExpression", "name": "T" } }, "description": "The Particle Processor to add to this Emitter Manager.", "name": "processor" } ], "returns": [ { "type": { "names": [ "T" ], "parsedType": { "type": "NameExpression", "name": "T" } }, "description": "The Particle Processor that was added to this Emitter Manager." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#addParticleProcessor", "scope": "instance", "___id": "T000002R014389", "___s": true }, { "comment": "/**\r\n * Removes a Particle Processor from this Emitter.\r\n *\r\n * The Processor must belong to this Emitter to be removed.\r\n *\r\n * It is not destroyed when removed, allowing you to move it to another Emitter Manager,\r\n * so if you no longer require it you should call its `destroy` method directly.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#removeParticleProcessor\r\n * @since 3.60.0\r\n *\r\n * @generic {Phaser.GameObjects.Particles.ParticleProcessor} T\r\n * @param {T} processor - The Particle Processor to remove from this Emitter Manager.\r\n *\r\n * @return {?T} The Particle Processor that was removed, or null if it could not be found.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2101, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Removes a Particle Processor from this Emitter.\r\rThe Processor must belong to this Emitter to be removed.\r\rIt is not destroyed when removed, allowing you to move it to another Emitter Manager,\rso if you no longer require it you should call its `destroy` method directly.", "kind": "function", "name": "removeParticleProcessor", "since": "3.60.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.GameObjects.Particles.ParticleProcessor} T", "value": "{Phaser.GameObjects.Particles.ParticleProcessor} T" } ], "params": [ { "type": { "names": [ "T" ], "parsedType": { "type": "NameExpression", "name": "T" } }, "description": "The Particle Processor to remove from this Emitter Manager.", "name": "processor" } ], "returns": [ { "type": { "names": [ "T" ], "parsedType": { "type": "NameExpression", "name": "T", "nullable": true } }, "nullable": true, "description": "The Particle Processor that was removed, or null if it could not be found." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#removeParticleProcessor", "scope": "instance", "___id": "T000002R014392", "___s": true }, { "comment": "/**\r\n * Gets all active Particle Processors.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#getProcessors\r\n * @since 3.60.0\r\n *\r\n * @return {Phaser.GameObjects.Particles.ParticleProcessor[]} - An array of active Particle Processors.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2129, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Gets all active Particle Processors.", "kind": "function", "name": "getProcessors", "since": "3.60.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Particles.ParticleProcessor", "type": "NameExpression" } ] } }, "description": "- An array of active Particle Processors." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getProcessors", "scope": "instance", "___id": "T000002R014395", "___s": true }, { "comment": "/**\r\n * Creates a new Gravity Well, adds it to this Emitter and returns a reference to it.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#createGravityWell\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.GravityWellConfig} config - Configuration settings for the Gravity Well to create.\r\n *\r\n * @return {Phaser.GameObjects.Particles.GravityWell} The Gravity Well that was created.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2142, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Creates a new Gravity Well, adds it to this Emitter and returns a reference to it.", "kind": "function", "name": "createGravityWell", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.GravityWellConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.GravityWellConfig" } }, "description": "Configuration settings for the Gravity Well to create.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Particles.GravityWell" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.GravityWell" } }, "description": "The Gravity Well that was created." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#createGravityWell", "scope": "instance", "___id": "T000002R014397", "___s": true }, { "comment": "/**\r\n * Creates inactive particles and adds them to this emitter's pool.\r\n *\r\n * If `ParticleEmitter.maxParticles` is set it will limit the\r\n * value passed to this method to make sure it's not exceeded.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#reserve\r\n * @since 3.0.0\r\n *\r\n * @param {number} count - The number of particles to create.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2157, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Creates inactive particles and adds them to this emitter's pool.\r\rIf `ParticleEmitter.maxParticles` is set it will limit the\rvalue passed to this method to make sure it's not exceeded.", "kind": "function", "name": "reserve", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of particles to create.", "name": "count" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#reserve", "scope": "instance", "___id": "T000002R014399", "___s": true }, { "comment": "/**\r\n * Gets the number of active (in-use) particles in this emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#getAliveParticleCount\r\n * @since 3.0.0\r\n *\r\n * @return {number} The number of particles with `active=true`.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2192, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Gets the number of active (in-use) particles in this emitter.", "kind": "function", "name": "getAliveParticleCount", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of particles with `active=true`." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getAliveParticleCount", "scope": "instance", "___id": "T000002R014405", "___s": true }, { "comment": "/**\r\n * Gets the number of inactive (available) particles in this emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#getDeadParticleCount\r\n * @since 3.0.0\r\n *\r\n * @return {number} The number of particles with `active=false`.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Gets the number of inactive (available) particles in this emitter.", "kind": "function", "name": "getDeadParticleCount", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of particles with `active=false`." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getDeadParticleCount", "scope": "instance", "___id": "T000002R014407", "___s": true }, { "comment": "/**\r\n * Gets the total number of particles in this emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#getParticleCount\r\n * @since 3.0.0\r\n *\r\n * @return {number} The number of particles, including both alive and dead.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Gets the total number of particles in this emitter.", "kind": "function", "name": "getParticleCount", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of particles, including both alive and dead." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getParticleCount", "scope": "instance", "___id": "T000002R014409", "___s": true }, { "comment": "/**\r\n * Whether this emitter is at either its hard-cap limit (maxParticles), if set, or\r\n * the max allowed number of 'alive' particles (maxAliveParticles).\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#atLimit\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} Returns `true` if this Emitter is at its limit, or `false` if no limit, or below the `maxParticles` level.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2231, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Whether this emitter is at either its hard-cap limit (maxParticles), if set, or\rthe max allowed number of 'alive' particles (maxAliveParticles).", "kind": "function", "name": "atLimit", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014411", "___s": true }, { "comment": "/**\r\n * Sets a function to call for each newly emitted particle.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#onParticleEmit\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.ParticleEmitterCallback} callback - The function.\r\n * @param {*} [context] - The calling context.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2250, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterCallback" } }, "description": "The function.", "name": "callback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The calling context.", "name": "context" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#onParticleEmit", "scope": "instance", "___id": "T000002R014413", "___s": true }, { "comment": "/**\r\n * Sets a function to call for each particle death.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#onParticleDeath\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.ParticleDeathCallback} callback - The function.\r\n * @param {*} [context] - The function's calling context.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2282, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDeathCallback" } }, "description": "The function.", "name": "callback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "The function's calling context.", "name": "context" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#onParticleDeath", "scope": "instance", "___id": "T000002R014419", "___s": true }, { "comment": "/**\r\n * Deactivates every particle in this emitter immediately.\r\n *\r\n * These particles are killed but do not emit an event or callback.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#killAll\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2314, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Deactivates every particle in this emitter immediately.\r\rThese particles are killed but do not emit an event or callback.", "kind": "function", "name": "killAll", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#killAll", "scope": "instance", "___id": "T000002R014425", "___s": true }, { "comment": "/**\r\n * Calls a function for each active particle in this emitter. The function is\r\n * sent two parameters: a reference to the Particle instance and to this Emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#forEachAlive\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.ParticleEmitterCallback} callback - The function.\r\n * @param {*} context - The function's calling context.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2337, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Calls a function for each active particle in this emitter. The function is\rsent two parameters: a reference to the Particle instance and to this Emitter.", "kind": "function", "name": "forEachAlive", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleEmitterCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterCallback" } }, "description": "The function.", "name": "callback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The function's calling context.", "name": "context" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#forEachAlive", "scope": "instance", "___id": "T000002R014429", "___s": true }, { "comment": "/**\r\n * Calls a function for each inactive particle in this emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#forEachDead\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.ParticleEmitterCallback} callback - The function.\r\n * @param {*} context - The function's calling context.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2363, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterCallback" } }, "description": "The function.", "name": "callback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "description": "The function's calling context.", "name": "context" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#forEachDead", "scope": "instance", "___id": "T000002R014434", "___s": true }, { "comment": "/**\r\n * Enables emitting, sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitting} to `true`, and resets the flow counter.\r\n *\r\n * If this emitter is in flow mode (frequency >= 0; the default), the particle flow will start (or restart).\r\n *\r\n * If this emitter is in explode mode (frequency = -1), nothing will happen.\r\n * Use {@link Phaser.GameObjects.Particles.ParticleEmitter#explode} or {@link Phaser.GameObjects.Particles.ParticleEmitter#flow} instead.\r\n *\r\n * Calling this method will emit the `START` event.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#start\r\n * @fires Phaser.GameObjects.Particles.Events#START\r\n * @since 3.0.0\r\n *\r\n * @param {number} [advance=0] - Advance this number of ms in time through the emitter.\r\n * @param {number} [duration=0] - Limit this emitter to only emit particles for the given number of ms. Setting this parameter will override any duration already set in the Emitter configuration object.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Enables emitting, sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitting} to `true`, and resets the flow counter.\r\rIf this emitter is in flow mode (frequency >= 0; the default), the particle flow will start (or restart).\r\rIf this emitter is in explode mode (frequency = -1), nothing will happen.\rUse {@link Phaser.GameObjects.Particles.ParticleEmitter#explode} or {@link Phaser.GameObjects.Particles.ParticleEmitter#flow} instead.\r\rCalling this method will emit the `START` event.", "kind": "function", "name": "start", "fires": [ "Phaser.GameObjects.Particles.Events#event:START" ], "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Advance this number of ms in time through the emitter.", "name": "advance" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Limit this emitter to only emit particles for the given number of ms. Setting this parameter will override any duration already set in the Emitter configuration object.", "name": "duration" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#start", "scope": "instance", "___id": "T000002R014439", "___s": true }, { "comment": "/**\r\n * Turns {@link Phaser.GameObjects.Particles.ParticleEmitter#emitting off} the emitter and\r\n * stops it from emitting further particles. Currently alive particles will remain\r\n * active until they naturally expire unless you set the `kill` parameter to `true`.\r\n *\r\n * Calling this method will emit the `STOP` event. When the final particle has\r\n * expired the `COMPLETE` event will be emitted.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#stop\r\n * @fires Phaser.GameObjects.Particles.Events#STOP\r\n * @since 3.11.0\r\n *\r\n * @param {boolean} [kill=false] - Kill all particles immediately (true), or leave them to die after their lifespan expires? (false, the default)\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2432, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Turns {@link Phaser.GameObjects.Particles.ParticleEmitter#emitting off} the emitter and\rstops it from emitting further particles. Currently alive particles will remain\ractive until they naturally expire unless you set the `kill` parameter to `true`.\r\rCalling this method will emit the `STOP` event. When the final particle has\rexpired the `COMPLETE` event will be emitted.", "kind": "function", "name": "stop", "fires": [ "Phaser.GameObjects.Particles.Events#event:STOP" ], "since": "3.11.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Kill all particles immediately (true), or leave them to die after their lifespan expires? (false, the default)", "name": "kill" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#stop", "scope": "instance", "___id": "T000002R014444", "___s": true }, { "comment": "/**\r\n * {@link Phaser.GameObjects.Particles.ParticleEmitter#active Deactivates} the emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#pause\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "{@link Phaser.GameObjects.Particles.ParticleEmitter#active Deactivates} the emitter.", "kind": "function", "name": "pause", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#pause", "scope": "instance", "___id": "T000002R014448", "___s": true }, { "comment": "/**\r\n * {@link Phaser.GameObjects.Particles.ParticleEmitter#active Activates} the emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#resume\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2482, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "{@link Phaser.GameObjects.Particles.ParticleEmitter#active Activates} the emitter.", "kind": "function", "name": "resume", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#resume", "scope": "instance", "___id": "T000002R014451", "___s": true }, { "comment": "/**\r\n * Set the property by which active particles are sorted prior to be rendered.\r\n *\r\n * It allows you to control the rendering order of the particles.\r\n *\r\n * This can be any valid property of the `Particle` class, such as `y`, `alpha`\r\n * or `lifeT`.\r\n *\r\n * The 'alive' particles array is sorted in place each game frame. Setting a\r\n * sort property will override the `particleBringToTop` setting.\r\n *\r\n * If you wish to use your own sorting function, see `setSortCallback` instead.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setSortProperty\r\n * @since 3.60.0\r\n *\r\n * @param {string} [property] - The property on the `Particle` class to sort by.\r\n * @param {boolean} [ascending=true] - Should the particles be sorted in ascending or descending order?\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2497, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Set the property by which active particles are sorted prior to be rendered.\r\rIt allows you to control the rendering order of the particles.\r\rThis can be any valid property of the `Particle` class, such as `y`, `alpha`\ror `lifeT`.\r\rThe 'alive' particles array is sorted in place each game frame. Setting a\rsort property will override the `particleBringToTop` setting.\r\rIf you wish to use your own sorting function, see `setSortCallback` instead.", "kind": "function", "name": "setSortProperty", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The property on the `Particle` class to sort by.", "name": "property" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the particles be sorted in ascending or descending order?", "name": "ascending" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setSortProperty", "scope": "instance", "___id": "T000002R014454", "___s": true }, { "comment": "/**\r\n * Sets a callback to be used to sort the particles before rendering each frame.\r\n *\r\n * This allows you to define your own logic and behavior in the callback.\r\n *\r\n * The callback will be sent two parameters: the two Particles being compared,\r\n * and must adhere to the criteria of the `compareFn` in `Array.sort`:\r\n *\r\n * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description\r\n *\r\n * Call this method with no parameters to reset the sort callback.\r\n *\r\n * Setting your own callback will override both the `particleBringToTop` and\r\n * `sortProperty` settings of this Emitter.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#setSortCallback\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.ParticleSortCallback} [callback] - The callback to invoke when the particles are sorted. Leave undefined to reset to the default.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2530, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sets a callback to be used to sort the particles before rendering each frame.\r\rThis allows you to define your own logic and behavior in the callback.\r\rThe callback will be sent two parameters: the two Particles being compared,\rand must adhere to the criteria of the `compareFn` in `Array.sort`:\r\rhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description\r\rCall this method with no parameters to reset the sort callback.\r\rSetting your own callback will override both the `particleBringToTop` and\r`sortProperty` settings of this Emitter.", "kind": "function", "name": "setSortCallback", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleSortCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleSortCallback" } }, "optional": true, "description": "The callback to invoke when the particles are sorted. Leave undefined to reset to the default.", "name": "callback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#setSortCallback", "scope": "instance", "___id": "T000002R014461", "___s": true }, { "comment": "/**\r\n * Sorts active particles with {@link Phaser.GameObjects.Particles.ParticleEmitter#depthSortCallback}.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#depthSort\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2568, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Sorts active particles with {@link Phaser.GameObjects.Particles.ParticleEmitter#depthSortCallback}.", "kind": "function", "name": "depthSort", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#depthSort", "scope": "instance", "___id": "T000002R014466", "___s": true }, { "comment": "/**\r\n * Calculates the difference of two particles, for sorting them by depth.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#depthSortCallback\r\n * @since 3.0.0\r\n *\r\n * @param {object} a - The first particle.\r\n * @param {object} b - The second particle.\r\n *\r\n * @return {number} The difference of a and b's y coordinates.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2583, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Calculates the difference of two particles, for sorting them by depth.", "kind": "function", "name": "depthSortCallback", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The first particle.", "name": "a" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The second particle.", "name": "b" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The difference of a and b's y coordinates." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#depthSortCallback", "scope": "instance", "___id": "T000002R014468", "___s": true }, { "comment": "/**\r\n * Puts the emitter in flow mode (frequency >= 0) and starts (or restarts) a particle flow.\r\n *\r\n * To resume a flow at the current frequency and quantity, use {@link Phaser.GameObjects.Particles.ParticleEmitter#start} instead.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#flow\r\n * @fires Phaser.GameObjects.Particles.Events#START\r\n * @since 3.0.0\r\n *\r\n * @param {number} frequency - The time interval (>= 0) of each flow cycle, in ms.\r\n * @param {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} [count=1] - The number of particles to emit at each flow cycle.\r\n * @param {number} [stopAfter] - Stop this emitter from firing any more particles once this value is reached. Set to zero for unlimited. Setting this parameter will override any `stopAfter` value already set in the Emitter configuration object.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2608, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Puts the emitter in flow mode (frequency >= 0) and starts (or restarts) a particle flow.\r\rTo resume a flow at the current frequency and quantity, use {@link Phaser.GameObjects.Particles.ParticleEmitter#start} instead.", "kind": "function", "name": "flow", "fires": [ "Phaser.GameObjects.Particles.Events#event:START" ], "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time interval (>= 0) of each flow cycle, in ms.", "name": "frequency" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "optional": true, "defaultvalue": 1, "description": "The number of particles to emit at each flow cycle.", "name": "count" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Stop this emitter from firing any more particles once this value is reached. Set to zero for unlimited. Setting this parameter will override any `stopAfter` value already set in the Emitter configuration object.", "name": "stopAfter" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#flow", "scope": "instance", "___id": "T000002R014471", "___s": true }, { "comment": "/**\r\n * Puts the emitter in explode mode (frequency = -1), stopping any current particle flow, and emits several particles all at once.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#explode\r\n * @fires Phaser.GameObjects.Particles.Events#EXPLODE\r\n * @since 3.0.0\r\n *\r\n * @param {number} [count=this.quantity] - The number of Particles to emit.\r\n * @param {number} [x=this.x] - The x coordinate to emit the Particles from.\r\n * @param {number} [y=this.y] - The y coordinate to emit the Particles from.\r\n *\r\n * @return {(Phaser.GameObjects.Particles.Particle|undefined)} The most recently emitted Particle, or `undefined` if the emitter is at its limit.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2640, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "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", "fires": [ "Phaser.GameObjects.Particles.Events#event:EXPLODE" ], "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.quantity", "description": "The number of Particles to emit.", "name": "count" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.x", "description": "The x coordinate to emit the Particles from.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.y", "description": "The y coordinate to emit the Particles from.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" }, { "type": "UndefinedLiteral" } ] } }, "description": "The most recently emitted Particle, or `undefined` if the emitter is at its limit." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#explode", "scope": "instance", "___id": "T000002R014478", "___s": true }, { "comment": "/**\r\n * Emits particles at the given position. If no position is given, it will\r\n * emit from this Emitters current location.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#emitParticleAt\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=this.x] - The x coordinate to emit the Particles from.\r\n * @param {number} [y=this.y] - The y coordinate to emit the Particles from.\r\n * @param {number} [count=this.quantity] - The number of Particles to emit.\r\n *\r\n * @return {(Phaser.GameObjects.Particles.Particle|undefined)} The most recently emitted Particle, or `undefined` if the emitter is at its limit.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2666, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Emits particles at the given position. If no position is given, it will\remit from this Emitters current location.", "kind": "function", "name": "emitParticleAt", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.x", "description": "The x coordinate to emit the Particles from.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.y", "description": "The y coordinate to emit the Particles from.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.quantity", "description": "The number of Particles to emit.", "name": "count" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" }, { "type": "UndefinedLiteral" } ] } }, "description": "The most recently emitted Particle, or `undefined` if the emitter is at its limit." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#emitParticleAt", "scope": "instance", "___id": "T000002R014482", "___s": true }, { "comment": "/**\r\n * Emits particles at a given position (or the emitters current position).\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#emitParticle\r\n * @since 3.0.0\r\n *\r\n * @param {number} [count=this.quantity] - The number of Particles to emit.\r\n * @param {number} [x=this.x] - The x coordinate to emit the Particles from.\r\n * @param {number} [y=this.y] - The y coordinate to emit the Particles from.\r\n *\r\n * @return {(Phaser.GameObjects.Particles.Particle|undefined)} The most recently emitted Particle, or `undefined` if the emitter is at its limit.\r\n *\r\n * @see Phaser.GameObjects.Particles.Particle#fire\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2684, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Emits particles at a given position (or the emitters current position).", "kind": "function", "name": "emitParticle", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.quantity", "description": "The number of Particles to emit.", "name": "count" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.x", "description": "The x coordinate to emit the Particles from.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.y", "description": "The y coordinate to emit the Particles from.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" }, { "type": "UndefinedLiteral" } ] } }, "description": "The most recently emitted Particle, or `undefined` if the emitter is at its limit." } ], "see": [ "Phaser.GameObjects.Particles.Particle#fire" ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#emitParticle", "scope": "instance", "___id": "T000002R014484", "___s": true }, { "comment": "/**\r\n * Fast forwards this Particle Emitter and all of its particles.\r\n *\r\n * Works by running the Emitter `preUpdate` handler in a loop until the `time`\r\n * has been reached at `delta` steps per loop.\r\n *\r\n * All callbacks and emitter related events that would normally be fired\r\n * will still be invoked.\r\n *\r\n * You can make an emitter 'fast forward' via the emitter config using the\r\n * `advance` property. Set this value to the number of ms you wish the\r\n * emitter to be fast-forwarded by. Or, call this method post-creation.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#fastForward\r\n * @since 3.60.0\r\n *\r\n * @param {number} time - The number of ms to advance the Particle Emitter by.\r\n * @param {number} [delta] - The amount of delta to use for each step. Defaults to 1000 / 60.\r\n *\r\n * @return {this} This Particle Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2765, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Fast forwards this Particle Emitter and all of its particles.\r\rWorks by running the Emitter `preUpdate` handler in a loop until the `time`\rhas been reached at `delta` steps per loop.\r\rAll callbacks and emitter related events that would normally be fired\rwill still be invoked.\r\rYou can make an emitter 'fast forward' via the emitter config using the\r`advance` property. Set this value to the number of ms you wish the\remitter to be fast-forwarded by. Or, call this method post-creation.", "kind": "function", "name": "fastForward", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of ms to advance the Particle Emitter by.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount of delta to use for each step. Defaults to 1000 / 60.", "name": "delta" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Particle Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#fastForward", "scope": "instance", "___id": "T000002R014494", "___s": true }, { "comment": "/**\r\n * Updates this emitter and its particles.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#preUpdate\r\n * @fires Phaser.GameObjects.Particles.Events#COMPLETE\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Updates this emitter and its particles.", "kind": "function", "name": "preUpdate", "fires": [ "Phaser.GameObjects.Particles.Events#event:COMPLETE" ], "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp as generated by the Request Animation Frame or SetTimeout.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014501", "___s": true }, { "comment": "/**\r\n * Takes either a Rectangle Geometry object or an Arcade Physics Body and tests\r\n * to see if it intersects with any currently alive Particle in this Emitter.\r\n *\r\n * Overlapping particles are returned in an array, where you can perform further\r\n * processing on them. If nothing overlaps then the array will be empty.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#overlap\r\n * @since 3.60.0\r\n *\r\n * @param {(Phaser.Geom.Rectangle|Phaser.Physics.Arcade.Body)} target - A Rectangle or Arcade Physics Body to check for intersection against all alive particles.\r\n *\r\n * @return {Phaser.GameObjects.Particles.Particle[]} An array of Particles that overlap with the given target.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2930, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Takes either a Rectangle Geometry object or an Arcade Physics Body and tests\rto see if it intersects with any currently alive Particle in this Emitter.\r\rOverlapping particles are returned in an array, where you can perform further\rprocessing on them. If nothing overlaps then the array will be empty.", "kind": "function", "name": "overlap", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle", "Phaser.Physics.Arcade.Body" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "Phaser.Physics.Arcade.Body" } ] } }, "description": "A Rectangle or Arcade Physics Body to check for intersection against all alive particles.", "name": "target" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.Particles.Particle", "type": "NameExpression" } ] } }, "description": "An array of Particles that overlap with the given target." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#overlap", "scope": "instance", "___id": "T000002R014525", "___s": true }, { "comment": "/**\r\n * Returns a bounds Rectangle calculated from the bounds of all currently\r\n * _active_ Particles in this Emitter. If this Emitter has only just been\r\n * created and not yet rendered, then calling this method will return a Rectangle\r\n * with a max safe integer for dimensions. Use the `advance` parameter to\r\n * avoid this.\r\n *\r\n * Typically it takes a few seconds for a flow Emitter to 'warm up'. You can\r\n * use the `advance` and `delta` parameters to force the Emitter to\r\n * 'fast forward' in time to try and allow the bounds to be more accurate,\r\n * as it will calculate the bounds based on the particle bounds across all\r\n * timesteps, giving a better result.\r\n *\r\n * You can also use the `padding` parameter to increase the size of the\r\n * bounds. Emitters with a lot of randomness in terms of direction or lifespan\r\n * can often return a bounds smaller than their possible maximum. By using\r\n * the `padding` (and `advance` if needed) you can help limit this.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#getBounds\r\n * @since 3.60.0\r\n *\r\n * @param {number} [padding] - The amount of padding, in pixels, to add to the bounds Rectangle.\r\n * @param {number} [advance] - The number of ms to advance the Particle Emitter by. Defaults to 0, i.e. not used.\r\n * @param {number} [delta] - The amount of delta to use for each step. Defaults to 1000 / 60.\r\n * @param {Phaser.Geom.Rectangle} [output] - The Rectangle to store the results in. If not given a new one will be created.\r\n *\r\n * @return {Phaser.Geom.Rectangle} A Rectangle containing the calculated bounds of this Emitter.\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 2966, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Returns a bounds Rectangle calculated from the bounds of all currently\r_active_ Particles in this Emitter. If this Emitter has only just been\rcreated and not yet rendered, then calling this method will return a Rectangle\rwith a max safe integer for dimensions. Use the `advance` parameter to\ravoid this.\r\rTypically it takes a few seconds for a flow Emitter to 'warm up'. You can\ruse the `advance` and `delta` parameters to force the Emitter to\r'fast forward' in time to try and allow the bounds to be more accurate,\ras it will calculate the bounds based on the particle bounds across all\rtimesteps, giving a better result.\r\rYou can also use the `padding` parameter to increase the size of the\rbounds. Emitters with a lot of randomness in terms of direction or lifespan\rcan often return a bounds smaller than their possible maximum. By using\rthe `padding` (and `advance` if needed) you can help limit this.", "kind": "function", "name": "getBounds", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount of padding, in pixels, to add to the bounds Rectangle.", "name": "padding" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The number of ms to advance the Particle Emitter by. Defaults to 0, i.e. not used.", "name": "advance" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount of delta to use for each step. Defaults to 1000 / 60.", "name": "delta" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "optional": true, "description": "The Rectangle to store the results in. If not given a new one will be created.", "name": "output" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "A Rectangle containing the calculated bounds of this Emitter." } ], "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#getBounds", "scope": "instance", "___id": "T000002R014533", "___s": true }, { "comment": "/**\r\n * Prints a warning to the console if you mistakenly call this function\r\n * thinking it works the same way as Phaser v3.55.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#createEmitter\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3068, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Prints a warning to the console if you mistakenly call this function\rthinking it works the same way as Phaser v3.55.", "kind": "function", "name": "createEmitter", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#createEmitter", "scope": "instance", "___id": "T000002R014554", "___s": true }, { "comment": "/**\r\n * The x coordinate the particles are emitted from.\r\n *\r\n * This is relative to the Emitters x coordinate and that of any parent.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#particleX\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3080, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The x coordinate the particles are emitted from.\r\rThis is relative to the Emitters x coordinate and that of any parent.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "particleX", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#particleX", "scope": "instance", "kind": "member", "___id": "T000002R014556", "___s": true }, { "comment": "/**\r\n * The y coordinate the particles are emitted from.\r\n *\r\n * This is relative to the Emitters y coordinate and that of any parent.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#particleY\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3106, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The y coordinate the particles are emitted from.\r\rThis is relative to the Emitters y coordinate and that of any parent.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "particleY", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#particleY", "scope": "instance", "kind": "member", "___id": "T000002R014560", "___s": true }, { "comment": "/**\r\n * The horizontal acceleration applied to emitted particles, in pixels per second squared.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#accelerationX\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The horizontal acceleration applied to emitted particles, in pixels per second squared.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "accelerationX", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#accelerationX", "scope": "instance", "kind": "member", "___id": "T000002R014564", "___s": true }, { "comment": "/**\r\n * The vertical acceleration applied to emitted particles, in pixels per second squared.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#accelerationY\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3156, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The vertical acceleration applied to emitted particles, in pixels per second squared.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "accelerationY", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#accelerationY", "scope": "instance", "kind": "member", "___id": "T000002R014568", "___s": true }, { "comment": "/**\r\n * The maximum horizontal velocity emitted particles can reach, in pixels per second.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityX\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n * @default 10000\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The maximum horizontal velocity emitted particles can reach, in pixels per second.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "maxVelocityX", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "defaultvalue": "10000", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityX", "scope": "instance", "kind": "member", "___id": "T000002R014572", "___s": true }, { "comment": "/**\r\n * The maximum vertical velocity emitted particles can reach, in pixels per second.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityY\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n * @default 10000\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3205, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The maximum vertical velocity emitted particles can reach, in pixels per second.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "maxVelocityY", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "defaultvalue": "10000", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityY", "scope": "instance", "kind": "member", "___id": "T000002R014576", "___s": true }, { "comment": "/**\r\n * The initial speed of emitted particles, in pixels per second.\r\n *\r\n * If using this as a getter it will return the `speedX` value.\r\n *\r\n * If using it as a setter it will update both `speedX` and `speedY` to the\r\n * given value.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#speed\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The initial speed of emitted particles, in pixels per second.\r\rIf using this as a getter it will return the `speedX` value.\r\rIf using it as a setter it will update both `speedX` and `speedY` to the\rgiven value.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "speed", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#speed", "scope": "instance", "kind": "member", "___id": "T000002R014580", "___s": true }, { "comment": "/**\r\n * The initial horizontal speed of emitted particles, in pixels per second.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#speedX\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3260, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The initial horizontal speed of emitted particles, in pixels per second.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "speedX", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#speedX", "scope": "instance", "kind": "member", "___id": "T000002R014584", "___s": true }, { "comment": "/**\r\n * The initial vertical speed of emitted particles, in pixels per second.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#speedY\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The initial vertical speed of emitted particles, in pixels per second.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "speedY", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#speedY", "scope": "instance", "kind": "member", "___id": "T000002R014588", "___s": true }, { "comment": "/**\r\n * The x coordinate emitted particles move toward, when {@link Phaser.GameObjects.Particles.ParticleEmitter#moveTo} is true.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#moveToX\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3308, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The x coordinate emitted particles move toward, when {@link Phaser.GameObjects.Particles.ParticleEmitter#moveTo} is true.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "moveToX", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#moveToX", "scope": "instance", "kind": "member", "___id": "T000002R014592", "___s": true }, { "comment": "/**\r\n * The y coordinate emitted particles move toward, when {@link Phaser.GameObjects.Particles.ParticleEmitter#moveTo} is true.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#moveToY\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3332, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The y coordinate emitted particles move toward, when {@link Phaser.GameObjects.Particles.ParticleEmitter#moveTo} is true.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "moveToY", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#moveToY", "scope": "instance", "kind": "member", "___id": "T000002R014596", "___s": true }, { "comment": "/**\r\n * The amount of velocity particles will use when rebounding off the\r\n * emitter bounds, if set. A value of 0 means no bounce. A value of 1\r\n * means a full rebound.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#bounce\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The amount of velocity particles will use when rebounding off the\remitter bounds, if set. A value of 0 means no bounce. A value of 1\rmeans a full rebound.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "bounce", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#bounce", "scope": "instance", "kind": "member", "___id": "T000002R014600", "___s": true }, { "comment": "/**\r\n * The horizontal scale of emitted particles.\r\n *\r\n * This is relative to the Emitters scale and that of any parent.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#particleScaleX\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3382, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The horizontal scale of emitted particles.\r\rThis is relative to the Emitters scale and that of any parent.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "particleScaleX", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#particleScaleX", "scope": "instance", "kind": "member", "___id": "T000002R014604", "___s": true }, { "comment": "/**\r\n * The vertical scale of emitted particles.\r\n *\r\n * This is relative to the Emitters scale and that of any parent.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#particleScaleY\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The vertical scale of emitted particles.\r\rThis is relative to the Emitters scale and that of any parent.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "particleScaleY", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#particleScaleY", "scope": "instance", "kind": "member", "___id": "T000002R014608", "___s": true }, { "comment": "/**\r\n * A color tint value that is applied to the texture of the emitted\r\n * particle. The value should be given in hex format, i.e. 0xff0000\r\n * for a red tint, and should not include the alpha channel.\r\n *\r\n * Tints are multiplicative by default, meaning a tint value of white\r\n * (0xffffff) will effectively reset the tint to nothing.\r\n *\r\n * Modify the `ParticleEmitter.tintMode` property to change the tint mode.\r\n *\r\n * When you define the color via the Emitter config you should give\r\n * it as an array of color values. The Particle will then interpolate\r\n * through these colors over the course of its lifespan. Setting this\r\n * will override any `tint` value that may also be given.\r\n *\r\n * This is a WebGL only feature.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#particleColor\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3434, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "A color tint value that is applied to the texture of the emitted\rparticle. The value should be given in hex format, i.e. 0xff0000\rfor a red tint, and should not include the alpha channel.\r\rTints are multiplicative by default, meaning a tint value of white\r(0xffffff) will effectively reset the tint to nothing.\r\rModify the `ParticleEmitter.tintMode` property to change the tint mode.\r\rWhen you define the color via the Emitter config you should give\rit as an array of color values. The Particle will then interpolate\rthrough these colors over the course of its lifespan. Setting this\rwill override any `tint` value that may also be given.\r\rThis is a WebGL only feature.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "particleColor", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#particleColor", "scope": "instance", "kind": "member", "___id": "T000002R014612", "___s": true }, { "comment": "/**\r\n * Controls the easing function used when you have created an\r\n * Emitter that uses the `color` property to interpolate the\r\n * tint of Particles over their lifetime.\r\n *\r\n * Setting this has no effect if you haven't also applied a\r\n * `particleColor` to this Emitter.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#colorEase\r\n * @type {string}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3472, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Controls the easing function used when you have created an\rEmitter that uses the `color` property to interpolate the\rtint of Particles over their lifetime.\r\rSetting this has no effect if you haven't also applied a\r`particleColor` to this Emitter.", "name": "colorEase", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#colorEase", "scope": "instance", "kind": "member", "___id": "T000002R014616", "___s": true }, { "comment": "/**\r\n * A color tint value that is applied to the texture of the emitted\r\n * particle. The value should be given in hex format, i.e. 0xff0000\r\n * for a red tint, and should not include the alpha channel.\r\n *\r\n * Tints are multiplicative by default, meaning a tint value of white\r\n * (0xffffff) will effectively reset the tint to nothing.\r\n *\r\n * Modify the `ParticleEmitter.tintMode` property to change the tint mode.\r\n *\r\n * The `tint` value will be overridden if a `color` array is provided.\r\n *\r\n * This is a WebGL only feature.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#particleTint\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3498, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "A color tint value that is applied to the texture of the emitted\rparticle. The value should be given in hex format, i.e. 0xff0000\rfor a red tint, and should not include the alpha channel.\r\rTints are multiplicative by default, meaning a tint value of white\r(0xffffff) will effectively reset the tint to nothing.\r\rModify the `ParticleEmitter.tintMode` property to change the tint mode.\r\rThe `tint` value will be overridden if a `color` array is provided.\r\rThis is a WebGL only feature.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "particleTint", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#particleTint", "scope": "instance", "kind": "member", "___id": "T000002R014620", "___s": true }, { "comment": "/**\r\n * The alpha value of the emitted particles. This is a value\r\n * between 0 and 1. Particles with alpha zero are invisible\r\n * and are therefore not rendered, but are still processed\r\n * by the Emitter.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#particleAlpha\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3533, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The alpha value of the emitted particles. This is a value\rbetween 0 and 1. Particles with alpha zero are invisible\rand are therefore not rendered, but are still processed\rby the Emitter.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "particleAlpha", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#particleAlpha", "scope": "instance", "kind": "member", "___id": "T000002R014624", "___s": true }, { "comment": "/**\r\n * The lifespan of the emitted particles. This value is given\r\n * in milliseconds and defaults to 1000ms (1 second). When a\r\n * particle reaches this amount it is killed.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#lifespan\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3560, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The lifespan of the emitted particles. This value is given\rin milliseconds and defaults to 1000ms (1 second). When a\rparticle reaches this amount it is killed.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "lifespan", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#lifespan", "scope": "instance", "kind": "member", "___id": "T000002R014628", "___s": true }, { "comment": "/**\r\n * The angle at which the particles are emitted. The values are\r\n * given in degrees. This allows you to control the direction\r\n * of the emitter. If you wish instead to change the rotation\r\n * of the particles themselves, see the `particleRotate` property.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#particleAngle\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3586, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The angle at which the particles are emitted. The values are\rgiven in degrees. This allows you to control the direction\rof the emitter. If you wish instead to change the rotation\rof the particles themselves, see the `particleRotate` property.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "particleAngle", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#particleAngle", "scope": "instance", "kind": "member", "___id": "T000002R014632", "___s": true }, { "comment": "/**\r\n * The rotation (or angle) of each particle when it is emitted.\r\n * The value is given in degrees and uses a right-handed\r\n * coordinate system, where 0 degrees points to the right, 90 degrees\r\n * points down and -90 degrees points up.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#particleRotate\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3613, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The rotation (or angle) of each particle when it is emitted.\rThe value is given in degrees and uses a right-handed\rcoordinate system, where 0 degrees points to the right, 90 degrees\rpoints down and -90 degrees points up.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "particleRotate", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#particleRotate", "scope": "instance", "kind": "member", "___id": "T000002R014636", "___s": true }, { "comment": "/**\r\n * The number of particles that are emitted each time an emission\r\n * occurs, i.e. from one 'explosion' or each frame in a 'flow' cycle.\r\n *\r\n * The default is 1.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#quantity\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setFrequency\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#setQuantity\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3640, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The number of particles that are emitted each time an emission\roccurs, i.e. from one 'explosion' or each frame in a 'flow' cycle.\r\rThe default is 1.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "quantity", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "see": [ "Phaser.GameObjects.Particles.ParticleEmitter#setFrequency", "Phaser.GameObjects.Particles.ParticleEmitter#setQuantity" ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#quantity", "scope": "instance", "kind": "member", "___id": "T000002R014640", "___s": true }, { "comment": "/**\r\n * The number of milliseconds to wait after emission before\r\n * the particles start updating. This allows you to emit particles\r\n * that appear 'static' or still on-screen and then, after this value,\r\n * begin to move.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#delay\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3669, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The number of milliseconds to wait after emission before\rthe particles start updating. This allows you to emit particles\rthat appear 'static' or still on-screen and then, after this value,\rbegin to move.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "delay", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#delay", "scope": "instance", "kind": "member", "___id": "T000002R014644", "___s": true }, { "comment": "/**\r\n * The number of milliseconds to wait after a particle has finished\r\n * its life before it will be removed. This allows you to 'hold' a\r\n * particle on the screen once it has reached its final state\r\n * before it then vanishes.\r\n *\r\n * Note that all particle updates will cease, including changing\r\n * alpha, scale, movement or animation.\r\n *\r\n * Accessing this property should typically return a number.\r\n * However, it can be set to any valid EmitterOp onEmit type.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#hold\r\n * @type {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3696, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The number of milliseconds to wait after a particle has finished\rits life before it will be removed. This allows you to 'hold' a\rparticle on the screen once it has reached its final state\rbefore it then vanishes.\r\rNote that all particle updates will cease, including changing\ralpha, scale, movement or animation.\r\rAccessing this property should typically return a number.\rHowever, it can be set to any valid EmitterOp onEmit type.", "name": "hold", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#hold", "scope": "instance", "kind": "member", "___id": "T000002R014648", "___s": true }, { "comment": "/**\r\n * The internal flow counter.\r\n *\r\n * Treat this property as read-only.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#flowCounter\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3726, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The internal flow counter.\r\rTreat this property as read-only.", "name": "flowCounter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#flowCounter", "scope": "instance", "kind": "member", "___id": "T000002R014652", "___s": true }, { "comment": "/**\r\n * The internal frame counter.\r\n *\r\n * Treat this property as read-only.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#frameCounter\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3749, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The internal frame counter.\r\rTreat this property as read-only.", "name": "frameCounter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#frameCounter", "scope": "instance", "kind": "member", "___id": "T000002R014657", "___s": true }, { "comment": "/**\r\n * The internal animation counter.\r\n *\r\n * Treat this property as read-only.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#animCounter\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3772, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The internal animation counter.\r\rTreat this property as read-only.", "name": "animCounter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#animCounter", "scope": "instance", "kind": "member", "___id": "T000002R014662", "___s": true }, { "comment": "/**\r\n * The internal elapsed counter.\r\n *\r\n * Treat this property as read-only.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#elapsed\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3795, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The internal elapsed counter.\r\rTreat this property as read-only.", "name": "elapsed", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#elapsed", "scope": "instance", "kind": "member", "___id": "T000002R014667", "___s": true }, { "comment": "/**\r\n * The internal stop counter.\r\n *\r\n * Treat this property as read-only.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#stopCounter\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3818, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The internal stop counter.\r\rTreat this property as read-only.", "name": "stopCounter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#stopCounter", "scope": "instance", "kind": "member", "___id": "T000002R014672", "___s": true }, { "comment": "/**\r\n * The internal complete flag.\r\n *\r\n * Treat this property as read-only.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#completeFlag\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3841, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The internal complete flag.\r\rTreat this property as read-only.", "name": "completeFlag", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#completeFlag", "scope": "instance", "kind": "member", "___id": "T000002R014677", "___s": true }, { "comment": "/**\r\n * The internal zone index.\r\n *\r\n * Treat this property as read-only.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#zoneIndex\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3864, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The internal zone index.\r\rTreat this property as read-only.", "name": "zoneIndex", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#zoneIndex", "scope": "instance", "kind": "member", "___id": "T000002R014682", "___s": true }, { "comment": "/**\r\n * The internal zone total.\r\n *\r\n * Treat this property as read-only.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#zoneTotal\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3887, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The internal zone total.\r\rTreat this property as read-only.", "name": "zoneTotal", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#zoneTotal", "scope": "instance", "kind": "member", "___id": "T000002R014687", "___s": true }, { "comment": "/**\r\n * The current frame index.\r\n *\r\n * Treat this property as read-only.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#currentFrame\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3910, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The current frame index.\r\rTreat this property as read-only.", "name": "currentFrame", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#currentFrame", "scope": "instance", "kind": "member", "___id": "T000002R014692", "___s": true }, { "comment": "/**\r\n * The current animation index.\r\n *\r\n * Treat this property as read-only.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleEmitter#currentAnim\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3933, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The current animation index.\r\rTreat this property as read-only.", "name": "currentAnim", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#currentAnim", "scope": "instance", "kind": "member", "___id": "T000002R014697", "___s": true }, { "comment": "/**\r\n * Destroys this Particle Emitter and all Particles it owns.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleEmitter#preDestroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleEmitter.js", "lineno": 3956, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Destroys this Particle Emitter and all Particles it owns.", "kind": "function", "name": "preDestroy", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleEmitter", "longname": "Phaser.GameObjects.Particles.ParticleEmitter#preDestroy", "scope": "instance", "___id": "T000002R014702", "___s": true }, { "comment": "/**\r\n * Creates a new Particle Emitter Game Object and returns it.\r\n *\r\n * A Particle Emitter is a Game Object that produces a stream of particles based on a\r\n * configuration object. It can be used to create effects such as explosions, fire, smoke,\r\n * rain, or any other particle-based visual. The emitter is added to the Scene and managed\r\n * as a standard Game Object, supporting transforms, depth, and other common properties.\r\n *\r\n * Prior to Phaser v3.60 this function would create a `ParticleEmitterManager`. These were removed\r\n * in v3.60 and replaced with creating a `ParticleEmitter` instance directly. Please see the\r\n * updated function parameters and class documentation for more details.\r\n *\r\n * Note: This method will only be available if the Particles Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#particles\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.ParticleEmitterCreatorConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Particles.ParticleEmitter} The Game Object that was created.\r\n */", "meta": { "filename": "ParticleEmitterCreator.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Creates a new Particle Emitter Game Object and returns it.\r\rA Particle Emitter is a Game Object that produces a stream of particles based on a\rconfiguration object. It can be used to create effects such as explosions, fire, smoke,\rrain, or any other particle-based visual. The emitter is added to the Scene and managed\ras a standard Game Object, supporting transforms, depth, and other common properties.\r\rPrior to Phaser v3.60 this function would create a `ParticleEmitterManager`. These were removed\rin v3.60 and replaced with creating a `ParticleEmitter` instance directly. Please see the\rupdated function parameters and class documentation for more details.\r\rNote: 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": [ "Phaser.Types.GameObjects.Particles.ParticleEmitterCreatorConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterCreatorConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleEmitter" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#particles", "scope": "instance", "___id": "T000002R014759", "___s": true }, { "comment": "/**\r\n * Creates a new Particle Emitter Game Object and adds it to the Scene.\r\n *\r\n * If you wish to configure the Emitter after creating it, use the `ParticleEmitter.setConfig` method.\r\n *\r\n * Prior to Phaser v3.60 this function would create a `ParticleEmitterManager`. These were removed\r\n * in v3.60 and replaced with creating a `ParticleEmitter` instance directly. Please see the\r\n * updated function parameters and class documentation for more details.\r\n *\r\n * Note: This method will only be available if the Particles Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#particles\r\n * @since 3.60.0\r\n *\r\n * @param {number} [x] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y] - The vertical position of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} [texture] - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {Phaser.Types.GameObjects.Particles.ParticleEmitterConfig} [config] - Configuration settings for the Particle Emitter.\r\n *\r\n * @return {Phaser.GameObjects.Particles.ParticleEmitter} The Game Object that was created.\r\n */", "meta": { "filename": "ParticleEmitterFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Creates a new Particle Emitter Game Object and adds it to the Scene.\r\rIf you wish to configure the Emitter after creating it, use the `ParticleEmitter.setConfig` method.\r\rPrior to Phaser v3.60 this function would create a `ParticleEmitterManager`. These were removed\rin v3.60 and replaced with creating a `ParticleEmitter` instance directly. Please see the\rupdated function parameters and class documentation for more details.\r\rNote: This method will only be available if the Particles Game Object has been built into Phaser.", "kind": "function", "name": "particles", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig" } }, "optional": true, "description": "Configuration settings for the Particle Emitter.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Particles.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleEmitter" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#particles", "scope": "instance", "___id": "T000002R014767", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * This class provides the structure required for all Particle Processors.\r\n *\r\n * You should extend it and add the functionality required for your processor,\r\n * including tidying up any resources this may create in the `destroy` method.\r\n *\r\n * See the GravityWell for an example of a processor.\r\n *\r\n * @class ParticleProcessor\r\n * @memberof Phaser.GameObjects.Particles\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {number} [x=0] - The x coordinate of the Particle Processor, in world space.\r\n * @param {number} [y=0] - The y coordinate of the Particle Processor, in world space.\r\n * @param {boolean} [active=true] - The active state of this Particle Processor.\r\n */", "meta": { "filename": "ParticleProcessor.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "classdesc": "This class provides the structure required for all Particle Processors.\r\rYou should extend it and add the functionality required for your processor,\rincluding tidying up any resources this may create in the `destroy` method.\r\rSee the GravityWell for an example of a processor.", "kind": "class", "name": "ParticleProcessor", "memberof": "Phaser.GameObjects.Particles", "since": "3.60.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the Particle Processor, in world space.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the Particle Processor, in world space.", "name": "y" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "The active state of this Particle Processor.", "name": "active" } ], "scope": "static", "longname": "Phaser.GameObjects.Particles.ParticleProcessor", "___id": "T000002R014820", "___s": true }, { "comment": "/**\r\n * A reference to the Particle Emitter that owns this Processor.\r\n * This is set automatically when the Processor is added to an Emitter\r\n * and nulled when removed or destroyed.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleProcessor#emitter\r\n * @type {Phaser.GameObjects.Particles.ParticleEmitter}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleProcessor.js", "lineno": 37, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "A reference to the Particle Emitter that owns this Processor.\rThis is set automatically when the Processor is added to an Emitter\rand nulled when removed or destroyed.", "name": "emitter", "type": { "names": [ "Phaser.GameObjects.Particles.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleEmitter" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleProcessor", "longname": "Phaser.GameObjects.Particles.ParticleProcessor#emitter", "scope": "instance", "kind": "member", "___id": "T000002R014826", "___s": true }, { "comment": "/**\r\n * The x coordinate of the Particle Processor, in world space.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleProcessor#x\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleProcessor.js", "lineno": 48, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The x coordinate of the Particle Processor, in world space.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleProcessor", "longname": "Phaser.GameObjects.Particles.ParticleProcessor#x", "scope": "instance", "kind": "member", "___id": "T000002R014828", "___s": true }, { "comment": "/**\r\n * The y coordinate of the Particle Processor, in world space.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleProcessor#y\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleProcessor.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The y coordinate of the Particle Processor, in world space.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleProcessor", "longname": "Phaser.GameObjects.Particles.ParticleProcessor#y", "scope": "instance", "kind": "member", "___id": "T000002R014830", "___s": true }, { "comment": "/**\r\n * The active state of the Particle Processor.\r\n *\r\n * An inactive Particle Processor will be skipped for processing by\r\n * its parent Emitter.\r\n *\r\n * @name Phaser.GameObjects.Particles.ParticleProcessor#active\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleProcessor.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The active state of the Particle Processor.\r\rAn inactive Particle Processor will be skipped for processing by\rits parent Emitter.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleProcessor", "longname": "Phaser.GameObjects.Particles.ParticleProcessor#active", "scope": "instance", "kind": "member", "___id": "T000002R014832", "___s": true }, { "comment": "/**\r\n * The Particle Processor update method should be overridden by your own\r\n * method and handle the processing of the particles, typically modifying\r\n * their velocityX/Y values based on the criteria of this processor.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleProcessor#update\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The Particle to update.\r\n * @param {number} delta - The delta time in ms.\r\n * @param {number} step - The delta value divided by 1000.\r\n * @param {number} t - The current normalized lifetime of the particle, between 0 (birth) and 1 (death).\r\n */", "meta": { "filename": "ParticleProcessor.js", "lineno": 79, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "The Particle Processor update method should be overridden by your own\rmethod and handle the processing of the particles, typically modifying\rtheir velocityX/Y values based on the criteria of this processor.", "kind": "function", "name": "update", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The Particle to update.", "name": "particle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time in ms.", "name": "delta" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta value divided by 1000.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current normalized lifetime of the particle, between 0 (birth) and 1 (death).", "name": "t" } ], "memberof": "Phaser.GameObjects.Particles.ParticleProcessor", "longname": "Phaser.GameObjects.Particles.ParticleProcessor#update", "scope": "instance", "___id": "T000002R014834", "___s": true }, { "comment": "/**\r\n * Destroys this Particle Processor by removing all external references.\r\n *\r\n * This is called automatically when the owning Particle Emitter is destroyed.\r\n *\r\n * @method Phaser.GameObjects.Particles.ParticleProcessor#destroy\r\n * @since 3.60.0\r\n */", "meta": { "filename": "ParticleProcessor.js", "lineno": 96, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles", "code": {} }, "description": "Destroys this Particle Processor by removing all external references.\r\rThis is called automatically when the owning Particle Emitter is destroyed.", "kind": "function", "name": "destroy", "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.ParticleProcessor", "longname": "Phaser.GameObjects.Particles.ParticleProcessor#destroy", "scope": "instance", "___id": "T000002R014836", "___s": true }, { "comment": "/**\r\n * @typedef {Phaser.GameObjects.Particles.Zones.DeathZone|Phaser.Types.GameObjects.Particles.ParticleEmitterDeathZoneConfig|Phaser.Types.GameObjects.Particles.DeathZoneSource} Phaser.Types.GameObjects.Particles.DeathZoneObject\r\n * @since 3.60.0\r\n */", "meta": { "filename": "DeathZoneObject.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "DeathZoneObject", "type": { "names": [ "Phaser.GameObjects.Particles.Zones.DeathZone", "Phaser.Types.GameObjects.Particles.ParticleEmitterDeathZoneConfig", "Phaser.Types.GameObjects.Particles.DeathZoneSource" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Zones.DeathZone" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterDeathZoneConfig" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.DeathZoneSource" } ] } }, "since": "3.60.0", "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.DeathZoneObject", "scope": "static", "___id": "T000002R014840", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.DeathZoneSource\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Types.GameObjects.Particles.DeathZoneSourceCallback} contains\r\n *\r\n * @see Phaser.Geom.Circle\r\n * @see Phaser.Geom.Ellipse\r\n * @see Phaser.Geom.Polygon\r\n * @see Phaser.Geom.Rectangle\r\n * @see Phaser.Geom.Triangle\r\n */", "meta": { "filename": "DeathZoneSource.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "DeathZoneSource", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.DeathZoneSourceCallback" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014841", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.GameObjects.Particles.DeathZoneSourceCallback\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate of the particle to check against this source area.\r\n * @param {number} y - The y coordinate of the particle to check against this source area.\r\n *\r\n * @return {boolean} - True if the coordinates are within the source area.\r\n */", "meta": { "filename": "DeathZoneSourceCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "DeathZoneSourceCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the particle to check against this source area.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the particle to check against this source area.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "- True if the coordinates are within the source area." } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.DeathZoneSourceCallback", "scope": "static", "___id": "T000002R014842", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.EdgeZoneSource\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Types.GameObjects.Particles.EdgeZoneSourceCallback} getPoints - A function placing points on the sources edge or edges.\r\n *\r\n * @see Phaser.Curves.Curve\r\n * @see Phaser.Curves.Path\r\n * @see Phaser.Geom.Circle\r\n * @see Phaser.Geom.Ellipse\r\n * @see Phaser.Geom.Line\r\n * @see Phaser.Geom.Polygon\r\n * @see Phaser.Geom.Rectangle\r\n * @see Phaser.Geom.Triangle\r\n */", "meta": { "filename": "EdgeZoneSource.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "EdgeZoneSource", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EdgeZoneSourceCallback" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014843", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.GameObjects.Particles.EdgeZoneSourceCallback\r\n * @since 3.0.0\r\n *\r\n * @param {number} quantity - The number of particles to place on the source edge. If 0, `stepRate` should be used instead.\r\n * @param {number} [stepRate] - The distance between each particle. When set, `quantity` is implied and should be set to `0`.\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like[]} - The points placed on the source edge.\r\n */", "meta": { "filename": "EdgeZoneSourceCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "EdgeZoneSourceCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of particles to place on the source edge. If 0, `stepRate` should be used instead.", "name": "quantity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "description": "- The points placed on the source edge." } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.EdgeZoneSourceCallback", "scope": "static", "___id": "T000002R014844", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.EmitterOpCustomEmitConfig\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback} onEmit - A callback that is invoked each time the emitter emits a particle.\r\n */", "meta": { "filename": "EmitterOpCustomEmitConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "EmitterOpCustomEmitConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014845", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.EmitterOpCustomUpdateConfig\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback} [onEmit] - A callback that is invoked each time the emitter emits a particle.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback} onUpdate - A callback that is invoked each time the emitter updates.\r\n */", "meta": { "filename": "EmitterOpCustomUpdateConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "EmitterOpCustomUpdateConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014846", "___s": true }, { "comment": "/**\r\n * Defines an operation yielding a value incremented continuously across a range.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.EmitterOpEaseConfig\r\n * @since 3.0.0\r\n *\r\n * @property {number} start - The starting value.\r\n * @property {number} end - The ending value.\r\n * @property {boolean} [random] - If true, the particle starts with a minimum random value between the start and end values.\r\n * @property {(string|function)} [ease='Linear'] - The ease to find. This can be either a string from the EaseMap, or a custom function.\r\n * @property {number[]} [easeParams] - An optional array of ease parameters to go with the ease.\r\n */", "meta": { "filename": "EmitterOpEaseConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "description": "Defines an operation yielding a value incremented continuously across a range.", "kind": "typedef", "name": "EmitterOpEaseConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The starting value.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The ending value.", "name": "end" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If true, the particle starts with a minimum random value between the start and end values.", "name": "random" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "defaultvalue": "'Linear'", "description": "The ease to find. This can be either a string from the EaseMap, or a custom function.", "name": "ease" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of ease parameters to go with the ease.", "name": "easeParams" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.EmitterOpEaseConfig", "scope": "static", "___id": "T000002R014847", "___s": true }, { "comment": "/**\r\n * Defines an operation yielding a value incremented continuously across an interpolated data set.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.EmitterOpInterpolationConfig\r\n * @since 3.60.0\r\n *\r\n * @property {number[]} values - The array of number values to interpolate through.\r\n * @property {(string|function)} [interpolation='Linear'] - The interpolation function to use. Typically one of `linear`, `bezier` or `catmull` or a custom function.\r\n * @property {(string|function)} [ease='Linear'] - An optional ease function to use. This can be either a string from the EaseMap, or a custom function.\r\n * @property {number[]} [easeParams] - An optional array of ease parameters to go with the ease.\r\n */", "meta": { "filename": "EmitterOpInterpolationConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "description": "Defines an operation yielding a value incremented continuously across an interpolated data set.", "kind": "typedef", "name": "EmitterOpInterpolationConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The array of number values to interpolate through.", "name": "values" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "defaultvalue": "'Linear'", "description": "The interpolation function to use. Typically one of `linear`, `bezier` or `catmull` or a custom function.", "name": "interpolation" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "optional": true, "defaultvalue": "'Linear'", "description": "An optional ease function to use. This can be either a string from the EaseMap, or a custom function.", "name": "ease" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of ease parameters to go with the ease.", "name": "easeParams" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.EmitterOpInterpolationConfig", "scope": "static", "___id": "T000002R014848", "___s": true }, { "comment": "/**\r\n * The returned value sets what the property will be at the START of the particle's life, on emit.\r\n * \r\n * @callback Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} [particle] - The particle.\r\n * @param {string} [key] - The name of the property.\r\n * @param {number} [value] - The current value of the property.\r\n *\r\n * @return {number} The new value of the property.\r\n */", "meta": { "filename": "EmitterOpOnEmitCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "optional": true, "description": "The particle.", "name": "particle" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The name of the property.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The current value of the property.", "name": "value" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the property." } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback", "scope": "static", "___id": "T000002R014849", "___s": true }, { "comment": "/**\r\n * @typedef {(number|number[]|Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback|Phaser.Types.GameObjects.Particles.EmitterOpRandomConfig|Phaser.Types.GameObjects.Particles.EmitterOpRandomMinMaxConfig|Phaser.Types.GameObjects.Particles.EmitterOpSteppedConfig|Phaser.Types.GameObjects.Particles.EmitterOpCustomEmitConfig)} Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType\r\n * @since 3.18.0\r\n */", "meta": { "filename": "EmitterOpOnEmitType.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "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.EmitterOpSteppedConfig", "Phaser.Types.GameObjects.Particles.EmitterOpCustomEmitConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitCallback" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpRandomConfig" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpRandomMinMaxConfig" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpSteppedConfig" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpCustomEmitConfig" } ] } }, "since": "3.18.0", "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "scope": "static", "___id": "T000002R014850", "___s": true }, { "comment": "/**\r\n * The returned value updates the property for the duration of the particle's life.\r\n * \r\n * @callback Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle.\r\n * @param {string} key - The name of the property.\r\n * @param {number} t - The normalized lifetime of the particle, between 0 (start) and 1 (end).\r\n * @param {number} value - The current value of the property.\r\n *\r\n * @return {number} The new value of the property.\r\n */", "meta": { "filename": "EmitterOpOnUpdateCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle.", "name": "particle" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the property.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The normalized lifetime of the particle, between 0 (start) and 1 (end).", "name": "t" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current value of the property.", "name": "value" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new value of the property." } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback", "scope": "static", "___id": "T000002R014851", "___s": true }, { "comment": "/**\r\n * @typedef {(Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback|Phaser.Types.GameObjects.Particles.EmitterOpEaseConfig|Phaser.Types.GameObjects.Particles.EmitterOpCustomUpdateConfig|Phaser.Types.GameObjects.Particles.EmitterOpInterpolationConfig)} Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType\r\n * @since 3.18.0\r\n */", "meta": { "filename": "EmitterOpOnUpdateType.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "EmitterOpOnUpdateType", "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback", "Phaser.Types.GameObjects.Particles.EmitterOpEaseConfig", "Phaser.Types.GameObjects.Particles.EmitterOpCustomUpdateConfig", "Phaser.Types.GameObjects.Particles.EmitterOpInterpolationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateCallback" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpEaseConfig" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpCustomUpdateConfig" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpInterpolationConfig" } ] } }, "since": "3.18.0", "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType", "scope": "static", "___id": "T000002R014852", "___s": true }, { "comment": "/**\r\n * Defines an operation yielding a random value within a range.\r\n * \r\n * @typedef {object} Phaser.Types.GameObjects.Particles.EmitterOpRandomConfig\r\n * @since 3.0.0\r\n *\r\n * @property {number[]} random - The minimum and maximum values, as [min, max].\r\n */", "meta": { "filename": "EmitterOpRandomConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "description": "Defines an operation yielding a random value within a range.", "kind": "typedef", "name": "EmitterOpRandomConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "The minimum and maximum values, as [min, max].", "name": "random" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.EmitterOpRandomConfig", "scope": "static", "___id": "T000002R014853", "___s": true }, { "comment": "/**\r\n * Defines an operation yielding a random value within a range.\r\n * \r\n * @typedef {object} Phaser.Types.GameObjects.Particles.EmitterOpRandomMinMaxConfig\r\n * @since 3.0.0\r\n *\r\n * @property {number} min - The minimum value.\r\n * @property {number} max - The maximum value.\r\n * @property {boolean} [int] - If true, only integers are selected from the range.\r\n */", "meta": { "filename": "EmitterOpRandomMinMaxConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "description": "Defines an operation yielding a random value within a range.", "kind": "typedef", "name": "EmitterOpRandomMinMaxConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum value.", "name": "max" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If true, only integers are selected from the range.", "name": "int" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.EmitterOpRandomMinMaxConfig", "scope": "static", "___id": "T000002R014854", "___s": true }, { "comment": "/**\r\n * Defines an operation yielding a value incremented by steps across a range.\r\n * \r\n * @typedef {object} Phaser.Types.GameObjects.Particles.EmitterOpSteppedConfig\r\n * @since 3.0.0\r\n *\r\n * @property {number} start - The starting value.\r\n * @property {number} end - The ending value.\r\n * @property {number} steps - The number of steps between start and end.\r\n */", "meta": { "filename": "EmitterOpSteppedConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "description": "Defines an operation yielding a value incremented by steps across a range.", "kind": "typedef", "name": "EmitterOpSteppedConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The starting value.", "name": "start" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The ending value.", "name": "end" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014855", "___s": true }, { "comment": "/**\r\n * @typedef {Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig|Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig|Phaser.GameObjects.Particles.Zones.EdgeZone|Phaser.GameObjects.Particles.Zones.RandomZone} Phaser.Types.GameObjects.Particles.EmitZoneData\r\n * @since 3.60.0\r\n */", "meta": { "filename": "EmitZoneData.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "EmitZoneData", "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig", "Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig", "Phaser.GameObjects.Particles.Zones.EdgeZone", "Phaser.GameObjects.Particles.Zones.RandomZone" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Zones.EdgeZone" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Zones.RandomZone" } ] } }, "since": "3.60.0", "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.EmitZoneData", "scope": "static", "___id": "T000002R014856", "___s": true }, { "comment": "/**\r\n * @typedef {Phaser.GameObjects.Particles.Zones.EdgeZone|Phaser.GameObjects.Particles.Zones.RandomZone} Phaser.Types.GameObjects.Particles.EmitZoneObject\r\n * @since 3.60.0\r\n */", "meta": { "filename": "EmitZoneObject.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "EmitZoneObject", "type": { "names": [ "Phaser.GameObjects.Particles.Zones.EdgeZone", "Phaser.GameObjects.Particles.Zones.RandomZone" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Zones.EdgeZone" }, { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Zones.RandomZone" } ] } }, "since": "3.60.0", "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.EmitZoneObject", "scope": "static", "___id": "T000002R014857", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.GravityWellConfig\r\n * @since 3.0.0\r\n *\r\n * @property {number} [x=0] - The x coordinate of the Gravity Well, in world space.\r\n * @property {number} [y=0] - The y coordinate of the Gravity Well, in world space.\r\n * @property {number} [power=0] - The strength of the gravity force - larger numbers produce a stronger force.\r\n * @property {number} [epsilon=100] - The minimum distance for which the gravity force is calculated.\r\n * @property {number} [gravity=50] - The gravitational force of this Gravity Well.\r\n */", "meta": { "filename": "GravityWellConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "GravityWellConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the Gravity Well, in world space.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the Gravity Well, in world space.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The strength of the gravity force - larger numbers produce a stronger force.", "name": "power" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 100, "description": "The minimum distance for which the gravity force is calculated.", "name": "epsilon" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014858", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Particles\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "namespace", "name": "Particles", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Particles", "scope": "static", "___id": "T000002R014859", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.GameObjects.Particles.ParticleClassConstructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.ParticleEmitter} emitter - The Emitter to which this Particle belongs.\r\n*/", "meta": { "filename": "ParticleClassConstructor.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleClassConstructor", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.ParticleEmitter" } }, "description": "The Emitter to which this Particle belongs.", "name": "emitter" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleClassConstructor", "scope": "static", "___id": "T000002R014860", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.ParticleData\r\n * @since 3.60.0\r\n *\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleDataValue} [tint={min:0xffffff,max:0xffffff}]\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleDataValue} [alpha={min:1,max:1}]\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleDataValue} [rotate={min:0,max:0}]\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleDataValue} [scaleX={min:1,max:1}]\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleDataValue} [scaleY={min:1,max:1}]\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleDataValue} [x={min:0,max:0}]\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleDataValue} [y={min:0,max:0}]\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleDataValue} [accelerationX={min:0,max:0}]\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleDataValue} [accelerationY={min:0,max:0}]\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleDataValue} [maxVelocityX={min:0,max:0}]\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleDataValue} [maxVelocityY={min:0,max:0}]\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleDataValue} [moveToX={min:0,max:0}]\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleDataValue} [moveToY={min:0,max:0}]\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleDataValue} [bounce={min:0,max:0}]\r\n */", "meta": { "filename": "ParticleData.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDataValue" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDataValue" } }, "optional": true, "defaultvalue": "{min:0xffffff,max:0xffffff}", "name": "tint" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDataValue" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDataValue" } }, "optional": true, "defaultvalue": "{min:1,max:1}", "name": "alpha" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDataValue" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDataValue" } }, "optional": true, "defaultvalue": "{min:0,max:0}", "name": "rotate" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDataValue" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDataValue" } }, "optional": true, "defaultvalue": "{min:1,max:1}", "name": "scaleX" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDataValue" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDataValue" } }, "optional": true, "defaultvalue": "{min:1,max:1}", "name": "scaleY" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDataValue" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDataValue" } }, "optional": true, "defaultvalue": "{min:0,max:0}", "name": "x" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDataValue" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDataValue" } }, "optional": true, "defaultvalue": "{min:0,max:0}", "name": "y" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDataValue" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDataValue" } }, "optional": true, "defaultvalue": "{min:0,max:0}", "name": "accelerationX" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDataValue" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDataValue" } }, "optional": true, "defaultvalue": "{min:0,max:0}", "name": "accelerationY" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDataValue" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDataValue" } }, "optional": true, "defaultvalue": "{min:0,max:0}", "name": "maxVelocityX" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDataValue" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDataValue" } }, "optional": true, "defaultvalue": "{min:0,max:0}", "name": "maxVelocityY" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDataValue" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDataValue" } }, "optional": true, "defaultvalue": "{min:0,max:0}", "name": "moveToX" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDataValue" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDataValue" } }, "optional": true, "defaultvalue": "{min:0,max:0}", "name": "moveToY" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleDataValue" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleDataValue" } }, "optional": true, "defaultvalue": "{min:0,max:0}", "name": "bounce" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleData", "scope": "static", "___id": "T000002R014861", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.ParticleDataValue\r\n * @since 3.60.0\r\n *\r\n * @property {number} min - The minimum value.\r\n * @property {number} max - The maximum value.\r\n */", "meta": { "filename": "ParticleDataValue.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleDataValue", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minimum value.", "name": "min" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum value.", "name": "max" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleDataValue", "scope": "static", "___id": "T000002R014862", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.GameObjects.Particles.ParticleDeathCallback\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle that died.\r\n*/", "meta": { "filename": "ParticleDeathCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleDeathCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle that died.", "name": "particle" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleDeathCallback", "scope": "static", "___id": "T000002R014863", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.ParticleEmitterAnimConfig\r\n * @since 3.60.0\r\n *\r\n * @property {string|string[]|Phaser.Types.Animations.PlayAnimationConfig|Phaser.Types.Animations.PlayAnimationConfig[]} [anims] - One or more animations names, or Play Animation Config objects.\r\n * @property {boolean} [cycle=false] - Whether animations will be assigned consecutively (true) or at random (false).\r\n * @property {number} [quantity=1] - The number of consecutive particles receiving each animation, when `cycle` is true.\r\n */", "meta": { "filename": "ParticleEmitterAnimConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleEmitterAnimConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "string", "Array.", "Phaser.Types.Animations.PlayAnimationConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.PlayAnimationConfig", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "One or more animations names, or Play Animation Config objects.", "name": "anims" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether animations will be assigned consecutively (true) or at random (false).", "name": "cycle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The number of consecutive particles receiving each animation, when `cycle` is true.", "name": "quantity" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleEmitterAnimConfig", "scope": "static", "___id": "T000002R014864", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.ParticleEmitterBounds\r\n * @since 3.0.0\r\n *\r\n * @property {number} x - The left edge of the rectangle.\r\n * @property {number} y - The top edge of the rectangle.\r\n * @property {number} width - The width of the rectangle.\r\n * @property {number} height - The height of the rectangle.\r\n *\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#addParticleBounds\r\n */", "meta": { "filename": "ParticleEmitterBounds.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleEmitterBounds", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left edge of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top edge of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the rectangle.", "name": "height" } ], "see": [ "Phaser.GameObjects.Particles.ParticleEmitter#addParticleBounds" ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleEmitterBounds", "scope": "static", "___id": "T000002R014865", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt\r\n * @since 3.0.0\r\n *\r\n * @property {number} x - The left edge of the rectangle.\r\n * @property {number} y - The top edge of the rectangle.\r\n * @property {number} w - The width of the rectangle.\r\n * @property {number} h - The height of the rectangle.\r\n *\r\n * @see Phaser.GameObjects.Particles.ParticleEmitter#addParticleBounds\r\n */", "meta": { "filename": "ParticleEmitterBoundsAlt.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleEmitterBoundsAlt", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The left edge of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top edge of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the rectangle.", "name": "w" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the rectangle.", "name": "h" } ], "see": [ "Phaser.GameObjects.Particles.ParticleEmitter#addParticleBounds" ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt", "scope": "static", "___id": "T000002R014866", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.GameObjects.Particles.ParticleEmitterCallback\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle associated with the call.\r\n * @param {Phaser.GameObjects.Particles.ParticleEmitter} emitter - This particle emitter associated with the call.\r\n */", "meta": { "filename": "ParticleEmitterCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleEmitterCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle associated with the call.", "name": "particle" }, { "type": { "names": [ "Phaser.GameObjects.Particles.ParticleEmitter" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014867", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.ParticleEmitterConfig\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} [active] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#active}. Setting this to false will stop the emitter from running at all. If you just wish to stop particles from emitting, set `emitting` property instead.\r\n * @property {Phaser.BlendModes|string} [blendMode] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#blendMode}.\r\n * @property {*} [callbackScope] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope} and {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope}.\r\n * @property {boolean} [collideBottom] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideBottom}.\r\n * @property {boolean} [collideLeft] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideLeft}.\r\n * @property {boolean} [collideRight] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideRight}.\r\n * @property {boolean} [collideTop] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideTop}.\r\n * @property {function} [deathCallback] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallback}.\r\n * @property {*} [deathCallbackScope] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope}.\r\n * @property {function} [emitCallback] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallback}.\r\n * @property {*} [emitCallbackScope] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope}.\r\n * @property {Phaser.Types.Math.Vector2Like} [follow] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#follow}.\r\n * @property {number} [frequency] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#frequency}.\r\n * @property {number} [gravityX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#gravityX}.\r\n * @property {number} [gravityY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#gravityY}.\r\n * @property {number} [maxParticles] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxParticles}.\r\n * @property {number} [maxAliveParticles] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxAliveParticles}.\r\n * @property {string} [name] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#name}.\r\n * @property {boolean} [emitting] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitting}.\r\n * @property {boolean} [particleBringToTop] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleBringToTop}.\r\n * @property {function} [particleClass] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleClass}.\r\n * @property {boolean} [radial] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#radial}.\r\n * @property {number} [timeScale] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#timeScale}.\r\n * @property {boolean} [trackVisible] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#trackVisible}.\r\n * @property {boolean} [visible] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#visible}.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [accelerationX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationX}.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [accelerationY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationY}.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [alpha] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleAlpha}.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} [angle] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleAngle} (emit only).\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [bounce] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#bounce}.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} [delay] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#delay} (emit only).\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} [hold] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#hold} (emit only).\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} [lifespan] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#lifespan} (emit only).\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [maxVelocityX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityX}.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [maxVelocityY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityY}.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [moveToX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToX}. If set, overrides `angle` and `speed` properties.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [moveToY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToY}. If set, overrides `angle` and `speed` properties.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} [quantity] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity} (emit only).\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [rotate] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleRotate}.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [scale] - As {@link Phaser.GameObjects.Particles.ParticleEmitter#setScale}.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [scaleX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleScaleX}.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [scaleY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleScaleY}.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} [speed] - As {@link Phaser.GameObjects.Particles.ParticleEmitter#setSpeed} (emit only).\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} [speedX] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#speedX} (emit only).\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType} [speedY] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#speedY} (emit only).\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [tint] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleTint}.\r\n * @property {number[]} [color] - An array of color values that the Particles interpolate through during their life. If set, overrides any `tint` property.\r\n * @property {string} [colorEase] - The string-based name of the Easing function to use if you have enabled Particle color interpolation via the `color` property, otherwise has no effect.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [x] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleX}.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType|Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType} [y] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleY}.\r\n * @property {Phaser.Types.GameObjects.Particles.EmitZoneData|Phaser.Types.GameObjects.Particles.EmitZoneData[]} [emitZone] - As {@link Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone}.\r\n * @property {Phaser.Types.GameObjects.Particles.DeathZoneObject|Phaser.Types.GameObjects.Particles.DeathZoneObject[]} [deathZone] - As {@link Phaser.GameObjects.Particles.ParticleEmitter#setDeathZone}.\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleEmitterBounds|Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt} [bounds] - As {@link Phaser.GameObjects.Particles.ParticleEmitter#setBounds}.\r\n * @property {Phaser.Types.Math.Vector2Like} [followOffset] - Offset coordinates that assigns to {@link Phaser.GameObjects.Particles.ParticleEmitter#followOffset}.\r\n * @property {string|string[]|Phaser.Types.GameObjects.Particles.ParticleEmitterAnimConfig} [anim] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#anims}.\r\n * @property {number|number[]|string|string[]|Phaser.Textures.Frame|Phaser.Textures.Frame[]|Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig} [frame] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#frames}.\r\n * @property {string|Phaser.Textures.Texture} [texture] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#texture}. Overrides any texture already set on the Emitter.\r\n * @property {number} [reserve] - Creates specified number of inactive particles and adds them to this emitter's pool. {@link Phaser.GameObjects.Particles.ParticleEmitter#reserve}\r\n * @property {number} [advance] - If you wish to 'fast forward' the emitter in time, set this value to a number representing the amount of ms the emitter should advance. Doing so implicitly sets `emitting` to `true`.\r\n * @property {number} [duration] - Limit the emitter to emit particles for a maximum of `duration` ms. Default to zero, meaning 'forever'.\r\n * @property {number} [stopAfter] - Limit the emitter to emit this exact number of particles and then stop. Default to zero, meaning no limit.\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleSortCallback} [sortCallback] - A custom callback that sorts particles prior to rendering. Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#sortCallback}.\r\n * @property {boolean} [sortOrderAsc] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#sortOrderAsc}.\r\n * @property {string} [sortProperty] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#sortProperty}.\r\n * @property {Phaser.TintModes} [tintMode] - Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#tintMode}.\r\n */", "meta": { "filename": "ParticleEmitterConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleEmitterConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#active}. Setting this to false will stop the emitter from running at all. If you just wish to stop particles from emitting, set `emitting` property instead.", "name": "active" }, { "type": { "names": [ "Phaser.BlendModes", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.BlendModes" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#blendMode}.", "name": "blendMode" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope} and {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope}.", "name": "callbackScope" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideBottom}.", "name": "collideBottom" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideLeft}.", "name": "collideLeft" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideRight}.", "name": "collideRight" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#collideTop}.", "name": "collideTop" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallback}.", "name": "deathCallback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope}.", "name": "deathCallbackScope" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallback}.", "name": "emitCallback" }, { "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope}.", "name": "emitCallbackScope" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#follow}.", "name": "follow" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#frequency}.", "name": "frequency" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#gravityX}.", "name": "gravityX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#gravityY}.", "name": "gravityY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxParticles}.", "name": "maxParticles" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxAliveParticles}.", "name": "maxAliveParticles" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#name}.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#emitting}.", "name": "emitting" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleBringToTop}.", "name": "particleBringToTop" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleClass}.", "name": "particleClass" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#radial}.", "name": "radial" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#timeScale}.", "name": "timeScale" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#trackVisible}.", "name": "trackVisible" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#visible}.", "name": "visible" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationX}.", "name": "accelerationX" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#accelerationY}.", "name": "accelerationY" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleAlpha}.", "name": "alpha" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleAngle} (emit only).", "name": "angle" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#bounce}.", "name": "bounce" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#hold} (emit only).", "name": "hold" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "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", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityX}.", "name": "maxVelocityX" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityY}.", "name": "maxVelocityY" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToX}. If set, overrides `angle` and `speed` properties.", "name": "moveToX" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#moveToY}. If set, overrides `angle` and `speed` properties.", "name": "moveToY" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleRotate}.", "name": "rotate" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleScaleX}.", "name": "scaleX" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleScaleY}.", "name": "scaleY" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleTint}.", "name": "tint" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "An array of color values that the Particles interpolate through during their life. If set, overrides any `tint` property.", "name": "color" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The string-based name of the Easing function to use if you have enabled Particle color interpolation via the `color` property, otherwise has no effect.", "name": "colorEase" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleX}.", "name": "x" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType", "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnEmitType" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitterOpOnUpdateType" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#particleY}.", "name": "y" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EmitZoneData", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EmitZoneData" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.GameObjects.Particles.EmitZoneData", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "As {@link Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone}.", "name": "emitZone" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.DeathZoneObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.DeathZoneObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.GameObjects.Particles.DeathZoneObject", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "As {@link Phaser.GameObjects.Particles.ParticleEmitter#setDeathZone}.", "name": "deathZone" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleEmitterBounds", "Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterBounds" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterBoundsAlt" } ] } }, "optional": true, "description": "As {@link Phaser.GameObjects.Particles.ParticleEmitter#setBounds}.", "name": "bounds" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "Offset coordinates that assigns to {@link Phaser.GameObjects.Particles.ParticleEmitter#followOffset}.", "name": "followOffset" }, { "type": { "names": [ "string", "Array.", "Phaser.Types.GameObjects.Particles.ParticleEmitterAnimConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterAnimConfig" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#anims}.", "name": "anim" }, { "type": { "names": [ "number", "Array.", "string", "Array.", "Phaser.Textures.Frame", "Array.", "Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Textures.Frame" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Textures.Frame", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#frames}.", "name": "frame" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#texture}. Overrides any texture already set on the Emitter.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Creates specified number of inactive particles and adds them to this emitter's pool. {@link Phaser.GameObjects.Particles.ParticleEmitter#reserve}", "name": "reserve" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If you wish to 'fast forward' the emitter in time, set this value to a number representing the amount of ms the emitter should advance. Doing so implicitly sets `emitting` to `true`.", "name": "advance" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Limit the emitter to emit particles for a maximum of `duration` ms. Default to zero, meaning 'forever'.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Limit the emitter to emit this exact number of particles and then stop. Default to zero, meaning no limit.", "name": "stopAfter" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleSortCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleSortCallback" } }, "optional": true, "description": "A custom callback that sorts particles prior to rendering. Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#sortCallback}.", "name": "sortCallback" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#sortOrderAsc}.", "name": "sortOrderAsc" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#sortProperty}.", "name": "sortProperty" }, { "type": { "names": [ "Phaser.TintModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.TintModes" } }, "optional": true, "description": "Sets {@link Phaser.GameObjects.Particles.ParticleEmitter#tintMode}.", "name": "tintMode" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig", "scope": "static", "___id": "T000002R014868", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.ParticleEmitterCreatorConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 3.60.0\r\n *\r\n * @property {string} [key] - The key of the Texture this Emitter will use to render particles, as stored in the Texture Manager.\r\n * @property {Phaser.Types.GameObjects.Particles.ParticleEmitterConfig} [config] - The Particle Emitter configuration object.\r\n */", "meta": { "filename": "ParticleEmitterCreatorConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleEmitterCreatorConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "3.60.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The key of the Texture this Emitter will use to render particles, as stored in the Texture Manager.", "name": "key" }, { "type": { "names": [ "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.ParticleEmitterConfig" } }, "optional": true, "description": "The Particle Emitter configuration object.", "name": "config" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleEmitterCreatorConfig", "scope": "static", "___id": "T000002R014869", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.ParticleEmitterDeathZoneConfig\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Types.GameObjects.Particles.DeathZoneSource} source - A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.DeathZone#source}.\r\n * @property {string} [type='onEnter'] - 'onEnter' or 'onLeave'.\r\n */", "meta": { "filename": "ParticleEmitterDeathZoneConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleEmitterDeathZoneConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.DeathZoneSource" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.DeathZoneSource" } }, "description": "A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.DeathZone#source}.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'onEnter'", "description": "'onEnter' or 'onLeave'.", "name": "type" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleEmitterDeathZoneConfig", "scope": "static", "___id": "T000002R014870", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Types.GameObjects.Particles.EdgeZoneSource} source - A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.EdgeZone#source}.\r\n * @property {string} type - 'edge'.\r\n * @property {number} quantity - The number of particles to place on the source edge. Set to 0 to use `stepRate` instead.\r\n * @property {number} [stepRate] - The distance between each particle. When set, `quantity` is implied and should be set to 0.\r\n * @property {boolean} [yoyo=false] - Whether particles are placed from start to end and then end to start.\r\n * @property {boolean} [seamless=true] - Whether one endpoint will be removed if it's identical to the other.\r\n * @property {number} [total=1] - The total number of particles this zone will emit before passing over to the next emission zone in the Emitter.\r\n */", "meta": { "filename": "ParticleEmitterEdgeZoneConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleEmitterEdgeZoneConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EdgeZoneSource" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EdgeZoneSource" } }, "description": "A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.EdgeZone#source}.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "'edge'.", "name": "type" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of particles to place on the source edge. Set to 0 to use `stepRate` instead.", "name": "quantity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether particles are placed from start to end and then end to start.", "name": "yoyo" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether one endpoint will be removed if it's identical to the other.", "name": "seamless" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The total number of particles this zone will emit before passing over to the next emission zone in the Emitter.", "name": "total" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleEmitterEdgeZoneConfig", "scope": "static", "___id": "T000002R014871", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.ParticleEmitterFrameConfig\r\n * @since 3.0.0\r\n *\r\n * @property {number[]|string[]|Phaser.Textures.Frame[]} [frames] - Array of texture frames.\r\n * @property {boolean} [cycle] - Whether texture frames will be assigned consecutively (true) or at random (false).\r\n * @property {number} [quantity] - The number of consecutive particles receiving each texture frame, when `cycle` is true.\r\n */", "meta": { "filename": "ParticleEmitterFrameConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleEmitterFrameConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Array.", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Textures.Frame", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Array of texture frames.", "name": "frames" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether texture frames will be assigned consecutively (true) or at random (false).", "name": "cycle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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", "___id": "T000002R014872", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.ParticleEmitterOps\r\n * @since 3.60.0\r\n *\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} accelerationX - The accelerationX EmitterOp instance. This is an onEmit and onUpdate operator.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} accelerationY - The accelerationY EmitterOp instance. This is an onEmit and onUpdate operator.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} alpha - The alpha EmitterOp instance. This is an onEmit and onUpdate operator.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} angle - The angle EmitterOp instance. This is an onEmit operator only.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} bounce - The bounce EmitterOp instance. This is an onEmit and onUpdate operator.\r\n * @property {Phaser.GameObjects.Particles.EmitterColorOp} color - The color EmitterColorOp instance. This is an onEmit and onUpdate operator.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} delay - The delay EmitterOp instance. This is an onEmit operator only.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} hold - The hold EmitterOp instance. This is an onEmit operator only.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} lifespan - The lifespan EmitterOp instance. This is an onEmit operator only.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} maxVelocityX - The maxVelocityX EmitterOp instance. This is an onEmit and onUpdate operator.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} maxVelocityY - The maxVelocityY EmitterOp instance. This is an onEmit and onUpdate operator.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} moveToX - The moveToX EmitterOp instance. This is an onEmit and onUpdate operator.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} moveToY - The moveToY EmitterOp instance. This is an onEmit and onUpdate operator.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} quantity - The quantity EmitterOp instance. This is an onEmit operator only.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} rotate - The rotate EmitterOp instance. This is an onEmit and onUpdate operator.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} scaleX - The scaleX EmitterOp instance. This is an onEmit and onUpdate operator.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} scaleY - The scaleY EmitterOp instance. This is an onEmit and onUpdate operator.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} speedX - The speedX EmitterOp instance. This is an onEmit operator only.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} speedY - The speedY EmitterOp instance. This is an onEmit operator only.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} tint - The tint EmitterOp instance. This is an onEmit and onUpdate operator.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} x - The x EmitterOp instance. This is an onEmit and onUpdate operator.\r\n * @property {Phaser.GameObjects.Particles.EmitterOp} y - The y EmitterOp instance. This is an onEmit and onUpdate operator.\r\n */", "meta": { "filename": "ParticleEmitterOps.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleEmitterOps", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The accelerationX EmitterOp instance. This is an onEmit and onUpdate operator.", "name": "accelerationX" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The accelerationY EmitterOp instance. This is an onEmit and onUpdate operator.", "name": "accelerationY" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The alpha EmitterOp instance. This is an onEmit and onUpdate operator.", "name": "alpha" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The angle EmitterOp instance. This is an onEmit operator only.", "name": "angle" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The bounce EmitterOp instance. This is an onEmit and onUpdate operator.", "name": "bounce" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterColorOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterColorOp" } }, "description": "The color EmitterColorOp instance. This is an onEmit and onUpdate operator.", "name": "color" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The delay EmitterOp instance. This is an onEmit operator only.", "name": "delay" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The hold EmitterOp instance. This is an onEmit operator only.", "name": "hold" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The lifespan EmitterOp instance. This is an onEmit operator only.", "name": "lifespan" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The maxVelocityX EmitterOp instance. This is an onEmit and onUpdate operator.", "name": "maxVelocityX" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The maxVelocityY EmitterOp instance. This is an onEmit and onUpdate operator.", "name": "maxVelocityY" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The moveToX EmitterOp instance. This is an onEmit and onUpdate operator.", "name": "moveToX" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The moveToY EmitterOp instance. This is an onEmit and onUpdate operator.", "name": "moveToY" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The quantity EmitterOp instance. This is an onEmit operator only.", "name": "quantity" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The rotate EmitterOp instance. This is an onEmit and onUpdate operator.", "name": "rotate" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The scaleX EmitterOp instance. This is an onEmit and onUpdate operator.", "name": "scaleX" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The scaleY EmitterOp instance. This is an onEmit and onUpdate operator.", "name": "scaleY" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The speedX EmitterOp instance. This is an onEmit operator only.", "name": "speedX" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The speedY EmitterOp instance. This is an onEmit operator only.", "name": "speedY" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The tint EmitterOp instance. This is an onEmit and onUpdate operator.", "name": "tint" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The x EmitterOp instance. This is an onEmit and onUpdate operator.", "name": "x" }, { "type": { "names": [ "Phaser.GameObjects.Particles.EmitterOp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.EmitterOp" } }, "description": "The y EmitterOp instance. This is an onEmit and onUpdate operator.", "name": "y" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleEmitterOps", "scope": "static", "___id": "T000002R014873", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Types.GameObjects.Particles.RandomZoneSource} source - A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.RandomZone#source}.\r\n * @property {string} [type] - 'random'.\r\n */", "meta": { "filename": "ParticleEmitterRandomZoneConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleEmitterRandomZoneConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.RandomZoneSource" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.RandomZoneSource" } }, "description": "A shape representing the zone. See {@link Phaser.GameObjects.Particles.Zones.RandomZone#source}.", "name": "source" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "'random'.", "name": "type" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleEmitterRandomZoneConfig", "scope": "static", "___id": "T000002R014874", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.GameObjects.Particles.ParticleSortCallback\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} a - The first Particle being compared.\r\n * @param {Phaser.GameObjects.Particles.Particle} b - The second Particle being compared.\r\n*/", "meta": { "filename": "ParticleSortCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "ParticleSortCallback", "type": { "names": [ "function" ] }, "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The first Particle being compared.", "name": "a" }, { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The second Particle being compared.", "name": "b" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.ParticleSortCallback", "scope": "static", "___id": "T000002R014875", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Particles.RandomZoneSource\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Types.GameObjects.Particles.RandomZoneSourceCallback} getRandomPoint - A function modifying its point argument.\r\n *\r\n * @see Phaser.Geom.Circle\r\n * @see Phaser.Geom.Ellipse\r\n * @see Phaser.Geom.Line\r\n * @see Phaser.Geom.Polygon\r\n * @see Phaser.Geom.Rectangle\r\n * @see Phaser.Geom.Triangle\r\n */", "meta": { "filename": "RandomZoneSource.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "RandomZoneSource", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.RandomZoneSourceCallback" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014876", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.GameObjects.Particles.RandomZoneSourceCallback\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} point - A point to modify.\r\n */", "meta": { "filename": "RandomZoneSourceCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\typedefs", "code": {} }, "kind": "typedef", "name": "RandomZoneSourceCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "A point to modify.", "name": "point" } ], "memberof": "Phaser.Types.GameObjects.Particles", "longname": "Phaser.Types.GameObjects.Particles.RandomZoneSourceCallback", "scope": "static", "___id": "T000002R014877", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Death Zone.\r\n *\r\n * A Death Zone is a special type of zone that will kill a Particle as soon as it either enters, or leaves, the zone.\r\n *\r\n * The zone consists of a `source` which could be a Geometric shape, such as a Rectangle or Ellipse, or your own\r\n * object as long as it includes a `contains` method for which the Particles can be tested against.\r\n *\r\n * @class DeathZone\r\n * @memberof Phaser.GameObjects.Particles.Zones\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.DeathZoneSource} source - An object instance that has a `contains` method that returns a boolean when given `x` and `y` arguments.\r\n * @param {boolean} killOnEnter - Should the Particle be killed when it enters the zone? `true` or leaves it? `false`\r\n */", "meta": { "filename": "DeathZone.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "classdesc": "A Death Zone.\r\rA Death Zone is a special type of zone that will kill a Particle as soon as it either enters, or leaves, the zone.\r\rThe zone consists of a `source` which could be a Geometric shape, such as a Rectangle or Ellipse, or your own\robject 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014879", "___s": true }, { "comment": "/**\r\n * An object instance that has a `contains` method that returns a boolean when given `x` and `y` arguments.\r\n * This could be a Geometry shape, such as `Phaser.Geom.Circle`, or your own custom object.\r\n *\r\n * @name Phaser.GameObjects.Particles.Zones.DeathZone#source\r\n * @type {Phaser.Types.GameObjects.Particles.DeathZoneSource}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DeathZone.js", "lineno": 32, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "An object instance that has a `contains` method that returns a boolean when given `x` and `y` arguments.\rThis could be a Geometry shape, such as `Phaser.Geom.Circle`, or your own custom object.", "name": "source", "type": { "names": [ "Phaser.Types.GameObjects.Particles.DeathZoneSource" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014882", "___s": true }, { "comment": "/**\r\n * Set to `true` if the Particle should be killed if it enters this zone.\r\n * Set to `false` to kill the Particle if it leaves this zone.\r\n *\r\n * @name Phaser.GameObjects.Particles.Zones.DeathZone#killOnEnter\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DeathZone.js", "lineno": 42, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "Set to `true` if the Particle should be killed if it enters this zone.\rSet to `false` to kill the Particle if it leaves this zone.", "name": "killOnEnter", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Zones.DeathZone", "longname": "Phaser.GameObjects.Particles.Zones.DeathZone#killOnEnter", "scope": "instance", "kind": "member", "___id": "T000002R014884", "___s": true }, { "comment": "/**\r\n * Checks if the given Particle will be killed or not by this zone.\r\n *\r\n * @method Phaser.GameObjects.Particles.Zones.DeathZone#willKill\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The particle to test against this Death Zone.\r\n *\r\n * @return {boolean} Return `true` if the Particle is to be killed, otherwise return `false`.\r\n */", "meta": { "filename": "DeathZone.js", "lineno": 53, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The particle to test against this Death Zone.", "name": "particle" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014886", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An Edge Zone is an emit zone for a Particle Emitter that places emitted particles\r\n * sequentially along the edges of a shape. The shape is defined by a source object\r\n * that provides a `getPoints(quantity, stepRate)` method, such as a Phaser Curve,\r\n * Path, or any compatible geometry object.\r\n *\r\n * As each particle is emitted, it is positioned at the next point along the shape's\r\n * edge, cycling through all points in order. If `yoyo` is enabled, the traversal\r\n * reverses direction when it reaches either end, creating a back-and-forth effect.\r\n * If `seamless` is enabled, duplicate endpoints are removed to avoid stacking\r\n * particles at the join when the shape loops back on itself.\r\n *\r\n * Use this zone when you want particles to trace or outline a shape — for example,\r\n * sparks running along a wire, particles orbiting a path, or effects that follow\r\n * the boundary of a geometric figure.\r\n *\r\n * @class EdgeZone\r\n * @memberof Phaser.GameObjects.Particles.Zones\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.EdgeZoneSource} source - An object instance with a `getPoints(quantity, stepRate)` method returning an array of points.\r\n * @param {number} quantity - The number of particles to place on the source edge. Set to 0 to use `stepRate` instead.\r\n * @param {number} [stepRate] - The distance between each particle. When set, `quantity` is implied and should be set to 0.\r\n * @param {boolean} [yoyo=false] - Whether particles are placed from start to end and then end to start.\r\n * @param {boolean} [seamless=true] - Whether one endpoint will be removed if it's identical to the other.\r\n * @param {number} [total=-1] - The total number of particles this zone will emit before passing over to the next emission zone in the Emitter. -1 means it will never pass over and you must use `setEmitZone` to change it.\r\n */", "meta": { "filename": "EdgeZone.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "classdesc": "An Edge Zone is an emit zone for a Particle Emitter that places emitted particles\rsequentially along the edges of a shape. The shape is defined by a source object\rthat provides a `getPoints(quantity, stepRate)` method, such as a Phaser Curve,\rPath, or any compatible geometry object.\r\rAs each particle is emitted, it is positioned at the next point along the shape's\redge, cycling through all points in order. If `yoyo` is enabled, the traversal\rreverses direction when it reaches either end, creating a back-and-forth effect.\rIf `seamless` is enabled, duplicate endpoints are removed to avoid stacking\rparticles at the join when the shape loops back on itself.\r\rUse this zone when you want particles to trace or outline a shape — for example,\rsparks running along a wire, particles orbiting a path, or effects that follow\rthe boundary of a geometric figure.", "kind": "class", "name": "EdgeZone", "memberof": "Phaser.GameObjects.Particles.Zones", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EdgeZoneSource" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EdgeZoneSource" } }, "description": "An object instance with a `getPoints(quantity, stepRate)` method returning an array of points.", "name": "source" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of particles to place on the source edge. Set to 0 to use `stepRate` instead.", "name": "quantity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether particles are placed from start to end and then end to start.", "name": "yoyo" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether one endpoint will be removed if it's identical to the other.", "name": "seamless" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": -1, "description": "The total number of particles this zone will emit before passing over to the next emission zone in the Emitter. -1 means it will never pass over and you must use `setEmitZone` to change it.", "name": "total" } ], "scope": "static", "longname": "Phaser.GameObjects.Particles.Zones.EdgeZone", "___id": "T000002R014892", "___s": true }, { "comment": "/**\r\n * An object instance with a `getPoints(quantity, stepRate)` method returning an array of points.\r\n *\r\n * @name Phaser.GameObjects.Particles.Zones.EdgeZone#source\r\n * @type {Phaser.Types.GameObjects.Particles.EdgeZoneSource|Phaser.Types.GameObjects.Particles.RandomZoneSource}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EdgeZone.js", "lineno": 48, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.EdgeZoneSource" }, { "type": "NameExpression", "name": "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", "___id": "T000002R014898", "___s": true }, { "comment": "/**\r\n * The points placed on the source edge.\r\n *\r\n * @name Phaser.GameObjects.Particles.Zones.EdgeZone#points\r\n * @type {Phaser.Math.Vector2[]}\r\n * @default []\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EdgeZone.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "The points placed on the source edge.", "name": "points", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Zones.EdgeZone", "longname": "Phaser.GameObjects.Particles.Zones.EdgeZone#points", "scope": "instance", "kind": "member", "___id": "T000002R014900", "___s": true }, { "comment": "/**\r\n * The number of particles to place on the source edge. Set to 0 to use `stepRate` instead.\r\n *\r\n * @name Phaser.GameObjects.Particles.Zones.EdgeZone#quantity\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EdgeZone.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "The number of particles to place on the source edge. Set to 0 to use `stepRate` instead.", "name": "quantity", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Zones.EdgeZone", "longname": "Phaser.GameObjects.Particles.Zones.EdgeZone#quantity", "scope": "instance", "kind": "member", "___id": "T000002R014902", "___s": true }, { "comment": "/**\r\n * The distance between each particle. When set, `quantity` is implied and should be set to 0.\r\n *\r\n * @name Phaser.GameObjects.Particles.Zones.EdgeZone#stepRate\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EdgeZone.js", "lineno": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "The distance between each particle. When set, `quantity` is implied and should be set to 0.", "name": "stepRate", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Zones.EdgeZone", "longname": "Phaser.GameObjects.Particles.Zones.EdgeZone#stepRate", "scope": "instance", "kind": "member", "___id": "T000002R014904", "___s": true }, { "comment": "/**\r\n * Whether particles are placed from start to end and then end to start.\r\n *\r\n * @name Phaser.GameObjects.Particles.Zones.EdgeZone#yoyo\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EdgeZone.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "Whether particles are placed from start to end and then end to start.", "name": "yoyo", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Zones.EdgeZone", "longname": "Phaser.GameObjects.Particles.Zones.EdgeZone#yoyo", "scope": "instance", "kind": "member", "___id": "T000002R014906", "___s": true }, { "comment": "/**\r\n * The counter used for iterating the EdgeZone's points.\r\n *\r\n * @name Phaser.GameObjects.Particles.Zones.EdgeZone#counter\r\n * @type {number}\r\n * @default -1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EdgeZone.js", "lineno": 94, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "The counter used for iterating the EdgeZone's points.", "name": "counter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Zones.EdgeZone", "longname": "Phaser.GameObjects.Particles.Zones.EdgeZone#counter", "scope": "instance", "kind": "member", "___id": "T000002R014908", "___s": true }, { "comment": "/**\r\n * Whether one endpoint will be removed if it's identical to the other.\r\n *\r\n * @name Phaser.GameObjects.Particles.Zones.EdgeZone#seamless\r\n * @type {boolean}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "EdgeZone.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "Whether one endpoint will be removed if it's identical to the other.", "name": "seamless", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Particles.Zones.EdgeZone", "longname": "Phaser.GameObjects.Particles.Zones.EdgeZone#seamless", "scope": "instance", "kind": "member", "___id": "T000002R014910", "___s": true }, { "comment": "/**\r\n * The total number of particles this zone will emit before the Emitter\r\n * transfers control over to the next zone in its emission zone list.\r\n *\r\n * By default this is -1, meaning it will never pass over from this\r\n * zone to another one. You can call the `ParticleEmitter.setEmitZone`\r\n * method to change it, or set this value to something else via the\r\n * config, or directly at runtime.\r\n *\r\n * A value of 1 would mean the zones rotate in order, but it can\r\n * be set to any integer value.\r\n *\r\n * @name Phaser.GameObjects.Particles.Zones.EdgeZone#total\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "EdgeZone.js", "lineno": 137, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "The total number of particles this zone will emit before the Emitter\rtransfers control over to the next zone in its emission zone list.\r\rBy default this is -1, meaning it will never pass over from this\rzone to another one. You can call the `ParticleEmitter.setEmitZone`\rmethod to change it, or set this value to something else via the\rconfig, or directly at runtime.\r\rA value of 1 would mean the zones rotate in order, but it can\rbe set to any integer value.", "name": "total", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.Zones.EdgeZone", "longname": "Phaser.GameObjects.Particles.Zones.EdgeZone#total", "scope": "instance", "kind": "member", "___id": "T000002R014916", "___s": true }, { "comment": "/**\r\n * Update the {@link Phaser.GameObjects.Particles.Zones.EdgeZone#points} from the EdgeZone's\r\n * {@link Phaser.GameObjects.Particles.Zones.EdgeZone#source}.\r\n *\r\n * Also updates internal properties.\r\n *\r\n * @method Phaser.GameObjects.Particles.Zones.EdgeZone#updateSource\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Edge Zone.\r\n */", "meta": { "filename": "EdgeZone.js", "lineno": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "Update the {@link Phaser.GameObjects.Particles.Zones.EdgeZone#points} from the EdgeZone's\r{@link Phaser.GameObjects.Particles.Zones.EdgeZone#source}.\r\rAlso updates internal properties.", "kind": "function", "name": "updateSource", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Edge Zone." } ], "memberof": "Phaser.GameObjects.Particles.Zones.EdgeZone", "longname": "Phaser.GameObjects.Particles.Zones.EdgeZone#updateSource", "scope": "instance", "___id": "T000002R014918", "___s": true }, { "comment": "/**\r\n * Change the source of the EdgeZone, replacing the existing shape with a new one.\r\n * The new source must provide a `getPoints(quantity, stepRate)` method. After\r\n * the source is replaced, `updateSource` is called automatically to regenerate\r\n * the edge points and reset internal state accordingly.\r\n *\r\n * @method Phaser.GameObjects.Particles.Zones.EdgeZone#changeSource\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.EdgeZoneSource} source - An object instance with a `getPoints(quantity, stepRate)` method returning an array of points.\r\n *\r\n * @return {this} This Edge Zone.\r\n */", "meta": { "filename": "EdgeZone.js", "lineno": 198, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "Change the source of the EdgeZone, replacing the existing shape with a new one.\rThe new source must provide a `getPoints(quantity, stepRate)` method. After\rthe source is replaced, `updateSource` is called automatically to regenerate\rthe edge points and reset internal state accordingly.", "kind": "function", "name": "changeSource", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.EdgeZoneSource" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Edge Zone." } ], "memberof": "Phaser.GameObjects.Particles.Zones.EdgeZone", "longname": "Phaser.GameObjects.Particles.Zones.EdgeZone#changeSource", "scope": "instance", "___id": "T000002R014926", "___s": true }, { "comment": "/**\r\n * Get the next point in the Zone and set its coordinates on the given Particle.\r\n *\r\n * Points are stepped through sequentially. When the end of the point list is\r\n * reached, the counter wraps back to the start, or reverses direction if `yoyo`\r\n * is enabled. Called automatically by the Particle Emitter each time a new\r\n * particle is emitted.\r\n *\r\n * @method Phaser.GameObjects.Particles.Zones.EdgeZone#getPoint\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The Particle.\r\n */", "meta": { "filename": "EdgeZone.js", "lineno": 218, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "Get the next point in the Zone and set its coordinates on the given Particle.\r\rPoints are stepped through sequentially. When the end of the point list is\rreached, the counter wraps back to the start, or reverses direction if `yoyo`\ris enabled. Called automatically by the Particle Emitter each time a new\rparticle is emitted.", "kind": "function", "name": "getPoint", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Particles.Particle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The Particle.", "name": "particle" } ], "memberof": "Phaser.GameObjects.Particles.Zones.EdgeZone", "longname": "Phaser.GameObjects.Particles.Zones.EdgeZone#getPoint", "scope": "instance", "___id": "T000002R014929", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.GameObjects.Particles.Zones\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "kind": "namespace", "name": "Zones", "memberof": "Phaser.GameObjects.Particles", "longname": "Phaser.GameObjects.Particles.Zones", "scope": "static", "___id": "T000002R014941", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Random Zone is an Emit Zone that places particles at random positions within the area of a\r\n * shape. The shape must provide a `getRandomPoint` method, which receives a Vector2 and populates\r\n * it with a random coordinate from anywhere inside the shape.\r\n *\r\n * Phaser geometry objects such as `Phaser.Geom.Rectangle`, `Phaser.Geom.Circle`,\r\n * `Phaser.Geom.Ellipse`, and `Phaser.Geom.Triangle` all implement this method and can be used\r\n * directly as the source for this zone.\r\n *\r\n * Use this zone when you want particles to spawn at random positions distributed across the\r\n * interior of a shape. To spawn particles along the edges of a shape instead, use an EdgeZone.\r\n *\r\n * @class RandomZone\r\n * @memberof Phaser.GameObjects.Particles.Zones\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Particles.RandomZoneSource} source - An object instance with a `getRandomPoint(point)` method.\r\n */", "meta": { "filename": "RandomZone.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "classdesc": "A Random Zone is an Emit Zone that places particles at random positions within the area of a\rshape. The shape must provide a `getRandomPoint` method, which receives a Vector2 and populates\rit with a random coordinate from anywhere inside the shape.\r\rPhaser geometry objects such as `Phaser.Geom.Rectangle`, `Phaser.Geom.Circle`,\r`Phaser.Geom.Ellipse`, and `Phaser.Geom.Triangle` all implement this method and can be used\rdirectly as the source for this zone.\r\rUse this zone when you want particles to spawn at random positions distributed across the\rinterior of a shape. To spawn particles along the edges of a shape instead, use an EdgeZone.", "kind": "class", "name": "RandomZone", "memberof": "Phaser.GameObjects.Particles.Zones", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Particles.RandomZoneSource" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Particles.RandomZoneSource" } }, "description": "An object instance with a `getRandomPoint(point)` method.", "name": "source" } ], "scope": "static", "longname": "Phaser.GameObjects.Particles.Zones.RandomZone", "___id": "T000002R014948", "___s": true }, { "comment": "/**\r\n * An object instance with a `getRandomPoint(point)` method.\r\n *\r\n * @name Phaser.GameObjects.Particles.Zones.RandomZone#source\r\n * @type {Phaser.Types.GameObjects.Particles.RandomZoneSource}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "RandomZone.js", "lineno": 36, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "An object instance with a `getRandomPoint(point)` method.", "name": "source", "type": { "names": [ "Phaser.Types.GameObjects.Particles.RandomZoneSource" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014951", "___s": true }, { "comment": "/**\r\n * The total number of particles this zone will emit before the Emitter\r\n * transfers control over to the next zone in its emission zone list.\r\n *\r\n * By default this is -1, meaning it will never pass over from this\r\n * zone to another one. You can call the `ParticleEmitter.setEmitZone`\r\n * method to change it, or set this value to something else via the\r\n * config, or directly at runtime.\r\n *\r\n * A value of 1 would mean the zones rotate in order, but it can\r\n * be set to any integer value.\r\n *\r\n * @name Phaser.GameObjects.Particles.Zones.RandomZone#total\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "RandomZone.js", "lineno": 55, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "description": "The total number of particles this zone will emit before the Emitter\rtransfers control over to the next zone in its emission zone list.\r\rBy default this is -1, meaning it will never pass over from this\rzone to another one. You can call the `ParticleEmitter.setEmitZone`\rmethod to change it, or set this value to something else via the\rconfig, or directly at runtime.\r\rA value of 1 would mean the zones rotate in order, but it can\rbe set to any integer value.", "name": "total", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Particles.Zones.RandomZone", "longname": "Phaser.GameObjects.Particles.Zones.RandomZone#total", "scope": "instance", "kind": "member", "___id": "T000002R014955", "___s": true }, { "comment": "/**\r\n * Get the next point in the Zone and set its coordinates on the given Particle.\r\n *\r\n * @method Phaser.GameObjects.Particles.Zones.RandomZone#getPoint\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Particles.Particle} particle - The Particle.\r\n */", "meta": { "filename": "RandomZone.js", "lineno": 74, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\particles\\zones", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Particles.Particle" } }, "description": "The Particle.", "name": "particle" } ], "memberof": "Phaser.GameObjects.Particles.Zones.RandomZone", "longname": "Phaser.GameObjects.Particles.Zones.RandomZone#getPoint", "scope": "instance", "___id": "T000002R014957", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A PathFollower is a Sprite that automatically moves along a {@link Phaser.Curves.Path}, making it ideal\r\n * for cutscenes, enemy patrol routes, moving platforms, projectile arcs, or any Game Object that should\r\n * travel a predefined course through the world.\r\n *\r\n * It extends Sprite, so everything available on a standard Sprite — animations, tinting, scaling,\r\n * alpha, blend modes, and so on — works identically here.\r\n *\r\n * A PathFollower is bound to a single Path at any one time and can traverse the full length of that\r\n * Path from start to finish, in either direction, or from any given point along it to the end.\r\n * Playback speed and duration are controlled via a tween-like configuration object passed to\r\n * `startFollow`. The follower can optionally rotate to face the direction of travel, be offset\r\n * from the path coordinates, or rotate independently of the Path.\r\n *\r\n * @class PathFollower\r\n * @extends Phaser.GameObjects.Sprite\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.GameObjects.Components.PathFollower\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this PathFollower belongs.\r\n * @param {Phaser.Curves.Path} path - The Path this PathFollower is following. It can only follow one Path at a time.\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pathfollower", "code": {} }, "classdesc": "A PathFollower is a Sprite that automatically moves along a {@link Phaser.Curves.Path}, making it ideal\rfor cutscenes, enemy patrol routes, moving platforms, projectile arcs, or any Game Object that should\rtravel a predefined course through the world.\r\rIt extends Sprite, so everything available on a standard Sprite — animations, tinting, scaling,\ralpha, blend modes, and so on — works identically here.\r\rA PathFollower is bound to a single Path at any one time and can traverse the full length of that\rPath from start to finish, in either direction, or from any given point along it to the end.\rPlayback speed and duration are controlled via a tween-like configuration object passed to\r`startFollow`. The follower can optionally rotate to face the direction of travel, be offset\rfrom 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this PathFollower belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.Curves.Path" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Curves.Path" } }, "description": "The Path this PathFollower is following. It can only follow one Path at a time.", "name": "path" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "scope": "static", "longname": "Phaser.GameObjects.PathFollower", "___id": "T000002R014966", "___s": true }, { "comment": "/**\r\n * Internal update handler that advances this PathFollower along the path.\r\n *\r\n * Called automatically by the Scene step, should not typically be called directly.\r\n *\r\n * @method Phaser.GameObjects.PathFollower#preUpdate\r\n * @protected\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current timestamp as generated by the Request Animation Frame or SetTimeout.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "PathFollower.js", "lineno": 58, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pathfollower", "code": {} }, "description": "Internal update handler that advances this PathFollower along the path.\r\rCalled automatically by the Scene step, should not typically be called directly.", "kind": "function", "name": "preUpdate", "access": "protected", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp as generated by the Request Animation Frame or SetTimeout.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time, in ms, elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.GameObjects.PathFollower", "longname": "Phaser.GameObjects.PathFollower#preUpdate", "scope": "instance", "overrides": "Phaser.GameObjects.Sprite#preUpdate", "___id": "T000002R014972", "___s": true }, { "comment": "/**\r\n * Creates a new PathFollower Game Object and adds it to the Scene.\r\n *\r\n * A PathFollower is a Sprite that is bound to a Phaser.Curves.Path and can automatically move along\r\n * that path over time. It is useful for animating characters or objects along predetermined routes,\r\n * such as enemies patrolling a level, vehicles following a road, or any game object that needs to\r\n * travel a curved or multi-segment course. The follower exposes controls to start, stop, pause, and\r\n * resume movement, as well as options for looping and rotation along the path.\r\n *\r\n * Note: This method will only be available if the PathFollower Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#follower\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Curves.Path} path - The Path this PathFollower is connected to.\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.GameObjects.PathFollower} The Game Object that was created.\r\n */", "meta": { "filename": "PathFollowerFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pathfollower", "code": {} }, "description": "Creates a new PathFollower Game Object and adds it to the Scene.\r\rA PathFollower is a Sprite that is bound to a Phaser.Curves.Path and can automatically move along\rthat path over time. It is useful for animating characters or objects along predetermined routes,\rsuch as enemies patrolling a level, vehicles following a road, or any game object that needs to\rtravel a curved or multi-segment course. The follower exposes controls to start, stop, pause, and\rresume movement, as well as options for looping and rotation along the path.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Curves.Path" } }, "description": "The Path this PathFollower is connected to.", "name": "path" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.PathFollower" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.PathFollower" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#follower", "scope": "instance", "___id": "T000002R014977", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.PathFollower\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pathfollower\\typedefs", "code": {} }, "kind": "namespace", "name": "PathFollower", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.PathFollower", "scope": "static", "___id": "T000002R014979", "___s": true }, { "comment": "/**\r\n * Settings for a PathFollower.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.PathFollower.PathConfig\r\n * @since 3.0.0\r\n *\r\n * @property {number} [duration=1000] - The duration of the path follow in ms. Must be `> 0`.\r\n * @property {number} [from=0] - The start position of the path follow, between 0 and 1. Must be less than `to`.\r\n * @property {number} [to=1] - The end position of the path follow, between 0 and 1. Must be more than `from`.\r\n * @property {boolean} [positionOnPath=false] - Whether to position the PathFollower on the Path using its path offset.\r\n * @property {boolean} [rotateToPath=false] - Should the PathFollower automatically rotate to point in the direction of the Path?\r\n * @property {number} [rotationOffset=0] - 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.\r\n * @property {number} [startAt=0] - Current start position of the path follow, must be between `from` and `to`.\r\n */", "meta": { "filename": "PathConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pathfollower\\typedefs", "code": {} }, "description": "Settings for a PathFollower.", "kind": "typedef", "name": "PathConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1000, "description": "The duration of the path follow in ms. Must be `> 0`.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to position the PathFollower on the Path using its path offset.", "name": "positionOnPath" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the PathFollower automatically rotate to point in the direction of the Path?", "name": "rotateToPath" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R014980", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Point Light Game Object provides a way to add a point light effect into your game,\r\n * without the expensive shader processing requirements of the traditional Light Game Object.\r\n *\r\n * The difference is that the Point Light renders using a custom shader, designed to give the\r\n * impression of a point light source, of variable radius, intensity and color, in your game.\r\n * However, unlike the Light Game Object, it does not impact any other Game Objects, or use their\r\n * normal maps for calculations. This makes them extremely fast to render compared to Lights\r\n * and perfect for special effects, such as flickering torches or muzzle flashes.\r\n *\r\n * For maximum performance you should batch Point Light Game Objects together. This means\r\n * ensuring they follow each other consecutively on the display list. Ideally, use a Layer\r\n * Game Object and then add just Point Lights to it, so that it can batch together the rendering\r\n * of the lights. You don't _have_ to do this, and if you've only a handful of Point Lights in\r\n * your game then it's perfectly safe to mix them into the display list as normal. However, if\r\n * you're using a large number of them, please consider how they are mixed into the display list.\r\n *\r\n * The renderer will automatically cull Point Lights. Those with a radius that does not intersect\r\n * with the Camera will be skipped in the rendering list. This happens automatically and the\r\n * culled state is refreshed every frame, for every camera.\r\n *\r\n * The origin of a Point Light is always 0.5 and it cannot be changed.\r\n *\r\n * Point Lights are a WebGL only feature and do not have a Canvas counterpart.\r\n *\r\n * @class PointLight\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @extends Phaser.GameObjects.Components.AlphaSingle\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.GetBounds\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Point Light belongs. A Point Light can only belong to one Scene at a time.\r\n * @param {number} x - The horizontal position of this Point Light in the world.\r\n * @param {number} y - The vertical position of this Point Light in the world.\r\n * @param {number} [color=0xffffff] - The color of the Point Light, given as a hex value.\r\n * @param {number} [radius=128] - The radius of the Point Light.\r\n * @param {number} [intensity=1] - The intensity, or color blend, of the Point Light.\r\n * @param {number} [attenuation=0.1] - The attenuation of the Point Light. This is the reduction of light from the center point.\r\n */", "meta": { "filename": "PointLight.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pointlight", "code": {} }, "classdesc": "The Point Light Game Object provides a way to add a point light effect into your game,\rwithout the expensive shader processing requirements of the traditional Light Game Object.\r\rThe difference is that the Point Light renders using a custom shader, designed to give the\rimpression of a point light source, of variable radius, intensity and color, in your game.\rHowever, unlike the Light Game Object, it does not impact any other Game Objects, or use their\rnormal maps for calculations. This makes them extremely fast to render compared to Lights\rand perfect for special effects, such as flickering torches or muzzle flashes.\r\rFor maximum performance you should batch Point Light Game Objects together. This means\rensuring they follow each other consecutively on the display list. Ideally, use a Layer\rGame Object and then add just Point Lights to it, so that it can batch together the rendering\rof the lights. You don't _have_ to do this, and if you've only a handful of Point Lights in\ryour game then it's perfectly safe to mix them into the display list as normal. However, if\ryou're using a large number of them, please consider how they are mixed into the display list.\r\rThe renderer will automatically cull Point Lights. Those with a radius that does not intersect\rwith the Camera will be skipped in the rendering list. This happens automatically and the\rculled state is refreshed every frame, for every camera.\r\rThe origin of a Point Light is always 0.5 and it cannot be changed.\r\rPoint Lights are a WebGL only feature and do not have a Canvas counterpart.", "kind": "class", "name": "PointLight", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.AlphaSingle", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.RenderNodes", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.GameObjects", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Point Light belongs. A Point Light can only belong to one Scene at a time.", "name": "scene" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Point Light in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Point Light in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color of the Point Light, given as a hex value.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The radius of the Point Light.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The intensity, or color blend, of the Point Light.", "name": "intensity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "The attenuation of the Point Light. This is the reduction of light from the center point.", "name": "attenuation" } ], "scope": "static", "longname": "Phaser.GameObjects.PointLight", "___id": "T000002R014987", "___s": true }, { "comment": "/**\r\n * The color of this Point Light. This property is an instance of a\r\n * Color object, so you can use the methods within it, such as `setTo(r, g, b)`\r\n * to change the color value.\r\n *\r\n * @name Phaser.GameObjects.PointLight#color\r\n * @type {Phaser.Display.Color}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PointLight.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pointlight", "code": {} }, "description": "The color of this Point Light. This property is an instance of a\rColor object, so you can use the methods within it, such as `setTo(r, g, b)`\rto change the color value.", "name": "color", "type": { "names": [ "Phaser.Display.Color" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Display.Color" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.PointLight", "longname": "Phaser.GameObjects.PointLight#color", "scope": "instance", "kind": "member", "___id": "T000002R014996", "___s": true }, { "comment": "/**\r\n * The intensity of the Point Light.\r\n *\r\n * The colors of the light are multiplied by this value during rendering.\r\n *\r\n * @name Phaser.GameObjects.PointLight#intensity\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PointLight.js", "lineno": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pointlight", "code": {} }, "description": "The intensity of the Point Light.\r\rThe colors of the light are multiplied by this value during rendering.", "name": "intensity", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.PointLight", "longname": "Phaser.GameObjects.PointLight#intensity", "scope": "instance", "kind": "member", "___id": "T000002R014998", "___s": true }, { "comment": "/**\r\n * The attenuation of the Point Light.\r\n *\r\n * This value controls the force with which the light falls-off from the center of the light.\r\n *\r\n * Use small float-based values, i.e. 0.1.\r\n *\r\n * @name Phaser.GameObjects.PointLight#attenuation\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PointLight.js", "lineno": 117, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pointlight", "code": {} }, "description": "The attenuation of the Point Light.\r\rThis value controls the force with which the light falls-off from the center of the light.\r\rUse small float-based values, i.e. 0.1.", "name": "attenuation", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.PointLight", "longname": "Phaser.GameObjects.PointLight#attenuation", "scope": "instance", "kind": "member", "___id": "T000002R015000", "___s": true }, { "comment": "/**\r\n * The radius of the Point Light, in pixels. Changing this value also updates\r\n * the `width` and `height` properties of this Game Object to `radius * 2`.\r\n *\r\n * @name Phaser.GameObjects.PointLight#radius\r\n * @type {number}\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PointLight.js", "lineno": 154, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pointlight", "code": {} }, "description": "The radius of the Point Light, in pixels. Changing this value also updates\rthe `width` and `height` properties of this Game Object to `radius * 2`.", "name": "radius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.50.0", "memberof": "Phaser.GameObjects.PointLight", "longname": "Phaser.GameObjects.PointLight#radius", "scope": "instance", "kind": "member", "___id": "T000002R015008", "___s": true }, { "comment": "/**\r\n * The horizontal origin of this Point Light. This is always fixed at 0.5 and cannot be changed.\r\n *\r\n * @name Phaser.GameObjects.PointLight#originX\r\n * @type {number}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PointLight.js", "lineno": 178, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pointlight", "code": {} }, "description": "The horizontal origin of this Point Light. This is always fixed at 0.5 and cannot be changed.", "name": "originX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.GameObjects.PointLight", "longname": "Phaser.GameObjects.PointLight#originX", "scope": "instance", "kind": "member", "___id": "T000002R015015", "___s": true }, { "comment": "/**\r\n * The vertical origin of this Point Light. This is always fixed at 0.5 and cannot be changed.\r\n *\r\n * @name Phaser.GameObjects.PointLight#originY\r\n * @type {number}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PointLight.js", "lineno": 195, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pointlight", "code": {} }, "description": "The vertical origin of this Point Light. This is always fixed at 0.5 and cannot be changed.", "name": "originY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.GameObjects.PointLight", "longname": "Phaser.GameObjects.PointLight#originY", "scope": "instance", "kind": "member", "___id": "T000002R015018", "___s": true }, { "comment": "/**\r\n * The horizontal display origin of this Point Light, in pixels. This is equal to the radius of the light.\r\n *\r\n * @name Phaser.GameObjects.PointLight#displayOriginX\r\n * @type {number}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PointLight.js", "lineno": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pointlight", "code": {} }, "description": "The horizontal display origin of this Point Light, in pixels. This is equal to the radius of the light.", "name": "displayOriginX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.GameObjects.PointLight", "longname": "Phaser.GameObjects.PointLight#displayOriginX", "scope": "instance", "kind": "member", "___id": "T000002R015021", "___s": true }, { "comment": "/**\r\n * The vertical display origin of this Point Light, in pixels. This is equal to the radius of the light.\r\n *\r\n * @name Phaser.GameObjects.PointLight#displayOriginY\r\n * @type {number}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "PointLight.js", "lineno": 229, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pointlight", "code": {} }, "description": "The vertical display origin of this Point Light, in pixels. This is equal to the radius of the light.", "name": "displayOriginY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.GameObjects.PointLight", "longname": "Phaser.GameObjects.PointLight#displayOriginY", "scope": "instance", "kind": "member", "___id": "T000002R015024", "___s": true }, { "comment": "/**\r\n * Creates a new Point Light Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Point Light Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#pointlight\r\n * @since 3.50.0\r\n *\r\n * @param {object} config - The configuration object this Game Object will use to create itself. Supported properties include `color` (hex color of the light, default `0xffffff`), `radius` (radius of the light in pixels, default `128`), `intensity` (brightness of the light, default `1`), and `attenuation` (rate at which the light falls off toward the edges, default `0.1`).\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.PointLight} The Game Object that was created.\r\n */", "meta": { "filename": "PointLightCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pointlight", "code": {} }, "description": "Creates a new Point Light Game Object and returns it.\r\rNote: This method will only be available if the Point Light Game Object has been built into Phaser.", "kind": "function", "name": "pointlight", "since": "3.50.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The configuration object this Game Object will use to create itself. Supported properties include `color` (hex color of the light, default `0xffffff`), `radius` (radius of the light in pixels, default `128`), `intensity` (brightness of the light, default `1`), and `attenuation` (rate at which the light falls off toward the edges, default `0.1`).", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.PointLight" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.PointLight" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#pointlight", "scope": "instance", "___id": "T000002R015032", "___s": true }, { "comment": "/**\r\n * Creates a new Point Light Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Point Light Game Object has been built into Phaser.\r\n *\r\n * The Point Light Game Object provides a way to add a point light effect into your game,\r\n * without the expensive shader processing requirements of the traditional Light Game Object.\r\n *\r\n * The difference is that the Point Light renders using a custom shader, designed to give the\r\n * impression of a point light source, of variable radius, intensity and color, in your game.\r\n * However, unlike the Light Game Object, it does not impact any other Game Objects, or use their\r\n * normal maps for calculations. This makes them extremely fast to render compared to Lights\r\n * and perfect for special effects, such as flickering torches or muzzle flashes.\r\n *\r\n * For maximum performance you should batch Point Light Game Objects together. This means\r\n * ensuring they follow each other consecutively on the display list. Ideally, use a Layer\r\n * Game Object and then add just Point Lights to it, so that it can batch together the rendering\r\n * of the lights. You don't _have_ to do this, and if you've only a handful of Point Lights in\r\n * your game then it's perfectly safe to mix them into the display list as normal. However, if\r\n * you're using a large number of them, please consider how they are mixed into the display list.\r\n *\r\n * The renderer will automatically cull Point Lights. Those with a radius that does not intersect\r\n * with the Camera will be skipped in the rendering list. This happens automatically and the\r\n * culled state is refreshed every frame, for every camera.\r\n *\r\n * The origin of a Point Light is always 0.5 and it cannot be changed.\r\n *\r\n * Point Lights are a WebGL only feature and do not have a Canvas counterpart.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#pointlight\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The horizontal position of this Point Light in the world.\r\n * @param {number} y - The vertical position of this Point Light in the world.\r\n * @param {number} [color=0xffffff] - The color of the Point Light, given as a hex value.\r\n * @param {number} [radius=128] - The radius of the Point Light.\r\n * @param {number} [intensity=1] - The intensity, or color blend, of the Point Light.\r\n * @param {number} [attenuation=0.1] - The attenuation of the Point Light. This is the reduction of light from the center point.\r\n *\r\n * @return {Phaser.GameObjects.PointLight} The Game Object that was created.\r\n */", "meta": { "filename": "PointLightFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\pointlight", "code": {} }, "description": "Creates a new Point Light Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Point Light Game Object has been built into Phaser.\r\rThe Point Light Game Object provides a way to add a point light effect into your game,\rwithout the expensive shader processing requirements of the traditional Light Game Object.\r\rThe difference is that the Point Light renders using a custom shader, designed to give the\rimpression of a point light source, of variable radius, intensity and color, in your game.\rHowever, unlike the Light Game Object, it does not impact any other Game Objects, or use their\rnormal maps for calculations. This makes them extremely fast to render compared to Lights\rand perfect for special effects, such as flickering torches or muzzle flashes.\r\rFor maximum performance you should batch Point Light Game Objects together. This means\rensuring they follow each other consecutively on the display list. Ideally, use a Layer\rGame Object and then add just Point Lights to it, so that it can batch together the rendering\rof the lights. You don't _have_ to do this, and if you've only a handful of Point Lights in\ryour game then it's perfectly safe to mix them into the display list as normal. However, if\ryou're using a large number of them, please consider how they are mixed into the display list.\r\rThe renderer will automatically cull Point Lights. Those with a radius that does not intersect\rwith the Camera will be skipped in the rendering list. This happens automatically and the\rculled state is refreshed every frame, for every camera.\r\rThe origin of a Point Light is always 0.5 and it cannot be changed.\r\rPoint Lights are a WebGL only feature and do not have a Canvas counterpart.", "kind": "function", "name": "pointlight", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Point Light in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Point Light in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The color of the Point Light, given as a hex value.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The radius of the Point Light.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The intensity, or color blend, of the Point Light.", "name": "intensity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0.1, "description": "The attenuation of the Point Light. This is the reduction of light from the center point.", "name": "attenuation" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.PointLight" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.PointLight" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#pointlight", "scope": "instance", "___id": "T000002R015042", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Render Texture is a combination of Dynamic Texture and an Image Game Object, that uses the\r\n * Dynamic Texture to display itself with.\r\n *\r\n * A Dynamic Texture is a special texture that allows you to draw textures, frames and most kind of\r\n * Game Objects directly to it.\r\n *\r\n * You can take many complex objects and draw them to this one texture, which can then be used as the\r\n * base texture for other Game Objects, such as Sprites. Should you then update this texture, all\r\n * Game Objects using it will instantly be updated as well, reflecting the changes immediately.\r\n *\r\n * It's a powerful way to generate dynamic textures at run-time that are WebGL friendly and don't invoke\r\n * expensive GPU uploads on each change.\r\n *\r\n * In versions of Phaser before 3.60 a Render Texture was the only way you could create a texture\r\n * like this, that had the ability to be drawn on. But in 3.60 we split the core functions out to\r\n * the Dynamic Texture class as it made a lot more sense for them to reside in there. As a result,\r\n * the Render Texture is now a light-weight shim that sits on-top of an Image Game Object and offers\r\n * proxy methods to the features available from a Dynamic Texture.\r\n *\r\n * **When should you use a Render Texture vs. a Dynamic Texture?**\r\n *\r\n * You should use a Dynamic Texture if the texture is going to be used by multiple Game Objects,\r\n * or you want to use it across multiple Scenes, because textures are globally stored.\r\n *\r\n * You should use a Dynamic Texture if the texture isn't going to be displayed in-game, but is\r\n * instead going to be used for something like a mask or shader.\r\n *\r\n * You should use a Render Texture if you need to display the texture in-game on a single Game Object,\r\n * as it provides the convenience of wrapping an Image and Dynamic Texture together for you.\r\n *\r\n * Under WebGL1, a FrameBuffer, which is what this Dynamic Texture uses internally, cannot be anti-aliased.\r\n * This means that when drawing objects such as Shapes or Graphics instances to this texture, they may appear\r\n * to be drawn with no aliasing around the edges. This is a technical limitation of WebGL1. To get around it,\r\n * create your shape as a texture in an art package, then draw that to this texture.\r\n *\r\n * If you activate mipmap support in your game, it will not automatically\r\n * be applied to DynamicTextures.\r\n * This is because regenerating the mipmap for a texture\r\n * costs over 10 microseconds, a big performance loss for a single frame.\r\n * If you want to render your DynamicTextures with mipmaps,\r\n * you must also activate the render config option `mipmapRegeneration`.\r\n *\r\n * In the event that the WebGL context is lost, this DynamicTexture will\r\n * lose its contents. Once context is restored (signalled by the `restorewebgl`\r\n * event), you can choose to redraw the contents of the DynamicTexture.\r\n * You are responsible for the redrawing logic.\r\n *\r\n * @class RenderTexture\r\n * @extends Phaser.GameObjects.Image\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.2.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=32] - The width of the Render Texture.\r\n * @param {number} [height=32] - The height of the Render Texture.\r\n * @param {boolean} [forceEven=true] - Force the given width and height to be rounded to even values. This significantly improves the rendering quality. Set to false if you know you need an odd sized texture.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "classdesc": "A Render Texture is a combination of Dynamic Texture and an Image Game Object, that uses the\rDynamic Texture to display itself with.\r\rA Dynamic Texture is a special texture that allows you to draw textures, frames and most kind of\rGame Objects directly to it.\r\rYou can take many complex objects and draw them to this one texture, which can then be used as the\rbase texture for other Game Objects, such as Sprites. Should you then update this texture, all\rGame Objects using it will instantly be updated as well, reflecting the changes immediately.\r\rIt's a powerful way to generate dynamic textures at run-time that are WebGL friendly and don't invoke\rexpensive GPU uploads on each change.\r\rIn versions of Phaser before 3.60 a Render Texture was the only way you could create a texture\rlike this, that had the ability to be drawn on. But in 3.60 we split the core functions out to\rthe Dynamic Texture class as it made a lot more sense for them to reside in there. As a result,\rthe Render Texture is now a light-weight shim that sits on-top of an Image Game Object and offers\rproxy methods to the features available from a Dynamic Texture.\r\r**When should you use a Render Texture vs. a Dynamic Texture?**\r\rYou should use a Dynamic Texture if the texture is going to be used by multiple Game Objects,\ror you want to use it across multiple Scenes, because textures are globally stored.\r\rYou should use a Dynamic Texture if the texture isn't going to be displayed in-game, but is\rinstead going to be used for something like a mask or shader.\r\rYou should use a Render Texture if you need to display the texture in-game on a single Game Object,\ras it provides the convenience of wrapping an Image and Dynamic Texture together for you.\r\rUnder WebGL1, a FrameBuffer, which is what this Dynamic Texture uses internally, cannot be anti-aliased.\rThis means that when drawing objects such as Shapes or Graphics instances to this texture, they may appear\rto be drawn with no aliasing around the edges. This is a technical limitation of WebGL1. To get around it,\rcreate your shape as a texture in an art package, then draw that to this texture.\r\rIf you activate mipmap support in your game, it will not automatically\rbe applied to DynamicTextures.\rThis is because regenerating the mipmap for a texture\rcosts over 10 microseconds, a big performance loss for a single frame.\rIf you want to render your DynamicTextures with mipmaps,\ryou must also activate the render config option `mipmapRegeneration`.\r\rIn the event that the WebGL context is lost, this DynamicTexture will\rlose its contents. Once context is restored (signalled by the `restorewebgl`\revent), you can choose to redraw the contents of the DynamicTexture.\rYou are responsible for the redrawing logic.", "kind": "class", "name": "RenderTexture", "augments": [ "Phaser.GameObjects.Image" ], "memberof": "Phaser.GameObjects", "since": "3.2.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The width of the Render Texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The height of the Render Texture.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Force the given width and height to be rounded to even values. This significantly improves the rendering quality. Set to false if you know you need an odd sized texture.", "name": "forceEven" } ], "scope": "static", "longname": "Phaser.GameObjects.RenderTexture", "___id": "T000002R015077", "___s": true }, { "comment": "/**\r\n * An internal Camera that can be used to move around this Render Texture.\r\n *\r\n * Control it just like you would any Scene Camera. The difference is that it only impacts\r\n * the placement of Game Objects that you then draw to this texture.\r\n *\r\n * You can scroll, zoom and rotate this Camera.\r\n *\r\n * This property is a reference to `RenderTexture.texture.camera`.\r\n *\r\n * @name Phaser.GameObjects.RenderTexture#camera\r\n * @type {Phaser.Cameras.Scene2D.BaseCamera}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 99, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "An internal Camera that can be used to move around this Render Texture.\r\rControl it just like you would any Scene Camera. The difference is that it only impacts\rthe placement of Game Objects that you then draw to this texture.\r\rYou can scroll, zoom and rotate this Camera.\r\rThis property is a reference to `RenderTexture.texture.camera`.", "name": "camera", "type": { "names": [ "Phaser.Cameras.Scene2D.BaseCamera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.BaseCamera" } }, "since": "3.12.0", "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#camera", "scope": "instance", "kind": "member", "___id": "T000002R015089", "___s": true }, { "comment": "/**\r\n * The render mode of this Render Texture.\r\n * Set this property to change how the Render Texture is rendered.\r\n *\r\n * - 'render' mode draws the contents of the Render Texture to each frame.\r\n * - 'redraw' mode calls `render()` and redraws the texture every frame,\r\n * but does not render itself. This is useful for updating textures\r\n * for reuse by other objects.\r\n * - 'all' mode calls `render()` then draws the texture to the frame.\r\n *\r\n * @name Phaser.GameObjects.RenderTexture#renderMode\r\n * @type {'render'|'redraw'|'all'}\r\n * @default 'render'\r\n * @since 4.0.0\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "The render mode of this Render Texture.\rSet this property to change how the Render Texture is rendered.\r\r- 'render' mode draws the contents of the Render Texture to each frame.\r- 'redraw' mode calls `render()` and redraws the texture every frame,\r but does not render itself. This is useful for updating textures\r for reuse by other objects.\r- 'all' mode calls `render()` then draws the texture to the frame.", "name": "renderMode", "type": { "names": [ "'render'", "'redraw'", "'all'" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "'render'" }, { "type": "NameExpression", "name": "'redraw'" }, { "type": "NameExpression", "name": "'all'" } ] } }, "defaultvalue": "'render'", "since": "4.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#renderMode", "scope": "instance", "kind": "member", "___id": "T000002R015093", "___s": true }, { "comment": "/**\r\n * Whether this RenderTexture is currently executing `renderWebGL`.\r\n * This is used to prevent infinite loops when drawing containers.\r\n * You should not set this property directly.\r\n *\r\n * @name Phaser.GameObjects.RenderTexture#isCurrentlyRendering\r\n * @type {boolean}\r\n * @readonly\r\n * @since 4.0.0\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Whether this RenderTexture is currently executing `renderWebGL`.\rThis is used to prevent infinite loops when drawing containers.\rYou should not set this property directly.", "name": "isCurrentlyRendering", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "4.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#isCurrentlyRendering", "scope": "instance", "kind": "member", "___id": "T000002R015095", "___s": true }, { "comment": "/**\r\n * Sets the internal size of this Render Texture, as used for frame or physics body creation.\r\n *\r\n * This will not change the size that the Game Object is rendered in-game.\r\n * For that you need to either set the scale of the Game Object (`setScale`) or call the\r\n * `setDisplaySize` method, which is the same thing as changing the scale but allows you\r\n * to do so by giving pixel values. You could also call the `resize` method, as that\r\n * will resize the underlying texture.\r\n *\r\n * If you have enabled this Game Object for input, changing the size will also change the\r\n * size of the hit area, unless you have defined a custom hit area.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#setSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width of this Game Object.\r\n * @param {number} height - The height of this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 155, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Sets the internal size of this Render Texture, as used for frame or physics body creation.\r\rThis will not change the size that the Game Object is rendered in-game.\rFor that you need to either set the scale of the Game Object (`setScale`) or call the\r`setDisplaySize` method, which is the same thing as changing the scale but allows you\rto do so by giving pixel values. You could also call the `resize` method, as that\rwill resize the underlying texture.\r\rIf you have enabled this Game Object for input, changing the size will also change the\rsize of the hit area, unless you have defined a custom hit area.", "kind": "function", "name": "setSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#setSize", "scope": "instance", "overrides": "Phaser.GameObjects.Image#setSize", "___id": "T000002R015097", "___s": true }, { "comment": "/**\r\n * Resizes the Render Texture to the new dimensions given.\r\n *\r\n * In WebGL it will destroy and then re-create the frame buffer being used by the Render Texture.\r\n * In Canvas it will resize the underlying canvas element.\r\n *\r\n * Both approaches will erase everything currently drawn to the Render Texture.\r\n *\r\n * Calling this will then invoke the `setSize` method, setting the internal size of this Game Object\r\n * to the values given to this method.\r\n *\r\n * Calling this will then invoke the `setSize` method, setting the internal size of this Game Object\r\n * to the values given to this method.\r\n *\r\n * If the dimensions given are the same as those already being used, calling this method will do nothing.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#resize\r\n * @since 3.10.0\r\n *\r\n * @param {number} width - The new width of the Render Texture.\r\n * @param {number} [height=width] - The new height of the Render Texture. If not specified, will be set the same as the `width`.\r\n * @param {boolean} [forceEven=true] - Force the given width and height to be rounded to even values. This significantly improves the rendering quality. Set to false if you know you need an odd sized texture.\r\n *\r\n * @return {this} This Render Texture.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 193, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Resizes the Render Texture to the new dimensions given.\r\rIn WebGL it will destroy and then re-create the frame buffer being used by the Render Texture.\rIn Canvas it will resize the underlying canvas element.\r\rBoth approaches will erase everything currently drawn to the Render Texture.\r\rCalling this will then invoke the `setSize` method, setting the internal size of this Game Object\rto the values given to this method.\r\rCalling this will then invoke the `setSize` method, setting the internal size of this Game Object\rto the values given to this method.\r\rIf 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new width of the Render Texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Force the given width and height to be rounded to even values. This significantly improves the rendering quality. Set to false if you know you need an odd sized texture.", "name": "forceEven" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#resize", "scope": "instance", "___id": "T000002R015104", "___s": true }, { "comment": "/**\r\n * Stores a copy of this Render Texture in the Texture Manager using the given key.\r\n *\r\n * After doing this, any texture based Game Object, such as a Sprite, can use the contents of this\r\n * Render Texture by using the texture key:\r\n *\r\n * ```javascript\r\n * var rt = this.add.renderTexture(0, 0, 128, 128);\r\n *\r\n * // Draw something to the Render Texture\r\n *\r\n * rt.saveTexture('doodle');\r\n *\r\n * this.add.image(400, 300, 'doodle');\r\n * ```\r\n *\r\n * Updating the contents of this Render Texture will automatically update _any_ Game Object\r\n * that is using it as a texture. Calling `saveTexture` again will not save another copy\r\n * of the same texture, it will just rename the key of the existing copy.\r\n *\r\n * By default it will create a single base texture. You can add frames to the texture\r\n * by using the `Texture.add` method. After doing this, you can then allow Game Objects\r\n * to use a specific frame from a Render Texture.\r\n *\r\n * If you destroy this Render Texture, any Game Object using it via the Texture Manager will\r\n * stop rendering. Ensure you remove the texture from the Texture Manager and any Game Objects\r\n * using it first, before destroying this Render Texture.\r\n *\r\n * Note that the texture is assigned a random key on creation.\r\n * This key will be replaced with the new key.\r\n * If the texture was previously removed from the texture manager,\r\n * it will be added back so it can be reused.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#saveTexture\r\n * @since 3.12.0\r\n *\r\n * @param {string} key - The unique key to store the texture as within the global Texture Manager.\r\n *\r\n * @return {Phaser.Textures.DynamicTexture} The Texture that was saved.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Stores a copy of this Render Texture in the Texture Manager using the given key.\r\rAfter doing this, any texture based Game Object, such as a Sprite, can use the contents of this\rRender Texture by using the texture key:\r\r```javascript\rvar rt = this.add.renderTexture(0, 0, 128, 128);\r\r// Draw something to the Render Texture\r\rrt.saveTexture('doodle');\r\rthis.add.image(400, 300, 'doodle');\r```\r\rUpdating the contents of this Render Texture will automatically update _any_ Game Object\rthat is using it as a texture. Calling `saveTexture` again will not save another copy\rof the same texture, it will just rename the key of the existing copy.\r\rBy default it will create a single base texture. You can add frames to the texture\rby using the `Texture.add` method. After doing this, you can then allow Game Objects\rto use a specific frame from a Render Texture.\r\rIf you destroy this Render Texture, any Game Object using it via the Texture Manager will\rstop rendering. Ensure you remove the texture from the Texture Manager and any Game Objects\rusing it first, before destroying this Render Texture.\r\rNote that the texture is assigned a random key on creation.\rThis key will be replaced with the new key.\rIf the texture was previously removed from the texture manager,\rit will be added back so it can be reused.", "kind": "function", "name": "saveTexture", "since": "3.12.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key to store the texture as within the global Texture Manager.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.DynamicTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.DynamicTexture" } }, "description": "The Texture that was saved." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#saveTexture", "scope": "instance", "___id": "T000002R015106", "___s": true }, { "comment": "/**\r\n * Set the `renderMode` of this Render Texture.\r\n * Set this to change how the Render Texture is rendered.\r\n *\r\n * - 'render' mode draws the contents of the Render Texture to each frame.\r\n * - 'redraw' mode calls `render()` and redraws the texture every frame,\r\n * but does not render itself. This is useful for updating textures\r\n * for reuse by other objects.\r\n * - 'all' mode calls `render()` then draws the texture to the frame.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#setRenderMode\r\n * @since 4.0.0\r\n * @param {'render'|'redraw'|'all'} mode - The render mode to set.\r\n * @param {boolean} [preserve=false] - Whether to call `preserve(true)` to preserve the current command buffer.\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 291, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Set the `renderMode` of this Render Texture.\rSet this to change how the Render Texture is rendered.\r\r- 'render' mode draws the contents of the Render Texture to each frame.\r- 'redraw' mode calls `render()` and redraws the texture every frame,\r but does not render itself. This is useful for updating textures\r for reuse by other objects.\r- 'all' mode calls `render()` then draws the texture to the frame.", "kind": "function", "name": "setRenderMode", "since": "4.0.0", "params": [ { "type": { "names": [ "'render'", "'redraw'", "'all'" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "'render'" }, { "type": "NameExpression", "name": "'redraw'" }, { "type": "NameExpression", "name": "'all'" } ] } }, "description": "The render mode to set.", "name": "mode" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to call `preserve(true)` to preserve the current command buffer.", "name": "preserve" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#setRenderMode", "scope": "instance", "___id": "T000002R015114", "___s": true }, { "comment": "/**\r\n * Render the buffered drawing commands to this Dynamic Texture.\r\n * You must do this in order to see anything drawn to it.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#render\r\n * @since 4.0.0\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 319, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Render the buffered drawing commands to this Dynamic Texture.\rYou must do this in order to see anything drawn to it.", "kind": "function", "name": "render", "since": "4.0.0", "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#render", "scope": "instance", "___id": "T000002R015117", "___s": true }, { "comment": "/**\r\n * Fills this Render Texture with the given color.\r\n *\r\n * By default it will fill the entire texture, however you can set it to fill a specific\r\n * rectangular area by using the x, y, width and height arguments.\r\n *\r\n * The color should be given in hex format, i.e. 0xff0000 for red, 0x00ff00 for green, etc.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#fill\r\n * @since 3.2.0\r\n *\r\n * @param {number} rgb - The color to fill this Render Texture with, such as 0xff0000 for red.\r\n * @param {number} [alpha=1] - The alpha value used by the fill.\r\n * @param {number} [x=0] - The left coordinate of the fill rectangle.\r\n * @param {number} [y=0] - The top coordinate of the fill rectangle.\r\n * @param {number} [width=this.width] - The width of the fill rectangle.\r\n * @param {number} [height=this.height] - The height of the fill rectangle.\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 333, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Fills this Render Texture with the given color.\r\rBy default it will fill the entire texture, however you can set it to fill a specific\rrectangular area by using the x, y, width and height arguments.\r\rThe color should be given in hex format, i.e. 0xff0000 for red, 0x00ff00 for green, etc.", "kind": "function", "name": "fill", "since": "3.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The color to fill this Render Texture with, such as 0xff0000 for red.", "name": "rgb" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha value used by the fill.", "name": "alpha" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The left coordinate of the fill rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The top coordinate of the fill rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.width", "description": "The width of the fill rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.height", "description": "The height of the fill rectangle.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#fill", "scope": "instance", "___id": "T000002R015119", "___s": true }, { "comment": "/**\r\n * Clears a portion or everything from this Render Texture by erasing it and resetting it back to\r\n * a blank, transparent, texture. To clear an area, specify the `x`, `y`, `width` and `height`.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#clear\r\n * @since 3.2.0\r\n *\r\n * @param {number} [x=0] - The left coordinate of the clear rectangle.\r\n * @param {number} [y=0] - The top coordinate of the clear rectangle.\r\n * @param {number} [width=this.width] - The width of the clear rectangle.\r\n * @param {number} [height=this.height] - The height of the clear rectangle.\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 360, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Clears a portion or everything from this Render Texture by erasing it and resetting it back to\ra blank, transparent, texture. To clear an area, specify the `x`, `y`, `width` and `height`.", "kind": "function", "name": "clear", "since": "3.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The left coordinate of the clear rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The top coordinate of the clear rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.width", "description": "The width of the clear rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.height", "description": "The height of the clear rectangle.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#clear", "scope": "instance", "___id": "T000002R015121", "___s": true }, { "comment": "/**\r\n * Takes the given texture key and frame and then stamps it at the given\r\n * x and y coordinates. You can use the optional 'config' argument to provide\r\n * lots more options about how the stamp is applied, including the alpha,\r\n * tint, angle, scale and origin.\r\n *\r\n * By default, the frame will stamp on the x/y coordinates based on its center.\r\n *\r\n * If you wish to stamp from the top-left, set the config `originX` and\r\n * `originY` properties both to zero.\r\n *\r\n * This method ignores the `camera` property of the Dynamic Texture.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#stamp\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the texture to be used, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - The name or index of the frame within the Texture. Set to `null` to skip this argument if not required.\r\n * @param {number} [x=0] - The x position to draw the frame at.\r\n * @param {number} [y=0] - The y position to draw the frame at.\r\n * @param {Phaser.Types.Textures.StampConfig} [config] - The stamp configuration object, allowing you to set the alpha, tint, angle, scale and origin of the stamp.\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 381, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Takes the given texture key and frame and then stamps it at the given\rx and y coordinates. You can use the optional 'config' argument to provide\rlots more options about how the stamp is applied, including the alpha,\rtint, angle, scale and origin.\r\rBy default, the frame will stamp on the x/y coordinates based on its center.\r\rIf you wish to stamp from the top-left, set the config `originX` and\r`originY` properties both to zero.\r\rThis method ignores the `camera` property of the Dynamic Texture.", "kind": "function", "name": "stamp", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture to be used, as stored in the Texture Manager.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The name or index of the frame within the Texture. Set to `null` to skip this argument if not required.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position to draw the frame at.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position to draw the frame at.", "name": "y" }, { "type": { "names": [ "Phaser.Types.Textures.StampConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Textures.StampConfig" } }, "optional": true, "description": "The stamp configuration object, allowing you to set the alpha, tint, angle, scale and origin of the stamp.", "name": "config" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#stamp", "scope": "instance", "___id": "T000002R015123", "___s": true }, { "comment": "/**\r\n * Draws the given object, or an array of objects, to this Render Texture using a blend mode of ERASE.\r\n * This has the effect of erasing any filled pixels present in the objects from this texture.\r\n *\r\n * This method uses the `draw` method internally,\r\n * and the parameters behave the same way.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#erase\r\n * @since 3.16.0\r\n *\r\n * @param {any} entries - Any renderable Game Object, or Group, Container, Display List, Render Texture, Texture Frame, or an array of any of these.\r\n * @param {number} [x=0] - The x position to draw the Frame at, or the offset applied to the object.\r\n * @param {number} [y=0] - The y position to draw the Frame at, or the offset applied to the object.\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 412, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Draws the given object, or an array of objects, to this Render Texture using a blend mode of ERASE.\rThis has the effect of erasing any filled pixels present in the objects from this texture.\r\rThis method uses the `draw` method internally,\rand the parameters behave the same way.", "kind": "function", "name": "erase", "since": "3.16.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "Any renderable Game Object, or Group, Container, Display List, Render Texture, Texture Frame, or an array of any of these.", "name": "entries" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position to draw the Frame at, or the offset applied to the object.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position to draw the Frame at, or the offset applied to the object.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#erase", "scope": "instance", "___id": "T000002R015125", "___s": true }, { "comment": "/**\r\n * Draws the given object, or an array of objects, to this RenderTexture.\r\n *\r\n * It can accept any of the following:\r\n *\r\n * * Any renderable Game Object, such as a Sprite, Text, Graphics or TileSprite.\r\n * * Tilemap Layers.\r\n * * A Group. The contents of which will be iterated and drawn in turn.\r\n * * A Container. The contents of which will be iterated fully, and drawn in turn.\r\n * * A Scene Display List. Pass in `Scene.children` to draw the whole list.\r\n * * Another Dynamic Texture, or a Render Texture.\r\n * * A Texture Frame instance.\r\n * * A string. This is used to look-up the texture from the Texture Manager.\r\n *\r\n * Note 1: You cannot draw a Render Texture to itself.\r\n *\r\n * Note 2: GameObjects will use the camera, while textures and frames will not.\r\n * Textures and frames are drawn using the `stamp` method.\r\n *\r\n * If passing in a Group or Container it will only draw children that return `true`\r\n * when their `willRender()` method is called. I.e. a Container with 10 children,\r\n * 5 of which have `visible=false` will only draw the 5 visible ones.\r\n *\r\n * If passing in an array of Game Objects it will draw them all, regardless if\r\n * they pass a `willRender` check or not.\r\n *\r\n * You can pass in a string in which case it will look for a texture in the Texture\r\n * Manager matching that string, and draw the base frame. If you need to specify\r\n * exactly which frame to draw then use the method `drawFrame` instead.\r\n *\r\n * You can pass in the `x` and `y` coordinates to draw the objects at. The use of\r\n * the coordinates differ based on what objects are being drawn. If the object is\r\n * a Group, Container or Display List, the coordinates are _added_ to the positions\r\n * of the children. For all other types of object, the coordinates are exact.\r\n * For textures and frames, the `x` and `y` values are the middle of the texture.\r\n *\r\n * The `alpha` and `tint` values are only used by Texture Frames.\r\n * Game Objects use their own alpha and tint values when being drawn.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#draw\r\n * @since 3.2.0\r\n *\r\n * @param {any} entries - Any renderable Game Object, or Group, Container, Display List, other Render Texture, Texture Frame or an array of any of these.\r\n * @param {number} [x=0] - The x position to draw the Frame at, or the offset applied to the object.\r\n * @param {number} [y=0] - The y position to draw the Frame at, or the offset applied to the object.\r\n * @param {number} [alpha=1] - The alpha value. Only used when drawing Texture Frames to this texture. Game Objects use their own alpha.\r\n * @param {number} [tint=0xffffff] - The tint color value. Only used when drawing Texture Frames to this texture. Game Objects use their own tint. WebGL only.\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 435, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Draws the given object, or an array of objects, to this RenderTexture.\r\rIt can accept any of the following:\r\r* Any renderable Game Object, such as a Sprite, Text, Graphics or TileSprite.\r* Tilemap Layers.\r* A Group. The contents of which will be iterated and drawn in turn.\r* A Container. The contents of which will be iterated fully, and drawn in turn.\r* A Scene Display List. Pass in `Scene.children` to draw the whole list.\r* Another Dynamic Texture, or a Render Texture.\r* A Texture Frame instance.\r* A string. This is used to look-up the texture from the Texture Manager.\r\rNote 1: You cannot draw a Render Texture to itself.\r\rNote 2: GameObjects will use the camera, while textures and frames will not.\rTextures and frames are drawn using the `stamp` method.\r\rIf passing in a Group or Container it will only draw children that return `true`\rwhen their `willRender()` method is called. I.e. a Container with 10 children,\r5 of which have `visible=false` will only draw the 5 visible ones.\r\rIf passing in an array of Game Objects it will draw them all, regardless if\rthey pass a `willRender` check or not.\r\rYou can pass in a string in which case it will look for a texture in the Texture\rManager matching that string, and draw the base frame. If you need to specify\rexactly which frame to draw then use the method `drawFrame` instead.\r\rYou can pass in the `x` and `y` coordinates to draw the objects at. The use of\rthe coordinates differ based on what objects are being drawn. If the object is\ra Group, Container or Display List, the coordinates are _added_ to the positions\rof the children. For all other types of object, the coordinates are exact.\rFor textures and frames, the `x` and `y` values are the middle of the texture.\r\rThe `alpha` and `tint` values are only used by Texture Frames.\rGame Objects use their own alpha and tint values when being drawn.", "kind": "function", "name": "draw", "since": "3.2.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position to draw the Frame at, or the offset applied to the object.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position to draw the Frame at, or the offset applied to the object.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha value. Only used when drawing Texture Frames to this texture. Game Objects use their own alpha.", "name": "alpha" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xffffff", "description": "The tint color value. Only used when drawing Texture Frames to this texture. Game Objects use their own tint. WebGL only.", "name": "tint" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#draw", "scope": "instance", "___id": "T000002R015127", "___s": true }, { "comment": "/**\r\n * Draws the given object to this Render Texture.\r\n * This allows you to draw the object as it appears in the game world,\r\n * or with various parameter overrides in the config.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#capture\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} entry - Any renderable GameObject.\r\n * @param {Phaser.Types.Textures.CaptureConfig} config - The configuration object for the capture.\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 492, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Draws the given object to this Render Texture.\rThis allows you to draw the object as it appears in the game world,\ror with various parameter overrides in the config.", "kind": "function", "name": "capture", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "Any renderable GameObject.", "name": "entry" }, { "type": { "names": [ "Phaser.Types.Textures.CaptureConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Textures.CaptureConfig" } }, "description": "The configuration object for the capture.", "name": "config" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#capture", "scope": "instance", "___id": "T000002R015129", "___s": true }, { "comment": "/**\r\n * Takes the given Texture Frame and draws it to this Dynamic Texture as a fill pattern,\r\n * i.e. in a grid-layout based on the frame dimensions.\r\n * It uses a `TileSprite` internally to draw the frame repeatedly.\r\n *\r\n * Textures are referenced by their string-based keys, as stored in the Texture Manager.\r\n *\r\n * You can optionally provide a position, width, height, alpha and tint value to apply to\r\n * the frames before they are drawn. The position controls the top-left where the repeating\r\n * fill will start from. The width and height control the size of the filled area.\r\n *\r\n * The position can be negative if required, but the dimensions cannot.\r\n *\r\n * This method respects the camera settings of the Dynamic Texture.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#repeat\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the texture to be used, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - The name or index of the frame within the Texture. Set to `null` to skip this argument if not required.\r\n * @param {number} [x=0] - The x position to start drawing the frames from (can be negative to offset).\r\n * @param {number} [y=0] - The y position to start drawing the frames from (can be negative to offset).\r\n * @param {number} [width=this.width] - The width of the area to repeat the frame within. Defaults to the width of this Dynamic Texture.\r\n * @param {number} [height=this.height] - The height of the area to repeat the frame within. Defaults to the height of this Dynamic Texture.\r\n * @param {Phaser.Types.GameObjects.TileSprite.TileSpriteConfig} [config] - The configuration object for the TileSprite which repeats the texture, allowing you to set further properties on it.\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 512, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Takes the given Texture Frame and draws it to this Dynamic Texture as a fill pattern,\ri.e. in a grid-layout based on the frame dimensions.\rIt uses a `TileSprite` internally to draw the frame repeatedly.\r\rTextures are referenced by their string-based keys, as stored in the Texture Manager.\r\rYou can optionally provide a position, width, height, alpha and tint value to apply to\rthe frames before they are drawn. The position controls the top-left where the repeating\rfill will start from. The width and height control the size of the filled area.\r\rThe position can be negative if required, but the dimensions cannot.\r\rThis method respects the camera settings of the Dynamic Texture.", "kind": "function", "name": "repeat", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the texture to be used, as stored in the Texture Manager.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The name or index of the frame within the Texture. Set to `null` to skip this argument if not required.", "name": "frame" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position to start drawing the frames from (can be negative to offset).", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position to start drawing the frames from (can be negative to offset).", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.width", "description": "The width of the area to repeat the frame within. Defaults to the width of this Dynamic Texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "this.height", "description": "The height of the area to repeat the frame within. Defaults to the height of this Dynamic Texture.", "name": "height" }, { "type": { "names": [ "Phaser.Types.GameObjects.TileSprite.TileSpriteConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.TileSprite.TileSpriteConfig" } }, "optional": true, "description": "The configuration object for the TileSprite which repeats the texture, allowing you to set further properties on it.", "name": "config" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#repeat", "scope": "instance", "___id": "T000002R015131", "___s": true }, { "comment": "/**\r\n * Sets the preserve flag for this Dynamic Texture.\r\n * Ordinarily, after each render, the command buffer is cleared.\r\n * When this flag is set to `true`, the command buffer is preserved between renders.\r\n * This makes it possible to repeat the same drawing commands on each render.\r\n *\r\n * Make sure to call `clear()` at the start if you don't want to accumulate\r\n * drawing detail over the top of itself.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#preserve\r\n * @since 4.0.0\r\n * @param {boolean} preserve - Whether to preserve the command buffer after rendering.\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 547, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Sets the preserve flag for this Dynamic Texture.\rOrdinarily, after each render, the command buffer is cleared.\rWhen this flag is set to `true`, the command buffer is preserved between renders.\rThis makes it possible to repeat the same drawing commands on each render.\r\rMake sure to call `clear()` at the start if you don't want to accumulate\rdrawing detail over the top of itself.", "kind": "function", "name": "preserve", "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to preserve the command buffer after rendering.", "name": "preserve" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#preserve", "scope": "instance", "___id": "T000002R015133", "___s": true }, { "comment": "/**\r\n * Adds a callback to run during the render process.\r\n * This callback runs as a step in the command buffer.\r\n * It can be used to set up conditions for the next draw step.\r\n *\r\n * Note that this will only execute after `render()` is called.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#callback\r\n * @since 4.0.0\r\n * @param {Function} callback - A callback function to run during the render process.\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 568, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Adds a callback to run during the render process.\rThis callback runs as a step in the command buffer.\rIt can be used to set up conditions for the next draw step.\r\rNote that this will only execute after `render()` is called.", "kind": "function", "name": "callback", "since": "4.0.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "A callback function to run during the render process.", "name": "callback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#callback", "scope": "instance", "___id": "T000002R015135", "___s": true }, { "comment": "/**\r\n * Takes a snapshot of the given area of this Render Texture.\r\n *\r\n * The snapshot is taken immediately, but the results are returned via the given callback.\r\n *\r\n * To capture the whole Render Texture see the `snapshot` method.\r\n * To capture just a specific pixel, see the `snapshotPixel` method.\r\n *\r\n * Snapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer\r\n * into an ArrayBufferView. It then parses this, copying the contents to a temporary Canvas and finally\r\n * creating an Image object from it, which is the image returned to the callback provided.\r\n *\r\n * All in all, this is a computationally expensive and blocking process, which gets more expensive\r\n * the larger the resolution this Render Texture has, so please be careful how you employ this in your game.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#snapshotArea\r\n * @since 3.19.0\r\n *\r\n * @param {number} x - The x coordinate to grab from.\r\n * @param {number} y - The y coordinate to grab from.\r\n * @param {number} width - The width of the area to grab.\r\n * @param {number} height - The height of the area to grab.\r\n * @param {Phaser.Types.Renderer.Snapshot.SnapshotCallback} callback - The Function to invoke after the snapshot image is created.\r\n * @param {string} [type='image/png'] - The format of the image to create, usually `image/png` or `image/jpeg`.\r\n * @param {number} [encoderOptions=0.92] - The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 587, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Takes a snapshot of the given area of this Render Texture.\r\rThe snapshot is taken immediately, but the results are returned via the given callback.\r\rTo capture the whole Render Texture see the `snapshot` method.\rTo capture just a specific pixel, see the `snapshotPixel` method.\r\rSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer\rinto an ArrayBufferView. It then parses this, copying the contents to a temporary Canvas and finally\rcreating an Image object from it, which is the image returned to the callback provided.\r\rAll in all, this is a computationally expensive and blocking process, which gets more expensive\rthe larger the resolution this Render Texture has, so please be careful how you employ this in your game.", "kind": "function", "name": "snapshotArea", "since": "3.19.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to grab from.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to grab from.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the area to grab.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the area to grab.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Renderer.Snapshot.SnapshotCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.Snapshot.SnapshotCallback" } }, "description": "The Function to invoke after the snapshot image is created.", "name": "callback" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#snapshotArea", "scope": "instance", "___id": "T000002R015137", "___s": true }, { "comment": "/**\r\n * Takes a snapshot of the whole of this Render Texture.\r\n *\r\n * The snapshot is taken immediately, but the results are returned via the given callback.\r\n *\r\n * To capture a portion of this Render Texture see the `snapshotArea` method.\r\n * To capture just a specific pixel, see the `snapshotPixel` method.\r\n *\r\n * Snapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer\r\n * into an ArrayBufferView. It then parses this, copying the contents to a temporary Canvas and finally\r\n * creating an Image object from it, which is the image returned to the callback provided.\r\n *\r\n * All in all, this is a computationally expensive and blocking process, which gets more expensive\r\n * the larger the resolution this Render Texture has, so please be careful how you employ this in your game.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#snapshot\r\n * @since 3.19.0\r\n *\r\n * @param {Phaser.Types.Renderer.Snapshot.SnapshotCallback} callback - The Function to invoke after the snapshot image is created.\r\n * @param {string} [type='image/png'] - The format of the image to create, usually `image/png` or `image/jpeg`.\r\n * @param {number} [encoderOptions=0.92] - The image quality, between 0 and 1. Used for image formats with lossy compression, such as `image/jpeg`.\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 622, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Takes a snapshot of the whole of this Render Texture.\r\rThe snapshot is taken immediately, but the results are returned via the given callback.\r\rTo capture a portion of this Render Texture see the `snapshotArea` method.\rTo capture just a specific pixel, see the `snapshotPixel` method.\r\rSnapshots work by using the WebGL `readPixels` feature to grab every pixel from the frame buffer\rinto an ArrayBufferView. It then parses this, copying the contents to a temporary Canvas and finally\rcreating an Image object from it, which is the image returned to the callback provided.\r\rAll in all, this is a computationally expensive and blocking process, which gets more expensive\rthe larger the resolution this Render Texture has, 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.Snapshot.SnapshotCallback" } }, "description": "The Function to invoke after the snapshot image is created.", "name": "callback" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#snapshot", "scope": "instance", "___id": "T000002R015139", "___s": true }, { "comment": "/**\r\n * Takes a snapshot of the given pixel from this Render Texture.\r\n *\r\n * The snapshot is taken immediately, but the results are returned via the given callback.\r\n *\r\n * To capture the whole Render Texture see the `snapshot` method.\r\n * To capture a portion of this Render Texture see the `snapshotArea` method.\r\n *\r\n * Unlike the two other snapshot methods, this one will send your callback a `Color` object\r\n * containing the color data for the requested pixel. It doesn't need to create an internal\r\n * Canvas or Image object, so is a lot faster to execute, using less memory than the other snapshot methods.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#snapshotPixel\r\n * @since 3.19.0\r\n *\r\n * @param {number} x - The x coordinate of the pixel to get.\r\n * @param {number} y - The y coordinate of the pixel to get.\r\n * @param {Phaser.Types.Renderer.Snapshot.SnapshotCallback} callback - The Function to invoke after the snapshot pixel data is extracted.\r\n *\r\n * @return {this} This Render Texture instance.\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 651, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Takes a snapshot of the given pixel from this Render Texture.\r\rThe snapshot is taken immediately, but the results are returned via the given callback.\r\rTo capture the whole Render Texture see the `snapshot` method.\rTo capture a portion of this Render Texture see the `snapshotArea` method.\r\rUnlike the two other snapshot methods, this one will send your callback a `Color` object\rcontaining the color data for the requested pixel. It doesn't need to create an internal\rCanvas or Image object, so is a lot faster to execute, using less memory than the other snapshot methods.", "kind": "function", "name": "snapshotPixel", "since": "3.19.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the pixel to get.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the pixel to get.", "name": "y" }, { "type": { "names": [ "Phaser.Types.Renderer.Snapshot.SnapshotCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.Snapshot.SnapshotCallback" } }, "description": "The Function to invoke after the snapshot pixel data is extracted.", "name": "callback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Render Texture instance." } ], "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#snapshotPixel", "scope": "instance", "___id": "T000002R015141", "___s": true }, { "comment": "/**\r\n * Internal destroy handler, called as part of the destroy process.\r\n *\r\n * @method Phaser.GameObjects.RenderTexture#preDestroy\r\n * @protected\r\n * @since 3.9.0\r\n */", "meta": { "filename": "RenderTexture.js", "lineno": 677, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Internal destroy handler, called as part of the destroy process.", "kind": "function", "name": "preDestroy", "access": "protected", "since": "3.9.0", "memberof": "Phaser.GameObjects.RenderTexture", "longname": "Phaser.GameObjects.RenderTexture#preDestroy", "scope": "instance", "___id": "T000002R015143", "___s": true }, { "comment": "/**\r\n * Creates a new Render Texture Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Render Texture Game Object has been built into Phaser.\r\n *\r\n * A Render Texture is a combination of Dynamic Texture and an Image Game Object, that uses the\r\n * Dynamic Texture to display itself with.\r\n *\r\n * A Dynamic Texture is a special texture that allows you to draw textures, frames and most kind of\r\n * Game Objects directly to it.\r\n *\r\n * You can take many complex objects and draw them to this one texture, which can then be used as the\r\n * base texture for other Game Objects, such as Sprites. Should you then update this texture, all\r\n * Game Objects using it will instantly be updated as well, reflecting the changes immediately.\r\n *\r\n * It's a powerful way to generate dynamic textures at run-time that are WebGL friendly and don't invoke\r\n * expensive GPU uploads on each change.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#renderTexture\r\n * @since 3.2.0\r\n *\r\n * @param {Phaser.Types.GameObjects.RenderTexture.RenderTextureConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.RenderTexture} The Game Object that was created.\r\n */", "meta": { "filename": "RenderTextureCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Creates a new Render Texture Game Object and returns it.\r\rNote: This method will only be available if the Render Texture Game Object has been built into Phaser.\r\rA Render Texture is a combination of Dynamic Texture and an Image Game Object, that uses the\rDynamic Texture to display itself with.\r\rA Dynamic Texture is a special texture that allows you to draw textures, frames and most kind of\rGame Objects directly to it.\r\rYou can take many complex objects and draw them to this one texture, which can then be used as the\rbase texture for other Game Objects, such as Sprites. Should you then update this texture, all\rGame Objects using it will instantly be updated as well, reflecting the changes immediately.\r\rIt's a powerful way to generate dynamic textures at run-time that are WebGL friendly and don't invoke\rexpensive GPU uploads on each change.", "kind": "function", "name": "renderTexture", "since": "3.2.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.RenderTexture.RenderTextureConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.RenderTexture.RenderTextureConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.RenderTexture" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#renderTexture", "scope": "instance", "___id": "T000002R015160", "___s": true }, { "comment": "/**\r\n * Creates a new Render Texture Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Render Texture Game Object has been built into Phaser.\r\n *\r\n * A Render Texture is a combination of Dynamic Texture and an Image Game Object, that uses the\r\n * Dynamic Texture to display itself with.\r\n *\r\n * A Dynamic Texture is a special texture that allows you to draw textures, frames and most kinds of\r\n * Game Objects directly to it.\r\n *\r\n * You can take many complex objects and draw them to this one texture, which can then be used as the\r\n * base texture for other Game Objects, such as Sprites. Should you then update this texture, all\r\n * Game Objects using it will instantly be updated as well, reflecting the changes immediately.\r\n *\r\n * It's a powerful way to generate dynamic textures at run-time that are WebGL friendly and don't invoke\r\n * expensive GPU uploads on each change.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#renderTexture\r\n * @since 3.2.0\r\n *\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {number} [width=32] - The width of the Render Texture.\r\n * @param {number} [height=32] - The height of the Render Texture.\r\n *\r\n * @return {Phaser.GameObjects.RenderTexture} The Game Object that was created.\r\n */", "meta": { "filename": "RenderTextureFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture", "code": {} }, "description": "Creates a new Render Texture Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Render Texture Game Object has been built into Phaser.\r\rA Render Texture is a combination of Dynamic Texture and an Image Game Object, that uses the\rDynamic Texture to display itself with.\r\rA Dynamic Texture is a special texture that allows you to draw textures, frames and most kinds of\rGame Objects directly to it.\r\rYou can take many complex objects and draw them to this one texture, which can then be used as the\rbase texture for other Game Objects, such as Sprites. Should you then update this texture, all\rGame Objects using it will instantly be updated as well, reflecting the changes immediately.\r\rIt's a powerful way to generate dynamic textures at run-time that are WebGL friendly and don't invoke\rexpensive GPU uploads on each change.", "kind": "function", "name": "renderTexture", "since": "3.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The width of the Render Texture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The height of the Render Texture.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.RenderTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.RenderTexture" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#renderTexture", "scope": "instance", "___id": "T000002R015170", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.RenderTexture\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture\\typedefs", "code": {} }, "kind": "namespace", "name": "RenderTexture", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.RenderTexture", "scope": "static", "___id": "T000002R015194", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.RenderTexture.RenderTextureConfig\r\n * @since 3.2.0\r\n *\r\n * @property {number} [x=0] - The x coordinate of the RenderTextures position.\r\n * @property {number} [y=0] - The y coordinate of the RenderTextures position.\r\n * @property {number} [width=32] - The width of the RenderTexture.\r\n * @property {number} [height=32] - The height of the RenderTexture.\r\n */", "meta": { "filename": "RenderTextureConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rendertexture\\typedefs", "code": {} }, "kind": "typedef", "name": "RenderTextureConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.2.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the RenderTextures position.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the RenderTextures position.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The width of the RenderTexture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The height of the RenderTexture.", "name": "height" } ], "memberof": "Phaser.Types.GameObjects.RenderTexture", "longname": "Phaser.Types.GameObjects.RenderTexture.RenderTextureConfig", "scope": "static", "___id": "T000002R015195", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Rope Game Object.\r\n *\r\n * The Rope object is WebGL only and does not have a Canvas counterpart.\r\n *\r\n * A Rope is a special kind of Game Object that has a texture that is stretched along its entire length,\r\n * mapped across a series of vertices that you define. This makes it ideal for creating effects such as\r\n * flags waving in the wind, banners, cloth, chains, wavy water surfaces, or any shape that needs a\r\n * texture bent or deformed along a path.\r\n *\r\n * Unlike a Sprite, it isn't restricted to using just a quad and can have as many vertices as you define\r\n * when creating it. The vertices can be arranged in a horizontal or vertical strip and have their own\r\n * color and alpha values as well. You can modify the vertex positions each frame to animate the shape\r\n * of the Rope in real-time.\r\n *\r\n * The Rope also supports animations via the `anims` property, allowing you to play frame-based\r\n * animations from a texture atlas across the surface of the Rope.\r\n *\r\n * A Rope's origin is always 0.5 x 0.5 and cannot be changed.\r\n *\r\n * This object does not support trimmed textures from Texture Packer.\r\n * Trimming may interfere with the vertex arrangement.\r\n *\r\n * @class Rope\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @webglOnly\r\n * @since 3.23.0\r\n *\r\n * @extends Phaser.GameObjects.Components.AlphaSingle\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Flip\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.Size\r\n * @extends Phaser.GameObjects.Components.Texture\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {string} [texture] - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager. If not given, `__DEFAULT` is used.\r\n * @param {(string|number|null)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n * @param {(number|Phaser.Types.Math.Vector2Like[])} [points=2] - An array containing the vertices data for this Rope, or a number that indicates how many segments to split the texture frame into. If none is provided a simple quad is created. See `setPoints` to set this post-creation.\r\n * @param {boolean} [horizontal=true] - Should the vertices of this Rope be aligned horizontally (`true`), or vertically (`false`)?\r\n * @param {number[]} [colors] - An optional array containing the color data for this Rope. You should provide one color value per pair of vertices.\r\n * @param {number[]} [alphas] - An optional array containing the alpha data for this Rope. You should provide one alpha value per pair of vertices.\r\n */", "meta": { "filename": "Rope.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "classdesc": "A Rope Game Object.\r\rThe Rope object is WebGL only and does not have a Canvas counterpart.\r\rA Rope is a special kind of Game Object that has a texture that is stretched along its entire length,\rmapped across a series of vertices that you define. This makes it ideal for creating effects such as\rflags waving in the wind, banners, cloth, chains, wavy water surfaces, or any shape that needs a\rtexture bent or deformed along a path.\r\rUnlike a Sprite, it isn't restricted to using just a quad and can have as many vertices as you define\rwhen creating it. The vertices can be arranged in a horizontal or vertical strip and have their own\rcolor and alpha values as well. You can modify the vertex positions each frame to animate the shape\rof the Rope in real-time.\r\rThe Rope also supports animations via the `anims` property, allowing you to play frame-based\ranimations from a texture atlas across the surface of the Rope.\r\rA Rope's origin is always 0.5 x 0.5 and cannot be changed.\r\rThis object does not support trimmed textures from Texture Packer.\rTrimming may interfere with the vertex arrangement.", "kind": "class", "name": "Rope", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.AlphaSingle", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.Flip", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.RenderNodes", "Phaser.GameObjects.Components.Size", "Phaser.GameObjects.Components.Texture", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible", "Phaser.GameObjects.Components.ScrollFactor" ], "memberof": "Phaser.GameObjects", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.23.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The key of the Texture this Game Object will use to render with, as stored in the Texture Manager. If not given, `__DEFAULT` is used.", "name": "texture" }, { "type": { "names": [ "string", "number", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "NullLiteral" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" }, { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } ] } }, "optional": true, "defaultvalue": 2, "description": "An array containing the vertices data for this Rope, or a number that indicates how many segments to split the texture frame into. If none is provided a simple quad is created. See `setPoints` to set this post-creation.", "name": "points" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the vertices of this Rope be aligned horizontally (`true`), or vertically (`false`)?", "name": "horizontal" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "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", "___id": "T000002R015204", "___s": true }, { "comment": "/**\r\n * The Animation State of this Rope.\r\n *\r\n * @name Phaser.GameObjects.Rope#anims\r\n * @type {Phaser.Animations.AnimationState}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "The Animation State of this Rope.", "name": "anims", "type": { "names": [ "Phaser.Animations.AnimationState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationState" } }, "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#anims", "scope": "instance", "kind": "member", "___id": "T000002R015212", "___s": true }, { "comment": "/**\r\n * An array containing the points data for this Rope.\r\n *\r\n * Each point should be given as a Vector2Like object (i.e. a Vector2 or object with public x/y properties).\r\n *\r\n * The point coordinates are given in local space, where 0 x 0 is the start of the Rope strip.\r\n *\r\n * You can modify the contents of this array directly in real-time to create interesting effects.\r\n * If you do so, be sure to call `setDirty` _after_ modifying this array, so that the vertices data is\r\n * updated before the next render. Alternatively, you can use the `setPoints` method instead.\r\n *\r\n * Should you need to change the _size_ of this array, then you should always use the `setPoints` method.\r\n *\r\n * @name Phaser.GameObjects.Rope#points\r\n * @type {Phaser.Types.Math.Vector2Like[]}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "An array containing the points data for this Rope.\r\rEach point should be given as a Vector2Like object (i.e. a Vector2 or object with public x/y properties).\r\rThe point coordinates are given in local space, where 0 x 0 is the start of the Rope strip.\r\rYou can modify the contents of this array directly in real-time to create interesting effects.\rIf you do so, be sure to call `setDirty` _after_ modifying this array, so that the vertices data is\rupdated before the next render. Alternatively, you can use the `setPoints` method instead.\r\rShould you need to change the _size_ of this array, then you should always use the `setPoints` method.", "name": "points", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#points", "scope": "instance", "kind": "member", "___id": "T000002R015214", "___s": true }, { "comment": "/**\r\n * An array containing the vertices data for this Rope.\r\n *\r\n * This data is calculated automatically in the `updateVertices` method, based on the points provided.\r\n *\r\n * @name Phaser.GameObjects.Rope#vertices\r\n * @type {Float32Array}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "An array containing the vertices data for this Rope.\r\rThis data is calculated automatically in the `updateVertices` method, based on the points provided.", "name": "vertices", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#vertices", "scope": "instance", "kind": "member", "___id": "T000002R015216", "___s": true }, { "comment": "/**\r\n * An array containing the uv data for this Rope.\r\n *\r\n * This data is calculated automatically in the `setPoints` method, based on the points provided.\r\n *\r\n * @name Phaser.GameObjects.Rope#uv\r\n * @type {Float32Array}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 137, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "An array containing the uv data for this Rope.\r\rThis data is calculated automatically in the `setPoints` method, based on the points provided.", "name": "uv", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#uv", "scope": "instance", "kind": "member", "___id": "T000002R015218", "___s": true }, { "comment": "/**\r\n * An array containing the color data for this Rope.\r\n *\r\n * Colors should be given as numeric RGB values, such as 0xff0000.\r\n * You should provide _two_ color values for every point in the Rope, one for the top and one for the bottom of each quad.\r\n *\r\n * You can modify the contents of this array directly in real-time, however, should you need to change the _size_\r\n * of the array, then you should use the `setColors` method instead.\r\n *\r\n * @name Phaser.GameObjects.Rope#colors\r\n * @type {Uint32Array}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 148, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "An array containing the color data for this Rope.\r\rColors should be given as numeric RGB values, such as 0xff0000.\rYou should provide _two_ color values for every point in the Rope, one for the top and one for the bottom of each quad.\r\rYou can modify the contents of this array directly in real-time, however, should you need to change the _size_\rof the array, then you should use the `setColors` method instead.", "name": "colors", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#colors", "scope": "instance", "kind": "member", "___id": "T000002R015220", "___s": true }, { "comment": "/**\r\n * An array containing the alpha data for this Rope.\r\n *\r\n * Alphas should be given as float values, such as 0.5.\r\n * You should provide _two_ alpha values for every point in the Rope, one for the top and one for the bottom of each quad.\r\n *\r\n * You can modify the contents of this array directly in real-time, however, should you need to change the _size_\r\n * of the array, then you should use the `setAlphas` method instead.\r\n *\r\n * @name Phaser.GameObjects.Rope#alphas\r\n * @type {Float32Array}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "An array containing the alpha data for this Rope.\r\rAlphas should be given as float values, such as 0.5.\rYou should provide _two_ alpha values for every point in the Rope, one for the top and one for the bottom of each quad.\r\rYou can modify the contents of this array directly in real-time, however, should you need to change the _size_\rof the array, then you should use the `setAlphas` method instead.", "name": "alphas", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#alphas", "scope": "instance", "kind": "member", "___id": "T000002R015222", "___s": true }, { "comment": "/**\r\n * The tint mode to use when applying the tint to the texture.\r\n *\r\n * Available modes are:\r\n * - Phaser.TintModes.MULTIPLY (default)\r\n * - Phaser.TintModes.FILL (default when the texture is __DEFAULT)\r\n * - Phaser.TintModes.ADD\r\n * - Phaser.TintModes.SCREEN\r\n * - Phaser.TintModes.OVERLAY\r\n * - Phaser.TintModes.HARD_LIGHT\r\n *\r\n * Rope does not currently support secondary tint colors or modes.\r\n *\r\n * @name Phaser.GameObjects.Rope#tintMode\r\n * @type {Phaser.TintModes}\r\n * @default Phaser.TintModes.MULTIPLY\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 178, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "The tint mode to use when applying the tint to the texture.\r\rAvailable modes are:\r- Phaser.TintModes.MULTIPLY (default)\r- Phaser.TintModes.FILL (default when the texture is __DEFAULT)\r- Phaser.TintModes.ADD\r- Phaser.TintModes.SCREEN\r- Phaser.TintModes.OVERLAY\r- Phaser.TintModes.HARD_LIGHT\r\rRope does not currently support secondary tint colors or modes.", "name": "tintMode", "type": { "names": [ "Phaser.TintModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.TintModes" } }, "defaultvalue": "Phaser.TintModes.MULTIPLY", "since": "4.0.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#tintMode", "scope": "instance", "kind": "member", "___id": "T000002R015224", "___s": true }, { "comment": "/**\r\n * If the Rope is marked as `dirty` it will automatically recalculate its vertices\r\n * the next time it renders. You can also force this by calling `updateVertices`.\r\n *\r\n * @name Phaser.GameObjects.Rope#dirty\r\n * @type {boolean}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 198, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "If the Rope is marked as `dirty` it will automatically recalculate its vertices\rthe next time it renders. You can also force this by calling `updateVertices`.", "name": "dirty", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#dirty", "scope": "instance", "kind": "member", "___id": "T000002R015226", "___s": true }, { "comment": "/**\r\n * Are the Rope vertices aligned horizontally, in a strip, or vertically, in a column?\r\n *\r\n * This property is set during instantiation and cannot be changed directly.\r\n * See the `setVertical` and `setHorizontal` methods.\r\n *\r\n * @name Phaser.GameObjects.Rope#horizontal\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 208, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Are the Rope vertices aligned horizontally, in a strip, or vertically, in a column?\r\rThis property is set during instantiation and cannot be changed directly.\rSee the `setVertical` and `setHorizontal` methods.", "name": "horizontal", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#horizontal", "scope": "instance", "kind": "member", "___id": "T000002R015228", "___s": true }, { "comment": "/**\r\n * You can optionally choose to render the vertices of this Rope to a Graphics instance.\r\n *\r\n * Achieve this by setting the `debugCallback` and the `debugGraphic` properties.\r\n *\r\n * You can do this in a single call via the `Rope.setDebug` method, which will use the\r\n * built-in debug function. You can also set it to your own callback. The callback\r\n * will be invoked _once per render_ and sent the following parameters:\r\n *\r\n * `debugCallback(src, meshLength, verts)`\r\n *\r\n * `src` is the Rope instance being debugged.\r\n * `meshLength` is the number of mesh vertices in total.\r\n * `verts` is an array of the translated vertex coordinates.\r\n *\r\n * To disable rendering, set this property back to `null`.\r\n *\r\n * @name Phaser.GameObjects.Rope#debugCallback\r\n * @type {function}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 261, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "You can optionally choose to render the vertices of this Rope to a Graphics instance.\r\rAchieve this by setting the `debugCallback` and the `debugGraphic` properties.\r\rYou can do this in a single call via the `Rope.setDebug` method, which will use the\rbuilt-in debug function. You can also set it to your own callback. The callback\rwill be invoked _once per render_ and sent the following parameters:\r\r`debugCallback(src, meshLength, verts)`\r\r`src` is the Rope instance being debugged.\r`meshLength` is the number of mesh vertices in total.\r`verts` is an array of the translated vertex coordinates.\r\rTo disable rendering, set this property back to `null`.", "name": "debugCallback", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#debugCallback", "scope": "instance", "kind": "member", "___id": "T000002R015236", "___s": true }, { "comment": "/**\r\n * The Graphics instance that the debug vertices will be drawn to, if `setDebug` has\r\n * been called.\r\n *\r\n * @name Phaser.GameObjects.Rope#debugGraphic\r\n * @type {Phaser.GameObjects.Graphics}\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 284, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "The Graphics instance that the debug vertices will be drawn to, if `setDebug` has\rbeen called.", "name": "debugGraphic", "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#debugGraphic", "scope": "instance", "kind": "member", "___id": "T000002R015238", "___s": true }, { "comment": "/**\r\n * Called automatically by Phaser when this Game Object is added to a Scene.\r\n * Registers this Rope with the Scene's update list so that `preUpdate` is called each frame.\r\n *\r\n * @method Phaser.GameObjects.Rope#addedToScene\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Called automatically by Phaser when this Game Object is added to a Scene.\rRegisters this Rope with the Scene's update list so that `preUpdate` is called each frame.", "kind": "function", "name": "addedToScene", "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#addedToScene", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#addedToScene", "___id": "T000002R015243", "___s": true }, { "comment": "/**\r\n * Called automatically by Phaser when this Game Object is removed from a Scene.\r\n * Removes this Rope from the Scene's update list so that `preUpdate` is no longer called each frame.\r\n *\r\n * @method Phaser.GameObjects.Rope#removedFromScene\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 338, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Called automatically by Phaser when this Game Object is removed from a Scene.\rRemoves this Rope from the Scene's update list so that `preUpdate` is no longer called each frame.", "kind": "function", "name": "removedFromScene", "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#removedFromScene", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#removedFromScene", "___id": "T000002R015245", "___s": true }, { "comment": "/**\r\n * The Rope update loop.\r\n *\r\n * @method Phaser.GameObjects.Rope#preUpdate\r\n * @protected\r\n * @since 3.23.0\r\n *\r\n * @param {number} time - The current timestamp.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "Rope.js", "lineno": 350, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "The Rope update loop.", "kind": "function", "name": "preUpdate", "access": "protected", "since": "3.23.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time, in ms, elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#preUpdate", "scope": "instance", "___id": "T000002R015247", "___s": true }, { "comment": "/**\r\n * Start playing the given animation.\r\n *\r\n * @method Phaser.GameObjects.Rope#play\r\n * @since 3.23.0\r\n *\r\n * @param {string} key - The string-based key of the animation to play.\r\n * @param {boolean} [ignoreIfPlaying=false] - If an animation is already playing then ignore this call.\r\n * @param {number} [startFrame=0] - Optionally start the animation playing from this frame index.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Rope.js", "lineno": 373, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Start playing the given animation.", "kind": "function", "name": "play", "since": "3.23.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string-based key of the animation to play.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If an animation is already playing then ignore this call.", "name": "ignoreIfPlaying" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Optionally start the animation playing from this frame index.", "name": "startFrame" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#play", "scope": "instance", "___id": "T000002R015250", "___s": true }, { "comment": "/**\r\n * Flags this Rope as being dirty. A dirty rope will recalculate all of its vertices data\r\n * the _next_ time it renders. You should set this rope as dirty if you update the points\r\n * array directly.\r\n *\r\n * @method Phaser.GameObjects.Rope#setDirty\r\n * @since 3.23.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Rope.js", "lineno": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Flags this Rope as being dirty. A dirty rope will recalculate all of its vertices data\rthe _next_ time it renders. You should set this rope as dirty if you update the points\rarray directly.", "kind": "function", "name": "setDirty", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#setDirty", "scope": "instance", "___id": "T000002R015252", "___s": true }, { "comment": "/**\r\n * Sets the alignment of the points in this Rope to be horizontal, in a strip format.\r\n *\r\n * Calling this method will reset this Rope. The current points, vertices, colors and alpha\r\n * values will be reset to those values given as parameters.\r\n *\r\n * @method Phaser.GameObjects.Rope#setHorizontal\r\n * @since 3.23.0\r\n *\r\n * @param {(number|Phaser.Types.Math.Vector2Like[])} [points] - An array containing the vertices data for this Rope, or a number that indicates how many segments to split the texture frame into. If none is provided the current points length is used.\r\n * @param {(number|number[])} [colors] - Either a single color value, or an array of values.\r\n * @param {(number|number[])} [alphas] - Either a single alpha value, or an array of values.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Rope.js", "lineno": 409, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Sets the alignment of the points in this Rope to be horizontal, in a strip format.\r\rCalling this method will reset this Rope. The current points, vertices, colors and alpha\rvalues will be reset to those values given as parameters.", "kind": "function", "name": "setHorizontal", "since": "3.23.0", "params": [ { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An array containing the vertices data for this Rope, or a number that indicates how many segments to split the texture frame into. If none is provided the current points length is used.", "name": "points" }, { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Either a single color value, or an array of values.", "name": "colors" }, { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Either a single alpha value, or an array of values.", "name": "alphas" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#setHorizontal", "scope": "instance", "___id": "T000002R015255", "___s": true }, { "comment": "/**\r\n * Sets the alignment of the points in this Rope to be vertical, in a column format.\r\n *\r\n * Calling this method will reset this Rope. The current points, vertices, colors and alpha\r\n * values will be reset to those values given as parameters.\r\n *\r\n * @method Phaser.GameObjects.Rope#setVertical\r\n * @since 3.23.0\r\n *\r\n * @param {(number|Phaser.Types.Math.Vector2Like[])} [points] - An array containing the vertices data for this Rope, or a number that indicates how many segments to split the texture frame into. If none is provided the current points length is used.\r\n * @param {(number|number[])} [colors] - Either a single color value, or an array of values.\r\n * @param {(number|number[])} [alphas] - Either a single alpha value, or an array of values.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Rope.js", "lineno": 438, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Sets the alignment of the points in this Rope to be vertical, in a column format.\r\rCalling this method will reset this Rope. The current points, vertices, colors and alpha\rvalues will be reset to those values given as parameters.", "kind": "function", "name": "setVertical", "since": "3.23.0", "params": [ { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An array containing the vertices data for this Rope, or a number that indicates how many segments to split the texture frame into. If none is provided the current points length is used.", "name": "points" }, { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Either a single color value, or an array of values.", "name": "colors" }, { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Either a single alpha value, or an array of values.", "name": "alphas" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#setVertical", "scope": "instance", "___id": "T000002R015259", "___s": true }, { "comment": "/**\r\n * Sets the tint mode to use when applying the tint to the texture.\r\n *\r\n * Available modes are:\r\n * - Phaser.TintModes.MULTIPLY (default)\r\n * - Phaser.TintModes.FILL\r\n * - Phaser.TintModes.ADD\r\n * - Phaser.TintModes.SCREEN\r\n * - Phaser.TintModes.OVERLAY\r\n * - Phaser.TintModes.HARD_LIGHT\r\n *\r\n * See the `setColors` method for details of how to color each of the vertices.\r\n *\r\n * Rope does not currently support secondary tint colors or modes.\r\n *\r\n * @method Phaser.GameObjects.Rope#setTintMode\r\n * @webglOnly\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.TintModes} [value=Phaser.TintModes.MULTIPLY] - The tint mode to use.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Rope.js", "lineno": 467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Sets the tint mode to use when applying the tint to the texture.\r\rAvailable modes are:\r- Phaser.TintModes.MULTIPLY (default)\r- Phaser.TintModes.FILL\r- Phaser.TintModes.ADD\r- Phaser.TintModes.SCREEN\r- Phaser.TintModes.OVERLAY\r- Phaser.TintModes.HARD_LIGHT\r\rSee the `setColors` method for details of how to color each of the vertices.\r\rRope does not currently support secondary tint colors or modes.", "kind": "function", "name": "setTintMode", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.TintModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.TintModes" } }, "optional": true, "defaultvalue": "Phaser.TintModes.MULTIPLY", "description": "The tint mode to use.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#setTintMode", "scope": "instance", "___id": "T000002R015263", "___s": true }, { "comment": "/**\r\n * Set the alpha values used by the Rope during rendering.\r\n *\r\n * You can provide the values in a number of ways:\r\n *\r\n * 1) One single numeric value: `setAlphas(0.5)` - This will set a single alpha for the whole Rope.\r\n * 2) Two numeric values: `setAlphas(1, 0.5)` - This will set a 'top' and 'bottom' alpha value across the whole Rope.\r\n * 3) An array of values: `setAlphas([ 1, 0.5, 0.2 ])`\r\n *\r\n * If you provide an array of values and the array has exactly the same number of values as `points` in the Rope, it\r\n * will use each alpha value per rope segment.\r\n *\r\n * If the provided array has a different number of values than `points` then it will use the values in order, from\r\n * the first Rope segment and on, until it runs out of values. This allows you to control the alpha values at all\r\n * vertices in the Rope.\r\n *\r\n * Note this method is called `setAlphas` (plural) and not `setAlpha`.\r\n *\r\n * @method Phaser.GameObjects.Rope#setAlphas\r\n * @since 3.23.0\r\n *\r\n * @param {(number|number[])} [alphas] - Either a single alpha value, or an array of values. If nothing is provided alpha is reset to 1.\r\n * @param {number} [bottomAlpha] - An optional bottom alpha value. See the method description for details.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Rope.js", "lineno": 499, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Set the alpha values used by the Rope during rendering.\r\rYou can provide the values in a number of ways:\r\r1) One single numeric value: `setAlphas(0.5)` - This will set a single alpha for the whole Rope.\r2) Two numeric values: `setAlphas(1, 0.5)` - This will set a 'top' and 'bottom' alpha value across the whole Rope.\r3) An array of values: `setAlphas([ 1, 0.5, 0.2 ])`\r\rIf you provide an array of values and the array has exactly the same number of values as `points` in the Rope, it\rwill use each alpha value per rope segment.\r\rIf the provided array has a different number of values than `points` then it will use the values in order, from\rthe first Rope segment and on, until it runs out of values. This allows you to control the alpha values at all\rvertices in the Rope.\r\rNote this method is called `setAlphas` (plural) and not `setAlpha`.", "kind": "function", "name": "setAlphas", "since": "3.23.0", "params": [ { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "An optional bottom alpha value. See the method description for details.", "name": "bottomAlpha" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#setAlphas", "scope": "instance", "___id": "T000002R015267", "___s": true }, { "comment": "/**\r\n * Set the color values used by the Rope during rendering.\r\n *\r\n * Colors are used to control the level of tint applied across the Rope texture.\r\n *\r\n * You can provide the values in a number of ways:\r\n *\r\n * * One single numeric value: `setColors(0xff0000)` - This will set a single color tint for the whole Rope.\r\n * * An array of values: `setColors([ 0xff0000, 0x00ff00, 0x0000ff ])`\r\n *\r\n * If you provide an array of values and the array has exactly the same number of values as `points` in the Rope, it\r\n * will use each color per rope segment.\r\n *\r\n * If the provided array has a different number of values than `points` then it will use the values in order, from\r\n * the first Rope segment and on, until it runs out of values. This allows you to control the color values at all\r\n * vertices in the Rope.\r\n *\r\n * @method Phaser.GameObjects.Rope#setColors\r\n * @since 3.23.0\r\n *\r\n * @param {(number|number[])} [colors] - Either a single color value, or an array of values. If nothing is provided color is reset to 0xffffff.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Rope.js", "lineno": 598, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Set the color values used by the Rope during rendering.\r\rColors are used to control the level of tint applied across the Rope texture.\r\rYou can provide the values in a number of ways:\r\r* One single numeric value: `setColors(0xff0000)` - This will set a single color tint for the whole Rope.\r* An array of values: `setColors([ 0xff0000, 0x00ff00, 0x0000ff ])`\r\rIf you provide an array of values and the array has exactly the same number of values as `points` in the Rope, it\rwill use each color per rope segment.\r\rIf the provided array has a different number of values than `points` then it will use the values in order, from\rthe first Rope segment and on, until it runs out of values. This allows you to control the color values at all\rvertices in the Rope.", "kind": "function", "name": "setColors", "since": "3.23.0", "params": [ { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#setColors", "scope": "instance", "___id": "T000002R015290", "___s": true }, { "comment": "/**\r\n * Sets the points used by this Rope.\r\n *\r\n * The points should be provided as an array of Vector2, or vector2-like objects (i.e. those with public x/y properties).\r\n *\r\n * Each point corresponds to one segment of the Rope. The more points in the array, the more segments the rope has.\r\n *\r\n * Point coordinates are given in local-space, not world-space, and are directly related to the size of the texture\r\n * this Rope object is using.\r\n *\r\n * For example, a Rope using a 512 px wide texture, split into 4 segments (128px each) would use the following points:\r\n *\r\n * ```javascript\r\n * rope.setPoints([\r\n * { x: 0, y: 0 },\r\n * { x: 128, y: 0 },\r\n * { x: 256, y: 0 },\r\n * { x: 384, y: 0 }\r\n * ]);\r\n * ```\r\n *\r\n * Or, you can provide an integer to do the same thing:\r\n *\r\n * ```javascript\r\n * rope.setPoints(4);\r\n * ```\r\n *\r\n * Which will divide the Rope into 4 equally sized segments based on the frame width.\r\n *\r\n * Note that calling this method with a different number of points than the Rope has currently will\r\n * _reset_ the color and alpha values, unless you provide them as arguments to this method.\r\n *\r\n * @method Phaser.GameObjects.Rope#setPoints\r\n * @since 3.23.0\r\n *\r\n * @param {(number|Phaser.Types.Math.Vector2Like[])} [points=2] - An array containing the vertices data for this Rope, or a number that indicates how many segments to split the texture frame into. If none is provided a simple quad is created.\r\n * @param {(number|number[])} [colors] - Either a single color value, or an array of values.\r\n * @param {(number|number[])} [alphas] - Either a single alpha value, or an array of values.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Rope.js", "lineno": 683, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Sets the points used by this Rope.\r\rThe points should be provided as an array of Vector2, or vector2-like objects (i.e. those with public x/y properties).\r\rEach point corresponds to one segment of the Rope. The more points in the array, the more segments the rope has.\r\rPoint coordinates are given in local-space, not world-space, and are directly related to the size of the texture\rthis Rope object is using.\r\rFor example, a Rope using a 512 px wide texture, split into 4 segments (128px each) would use the following points:\r\r```javascript\rrope.setPoints([\r { x: 0, y: 0 },\r { x: 128, y: 0 },\r { x: 256, y: 0 },\r { x: 384, y: 0 }\r]);\r```\r\rOr, you can provide an integer to do the same thing:\r\r```javascript\rrope.setPoints(4);\r```\r\rWhich will divide the Rope into 4 equally sized segments based on the frame width.\r\rNote that calling this method with a different number of points than the Rope has currently will\r_reset_ the color and alpha values, unless you provide them as arguments to this method.", "kind": "function", "name": "setPoints", "since": "3.23.0", "params": [ { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } ] } }, "optional": true, "defaultvalue": 2, "description": "An array containing the vertices data for this Rope, or a number that indicates how many segments to split the texture frame into. If none is provided a simple quad is created.", "name": "points" }, { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Either a single color value, or an array of values.", "name": "colors" }, { "type": { "names": [ "number", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Either a single alpha value, or an array of values.", "name": "alphas" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#setPoints", "scope": "instance", "___id": "T000002R015309", "___s": true }, { "comment": "/**\r\n * Updates all of the UVs based on the Rope.points and `flipX` and `flipY` settings.\r\n *\r\n * @method Phaser.GameObjects.Rope#updateUVs\r\n * @since 3.23.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Rope.js", "lineno": 805, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Updates all of the UVs based on the Rope.points and `flipX` and `flipY` settings.", "kind": "function", "name": "updateUVs", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#updateUVs", "scope": "instance", "___id": "T000002R015334", "___s": true }, { "comment": "/**\r\n * Resizes all of the internal arrays: `vertices`, `uv`, `colors` and `alphas` to the new\r\n * given Rope segment total.\r\n *\r\n * @method Phaser.GameObjects.Rope#resizeArrays\r\n * @since 3.23.0\r\n *\r\n * @param {number} newSize - The amount of segments to split the Rope in to.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Rope.js", "lineno": 893, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Resizes all of the internal arrays: `vertices`, `uv`, `colors` and `alphas` to the new\rgiven Rope segment total.", "kind": "function", "name": "resizeArrays", "since": "3.23.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of segments to split the Rope in to.", "name": "newSize" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#resizeArrays", "scope": "instance", "___id": "T000002R015370", "___s": true }, { "comment": "/**\r\n * Updates the vertices based on the Rope points.\r\n *\r\n * This method is called automatically during rendering if `Rope.dirty` is `true`, which is set\r\n * by the `setPoints` and `setDirty` methods. You should flag the Rope as being dirty if you modify\r\n * the Rope points directly.\r\n *\r\n * @method Phaser.GameObjects.Rope#updateVertices\r\n * @since 3.23.0\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Rope.js", "lineno": 930, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Updates the vertices based on the Rope points.\r\rThis method is called automatically during rendering if `Rope.dirty` is `true`, which is set\rby the `setPoints` and `setDirty` methods. You should flag the Rope as being dirty if you modify\rthe Rope points directly.", "kind": "function", "name": "updateVertices", "since": "3.23.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#updateVertices", "scope": "instance", "___id": "T000002R015384", "___s": true }, { "comment": "/**\r\n * This method enables rendering of the Rope vertices to the given Graphics instance.\r\n *\r\n * If you enable this feature, you **must** call `Graphics.clear()` in your Scene `update`,\r\n * otherwise the Graphics instance you provide to debug will fill-up with draw calls,\r\n * eventually crashing the browser. This is not done automatically to allow you to debug\r\n * draw multiple Rope objects to a single Graphics instance.\r\n *\r\n * The Rope class has a built-in debug rendering callback `Rope.renderDebugVerts`, however\r\n * you can also provide your own callback to be used instead. Do this by setting the `callback` parameter.\r\n *\r\n * The callback is invoked _once per render_ and sent the following parameters:\r\n *\r\n * `callback(src, meshLength, verts)`\r\n *\r\n * `src` is the Rope instance being debugged.\r\n * `meshLength` is the number of mesh vertices in total.\r\n * `verts` is an array of the translated vertex coordinates.\r\n *\r\n * If using your own callback you do not have to provide a Graphics instance to this method.\r\n *\r\n * To disable debug rendering, to either your own callback or the built-in one, call this method\r\n * with no arguments.\r\n *\r\n * @method Phaser.GameObjects.Rope#setDebug\r\n * @since 3.23.0\r\n *\r\n * @param {Phaser.GameObjects.Graphics} [graphic] - The Graphic instance to render to if using the built-in callback.\r\n * @param {function} [callback] - The callback to invoke during debug render. Leave as undefined to use the built-in callback.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Rope.js", "lineno": 998, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "This method enables rendering of the Rope vertices to the given Graphics instance.\r\rIf you enable this feature, you **must** call `Graphics.clear()` in your Scene `update`,\rotherwise the Graphics instance you provide to debug will fill-up with draw calls,\reventually crashing the browser. This is not done automatically to allow you to debug\rdraw multiple Rope objects to a single Graphics instance.\r\rThe Rope class has a built-in debug rendering callback `Rope.renderDebugVerts`, however\ryou can also provide your own callback to be used instead. Do this by setting the `callback` parameter.\r\rThe callback is invoked _once per render_ and sent the following parameters:\r\r`callback(src, meshLength, verts)`\r\r`src` is the Rope instance being debugged.\r`meshLength` is the number of mesh vertices in total.\r`verts` is an array of the translated vertex coordinates.\r\rIf using your own callback you do not have to provide a Graphics instance to this method.\r\rTo disable debug rendering, to either your own callback or the built-in one, call this method\rwith no arguments.", "kind": "function", "name": "setDebug", "since": "3.23.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Graphics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Graphics" } }, "optional": true, "description": "The Graphic instance to render to if using the built-in callback.", "name": "graphic" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "The callback to invoke during debug render. Leave as undefined to use the built-in callback.", "name": "callback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#setDebug", "scope": "instance", "___id": "T000002R015411", "___s": true }, { "comment": "/**\r\n * The built-in Rope vertices debug rendering method.\r\n *\r\n * See `Rope.setDebug` for more details.\r\n *\r\n * @method Phaser.GameObjects.Rope#renderDebugVerts\r\n * @since 3.23.0\r\n *\r\n * @param {Phaser.GameObjects.Rope} src - The Rope object being rendered.\r\n * @param {number} meshLength - The number of vertices in the mesh.\r\n * @param {number[]} verts - An array of translated vertex coordinates.\r\n */", "meta": { "filename": "Rope.js", "lineno": 1050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "The built-in Rope vertices debug rendering method.\r\rSee `Rope.setDebug` for more details.", "kind": "function", "name": "renderDebugVerts", "since": "3.23.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Rope" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Rope" } }, "description": "The Rope object being rendered.", "name": "src" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of vertices in the mesh.", "name": "meshLength" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array of translated vertex coordinates.", "name": "verts" } ], "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#renderDebugVerts", "scope": "instance", "___id": "T000002R015417", "___s": true }, { "comment": "/**\r\n * The horizontally flipped state of the Game Object.\r\n *\r\n * A Game Object that is flipped horizontally will render inversed on the horizontal axis.\r\n * Flipping always takes place from the middle of the texture and does not impact the scale value.\r\n * If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.\r\n *\r\n * @name Phaser.GameObjects.Rope#flipX\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 1115, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "The horizontally flipped state of the Game Object.\r\rA Game Object that is flipped horizontally will render inversed on the horizontal axis.\rFlipping always takes place from the middle of the texture and does not impact the scale value.\rIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.", "name": "flipX", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#flipX", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Components.Flip#flipX", "___id": "T000002R015444", "___s": true }, { "comment": "/**\r\n * The vertically flipped state of the Game Object.\r\n *\r\n * A Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\r\n * Flipping always takes place from the middle of the texture and does not impact the scale value.\r\n * If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.\r\n *\r\n * @name Phaser.GameObjects.Rope#flipY\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.23.0\r\n */", "meta": { "filename": "Rope.js", "lineno": 1143, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "The vertically flipped state of the Game Object.\r\rA Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)\rFlipping always takes place from the middle of the texture and does not impact the scale value.\rIf this Game Object has a physics body, it will not change the body. This is a rendering toggle only.", "name": "flipY", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.23.0", "memberof": "Phaser.GameObjects.Rope", "longname": "Phaser.GameObjects.Rope#flipY", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Components.Flip#flipY", "___id": "T000002R015449", "___s": true }, { "comment": "/**\r\n * Creates a new Rope Game Object and returns it.\r\n *\r\n * A Rope is a WebGL-only Game Object that renders a strip of textured triangles along a series of points.\r\n * This makes it ideal for creating rope, ribbon, cloth, or other flexible strip-like visual effects.\r\n * The points define the spine of the rope, and the texture is stretched and mapped across the resulting mesh.\r\n * Per-vertex colors and alpha values can be set to create gradient or fade effects along the length of the rope.\r\n *\r\n * Note: This method will only be available if the Rope Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#rope\r\n * @since 3.23.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Rope.RopeConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Rope} The Game Object that was created.\r\n */", "meta": { "filename": "RopeCreator.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Creates a new Rope Game Object and returns it.\r\rA Rope is a WebGL-only Game Object that renders a strip of textured triangles along a series of points.\rThis makes it ideal for creating rope, ribbon, cloth, or other flexible strip-like visual effects.\rThe points define the spine of the rope, and the texture is stretched and mapped across the resulting mesh.\rPer-vertex colors and alpha values can be set to create gradient or fade effects along the length of the rope.\r\rNote: 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": [ "Phaser.Types.GameObjects.Rope.RopeConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Rope.RopeConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Rope" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#rope", "scope": "instance", "___id": "T000002R015463", "___s": true }, { "comment": "/**\r\n * Creates a new Rope Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Rope Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#rope\r\n * @webglOnly\r\n * @since 3.23.0\r\n *\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n * @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.\r\n * @param {boolean} [horizontal=true] - Should the vertices of this Rope be aligned horizontally (`true`), or vertically (`false`)?\r\n * @param {number[]} [colors] - An optional array containing the color data for this Rope. You should provide one color value per pair of vertices.\r\n * @param {number[]} [alphas] - An optional array containing the alpha data for this Rope. You should provide one alpha value per pair of vertices.\r\n *\r\n * @return {Phaser.GameObjects.Rope} The Game Object that was created.\r\n */", "meta": { "filename": "RopeFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope", "code": {} }, "description": "Creates a new Rope Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Rope Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "rope", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.23.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "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": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the vertices of this Rope be aligned horizontally (`true`), or vertically (`false`)?", "name": "horizontal" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Rope" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#rope", "scope": "instance", "___id": "T000002R015475", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Rope\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope\\typedefs", "code": {} }, "kind": "namespace", "name": "Rope", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Rope", "scope": "static", "___id": "T000002R015498", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Rope.RopeConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 3.50.0\r\n *\r\n * @property {string} [key] - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager. If not given, `__DEFAULT` is used.\r\n * @property {(string|integer|null)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n * @property {(integer|Phaser.Types.Math.Vector2Like[])} [points=2] - An array containing the vertices data for this Rope, or a number that indicates how many segments to split the texture frame into. If none is provided a simple quad is created. See `setPoints` to set this post-creation.\r\n * @property {boolean} [horizontal=true] - Should the vertices of this Rope be aligned horizontally (`true`), or vertically (`false`)?\r\n * @property {number[]} [colors] - An optional array containing the color data for this Rope. You should provide one color value per pair of vertices.\r\n * @property {number[]} [alphas] - An optional array containing the alpha data for this Rope. You should provide one alpha value per pair of vertices.\r\n */", "meta": { "filename": "RopeConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\rope\\typedefs", "code": {} }, "kind": "typedef", "name": "RopeConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "3.50.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The key of the Texture this Game Object will use to render with, as stored in the Texture Manager. If not given, `__DEFAULT` is used.", "name": "key" }, { "type": { "names": [ "string", "integer", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "integer" }, { "type": "NullLiteral" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" }, { "type": { "names": [ "integer", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "integer" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } ] } }, "optional": true, "defaultvalue": 2, "description": "An array containing the vertices data for this Rope, or a number that indicates how many segments to split the texture frame into. If none is provided a simple quad is created. See `setPoints` to set this post-creation.", "name": "points" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the vertices of this Rope be aligned horizontally (`true`), or vertically (`false`)?", "name": "horizontal" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "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" } ], "memberof": "Phaser.Types.GameObjects.Rope", "longname": "Phaser.Types.GameObjects.Rope.RopeConfig", "scope": "static", "___id": "T000002R015499", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Shader Game Object.\r\n *\r\n * This Game Object allows you to easily add a quad with its own shader\r\n * into the display list, and manipulate it as you would any other Game Object,\r\n * including scaling, rotating, positioning and adding to Containers.\r\n * The Shader can be made interactive and used for input events.\r\n * It can also be used in filters to create visually stunning effects.\r\n *\r\n * It works by creating a custom RenderNode which runs a custom shader program\r\n * to draw a quad. The shader program can be loaded from the Shader Cache,\r\n * or provided in-line as strings.\r\n *\r\n * Please see the Phaser Examples GitHub repo for several examples\r\n * of loading and creating shaders dynamically.\r\n *\r\n * Due to the way in which they work, you cannot directly change the alpha\r\n * of a Shader. It should be handled via uniforms in the shader code itself.\r\n *\r\n * By default, a Shader has a uniform called `uProjectionMatrix`\r\n * which is set automatically.\r\n * You can control additional uniforms using the `setupUniforms` method\r\n * in the Shader configuration object, which runs every time the shader renders.\r\n *\r\n * Shaders are stand-alone renders: they finish any current render batch\r\n * and run once by themselves. As this costs a draw call, you should use them sparingly.\r\n * If you need to have a fully batched custom shader, then please look at using\r\n * a custom RenderNode instead. However, for background or special masking effects,\r\n * they are extremely effective.\r\n *\r\n * Note: be careful when using texture coordinates in shader code.\r\n * The built-in variable `gl_FragCoord` and the default uniform `outTexCoord`\r\n * both use WebGL coordinates, which are `0,0` in the bottom-left.\r\n * Additionally, `gl_FragCoord` says it's in \"window relative\" coordinates.\r\n * But this is actually relative to the framebuffer size.\r\n *\r\n * @example\r\n * // Loading a shader from the cache (good for simple shaders)\r\n * function preload ()\r\n * {\r\n * this.load.glsl('fire', 'shaders/fire.glsl.js');\r\n * }\r\n *\r\n * function create ()\r\n * {\r\n * this.add.shader('fire', 400, 300, 512, 512);\r\n * }\r\n *\r\n * @example\r\n * // Using a configuration object (good for more control)\r\n * function create ()\r\n * {\r\n * this.add.shader({\r\n * fragmentKey: 'fire', // This will be overridden by fragmentSource\r\n * fragmentSource: '// your fragment shader source',\r\n * setupUniforms: (setUniform, drawingContext) => {\r\n * setUniform('time', this.game.loop.getDuration());\r\n * }\r\n * }, 400, 300, 512, 512);\r\n * }\r\n *\r\n * @class Shader\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.17.0\r\n *\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.ComputedSize\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.GetBounds\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {string|Phaser.Types.GameObjects.Shader.ShaderQuadConfig} config - The configuration object this Shader will use. It can also be a key that corresponds to a shader in the shader cache, which will be used as `fragmentKey` in a new config object.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n * @param {string[]|Phaser.Textures.Texture[]} [textures] - The textures that the shader uses, if any. If you intend to define the textures later, use `'__DEFAULT'` as a placeholder, to avoid initialization errors.\r\n */", "meta": { "filename": "Shader.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "classdesc": "A Shader Game Object.\r\rThis Game Object allows you to easily add a quad with its own shader\rinto the display list, and manipulate it as you would any other Game Object,\rincluding scaling, rotating, positioning and adding to Containers.\rThe Shader can be made interactive and used for input events.\rIt can also be used in filters to create visually stunning effects.\r\rIt works by creating a custom RenderNode which runs a custom shader program\rto draw a quad. The shader program can be loaded from the Shader Cache,\ror provided in-line as strings.\r\rPlease see the Phaser Examples GitHub repo for several examples\rof loading and creating shaders dynamically.\r\rDue to the way in which they work, you cannot directly change the alpha\rof a Shader. It should be handled via uniforms in the shader code itself.\r\rBy default, a Shader has a uniform called `uProjectionMatrix`\rwhich is set automatically.\rYou can control additional uniforms using the `setupUniforms` method\rin the Shader configuration object, which runs every time the shader renders.\r\rShaders are stand-alone renders: they finish any current render batch\rand run once by themselves. As this costs a draw call, you should use them sparingly.\rIf you need to have a fully batched custom shader, then please look at using\ra custom RenderNode instead. However, for background or special masking effects,\rthey are extremely effective.\r\rNote: be careful when using texture coordinates in shader code.\rThe built-in variable `gl_FragCoord` and the default uniform `outTexCoord`\rboth use WebGL coordinates, which are `0,0` in the bottom-left.\rAdditionally, `gl_FragCoord` says it's in \"window relative\" coordinates.\rBut this is actually relative to the framebuffer size.", "examples": [ "// Loading a shader from the cache (good for simple shaders)\rfunction preload ()\r{\r this.load.glsl('fire', 'shaders/fire.glsl.js');\r}\r\rfunction create ()\r{\r this.add.shader('fire', 400, 300, 512, 512);\r}", "// Using a configuration object (good for more control)\rfunction create ()\r{\r this.add.shader({\r fragmentKey: 'fire', // This will be overridden by fragmentSource\r fragmentSource: '// your fragment shader source',\r setupUniforms: (setUniform, drawingContext) => {\r setUniform('time', this.game.loop.getDuration());\r }\r }, 400, 300, 512, 512);\r}" ], "kind": "class", "name": "Shader", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.ComputedSize", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.GetBounds", "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "string", "Phaser.Types.GameObjects.Shader.ShaderQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Shader.ShaderQuadConfig" } ] } }, "description": "The configuration object this Shader will use. It can also be a key that corresponds to a shader in the shader cache, which will be used as `fragmentKey` in a new config object.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" }, { "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Textures.Texture", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The textures that the shader uses, if any. If you intend to define the textures later, use `'__DEFAULT'` as a placeholder, to avoid initialization errors.", "name": "textures" } ], "scope": "static", "longname": "Phaser.GameObjects.Shader", "___id": "T000002R015509", "___s": true }, { "comment": "/**\r\n * The textures that the shader uses.\r\n * These will be assigned to texture units 0 to N when the shader is\r\n * rendered, where N is `textures.length - 1`.\r\n *\r\n * @name Phaser.GameObjects.Shader#textures\r\n * @type {Phaser.Textures.Texture[]}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 133, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The textures that the shader uses.\rThese will be assigned to texture units 0 to N when the shader is\rrendered, where N is `textures.length - 1`.", "name": "textures", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Textures.Texture", "type": "NameExpression" } ] } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#textures", "scope": "instance", "kind": "member", "___id": "T000002R015522", "___s": true }, { "comment": "/**\r\n * The underlying RenderNode object that the shader uses to render with.\r\n *\r\n * @name Phaser.GameObjects.Shader#renderNode\r\n * @type {Phaser.Renderer.WebGL.RenderNodes.ShaderQuad}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 144, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The underlying RenderNode object that the shader uses to render with.", "name": "renderNode", "type": { "names": [ "Phaser.Renderer.WebGL.RenderNodes.ShaderQuad" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderNodes.ShaderQuad" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#renderNode", "scope": "instance", "kind": "member", "___id": "T000002R015524", "___s": true }, { "comment": "/**\r\n * The drawing context containing the framebuffer and texture that the shader is rendered to.\r\n * This is only set if the shader is rendering to a texture.\r\n *\r\n * @name Phaser.GameObjects.Shader#drawingContext\r\n * @type {?Phaser.Renderer.WebGL.DrawingContext}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 166, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The drawing context containing the framebuffer and texture that the shader is rendered to.\rThis is only set if the shader is rendering to a texture.", "name": "drawingContext", "type": { "names": [ "Phaser.Renderer.WebGL.DrawingContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.DrawingContext", "nullable": true } }, "nullable": true, "since": "4.0.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#drawingContext", "scope": "instance", "kind": "member", "___id": "T000002R015529", "___s": true }, { "comment": "/**\r\n * A reference to the WebGLTextureWrapper this Shader is rendering to.\r\n * This property is only set if you have called `Shader.setRenderToTexture`.\r\n *\r\n * @name Phaser.GameObjects.Shader#glTexture\r\n * @type {?Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 176, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "A reference to the WebGLTextureWrapper this Shader is rendering to.\rThis property is only set if you have called `Shader.setRenderToTexture`.", "name": "glTexture", "type": { "names": [ "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper", "nullable": true } }, "nullable": true, "since": "3.19.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#glTexture", "scope": "instance", "kind": "member", "___id": "T000002R015531", "___s": true }, { "comment": "/**\r\n * A flag that indicates if this Shader has been set to render to a texture instead of the display list.\r\n *\r\n * This property is `true` if you have called `Shader.setRenderToTexture`, otherwise it's `false`.\r\n *\r\n * A Shader that is rendering to a texture _does not_ appear on the display list.\r\n *\r\n * @name Phaser.GameObjects.Shader#renderToTexture\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 186, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "A flag that indicates if this Shader has been set to render to a texture instead of the display list.\r\rThis property is `true` if you have called `Shader.setRenderToTexture`, otherwise it's `false`.\r\rA Shader that is rendering to a texture _does not_ appear on the display list.", "name": "renderToTexture", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.19.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#renderToTexture", "scope": "instance", "kind": "member", "___id": "T000002R015533", "___s": true }, { "comment": "/**\r\n * A reference to the Phaser.Textures.Texture that has been stored in the Texture Manager for this Shader.\r\n *\r\n * This property is only set if you have called `Shader.setRenderToTexture` with a key, otherwise it is `null`.\r\n *\r\n * @name Phaser.GameObjects.Shader#texture\r\n * @type {Phaser.Textures.Texture}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 200, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "A reference to the Phaser.Textures.Texture that has been stored in the Texture Manager for this Shader.\r\rThis property is only set if you have called `Shader.setRenderToTexture` with a key, otherwise it is `null`.", "name": "texture", "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "since": "3.19.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#texture", "scope": "instance", "kind": "member", "___id": "T000002R015535", "___s": true }, { "comment": "/**\r\n * The top-left texture coordinate of the shader.\r\n * This is set to 0,1 by default. It uses WebGL texture coordinates.\r\n *\r\n * @name Phaser.GameObjects.Shader#textureCoordinateTopLeft\r\n * @type {Phaser.Math.Vector2}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The top-left texture coordinate of the shader.\rThis is set to 0,1 by default. It uses WebGL texture coordinates.", "name": "textureCoordinateTopLeft", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#textureCoordinateTopLeft", "scope": "instance", "kind": "member", "___id": "T000002R015537", "___s": true }, { "comment": "/**\r\n * The top-right texture coordinate of the shader.\r\n * This is set to 1,1 by default. It uses WebGL texture coordinates.\r\n *\r\n * @name Phaser.GameObjects.Shader#textureCoordinateTopRight\r\n * @type {Phaser.Math.Vector2}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 221, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The top-right texture coordinate of the shader.\rThis is set to 1,1 by default. It uses WebGL texture coordinates.", "name": "textureCoordinateTopRight", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#textureCoordinateTopRight", "scope": "instance", "kind": "member", "___id": "T000002R015539", "___s": true }, { "comment": "/**\r\n * The bottom-left texture coordinate of the shader.\r\n * This is set to 0,0 by default. It uses WebGL texture coordinates.\r\n *\r\n * @name Phaser.GameObjects.Shader#textureCoordinateBottomLeft\r\n * @type {Phaser.Math.Vector2}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 231, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The bottom-left texture coordinate of the shader.\rThis is set to 0,0 by default. It uses WebGL texture coordinates.", "name": "textureCoordinateBottomLeft", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#textureCoordinateBottomLeft", "scope": "instance", "kind": "member", "___id": "T000002R015541", "___s": true }, { "comment": "/**\r\n * The bottom-right texture coordinate of the shader.\r\n * This is set to 1,0 by default. It uses WebGL texture coordinates.\r\n *\r\n * @name Phaser.GameObjects.Shader#textureCoordinateBottomRight\r\n * @type {Phaser.Math.Vector2}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 241, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The bottom-right texture coordinate of the shader.\rThis is set to 1,0 by default. It uses WebGL texture coordinates.", "name": "textureCoordinateBottomRight", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#textureCoordinateBottomRight", "scope": "instance", "kind": "member", "___id": "T000002R015543", "___s": true }, { "comment": "/**\r\n * Returns the current value of a uniform from the render node.\r\n * This value is actually copied to all shaders that use it.\r\n * Modifications to non-primitive values such as arrays and objects\r\n * will modify the original.\r\n *\r\n * It's generally better to use the `setupUniforms` function in the\r\n * shader configuration object to set uniform values on changing uniforms.\r\n * This method is provided in the spirit of reading back the values.\r\n *\r\n * @method Phaser.GameObjects.Shader#getUniform\r\n * @since 4.0.0\r\n * @param {string} name - The name of the uniform to get.\r\n * @return {any} The value of the uniform.\r\n */", "meta": { "filename": "Shader.js", "lineno": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Returns the current value of a uniform from the render node.\rThis value is actually copied to all shaders that use it.\rModifications to non-primitive values such as arrays and objects\rwill modify the original.\r\rIt's generally better to use the `setupUniforms` function in the\rshader configuration object to set uniform values on changing uniforms.\rThis method is provided in the spirit of reading back the values.", "kind": "function", "name": "getUniform", "since": "4.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to get.", "name": "name" } ], "returns": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The value of the uniform." } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#getUniform", "scope": "instance", "___id": "T000002R015545", "___s": true }, { "comment": "/**\r\n * Set the value of a uniform in the shader.\r\n * This value is actually copied to all shaders that use it.\r\n *\r\n * It's generally better to use the `setupUniforms` function in the\r\n * shader configuration object to set uniform values on changing uniforms.\r\n * Use this method to set uniforms just once.\r\n *\r\n * @method Phaser.GameObjects.Shader#setUniform\r\n * @since 4.0.0\r\n * @param {string} name - The name of the uniform to set.\r\n * @param {any} value - The value to set the uniform to.\r\n * @return {this}\r\n */", "meta": { "filename": "Shader.js", "lineno": 277, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Set the value of a uniform in the shader.\rThis value is actually copied to all shaders that use it.\r\rIt's generally better to use the `setupUniforms` function in the\rshader configuration object to set uniform values on changing uniforms.\rUse this method to set uniforms just once.", "kind": "function", "name": "setUniform", "since": "4.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the uniform to set.", "name": "name" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The value to set the uniform to.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } } } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setUniform", "scope": "instance", "___id": "T000002R015547", "___s": true }, { "comment": "/**\r\n * Set the textures that the shader uses.\r\n *\r\n * Some shaders don't use any textures. Some may use one or more.\r\n * The textures are assigned to texture units 0 to N when the shader is rendered,\r\n * where N is `textures.length - 1`.\r\n * You must set the uniforms in your shader to match these texture units.\r\n *\r\n * Calling this method will replace the existing textures array with the new one.\r\n *\r\n * @example\r\n * // In the shader source, use the `sampler2D` type.\r\n * sampler2D uMainSampler;\r\n * sampler2D uNormalSampler;\r\n *\r\n * // When creating the shader, set the textures.\r\n * var shader = this.add.shader({\r\n * fragmentKey: 'myShader',\r\n * setupUniforms: (setUniform) => {\r\n * // In the `setupUniforms` function, set the texture to its array position.\r\n * setUniform('uMainSampler', 0);\r\n * setUniform('uNormalSampler', 1);\r\n * }\r\n * }, x, y, width, height, ['metal', 'normal']);\r\n *\r\n * @method Phaser.GameObjects.Shader#setTextures\r\n * @since 4.0.0\r\n * @param {string[]|Phaser.Textures.Texture[]} [textures] - The textures that the shader uses.\r\n */", "meta": { "filename": "Shader.js", "lineno": 297, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Set the textures that the shader uses.\r\rSome shaders don't use any textures. Some may use one or more.\rThe textures are assigned to texture units 0 to N when the shader is rendered,\rwhere N is `textures.length - 1`.\rYou must set the uniforms in your shader to match these texture units.\r\rCalling this method will replace the existing textures array with the new one.", "examples": [ "// In the shader source, use the `sampler2D` type.\rsampler2D uMainSampler;\rsampler2D uNormalSampler;\r\r// When creating the shader, set the textures.\rvar shader = this.add.shader({\r fragmentKey: 'myShader',\r setupUniforms: (setUniform) => {\r // In the `setupUniforms` function, set the texture to its array position.\r setUniform('uMainSampler', 0);\r setUniform('uNormalSampler', 1);\r }\r}, x, y, width, height, ['metal', 'normal']);" ], "kind": "function", "name": "setTextures", "since": "4.0.0", "params": [ { "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Textures.Texture", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The textures that the shader uses.", "name": "textures" } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setTextures", "scope": "instance", "___id": "T000002R015549", "___s": true }, { "comment": "/**\r\n * Changes this Shader so instead of rendering to the display list\r\n * it renders to a WebGL Framebuffer and Texture instead.\r\n * This allows you to use the output of this shader as a texture.\r\n *\r\n * After calling this method the following properties are populated:\r\n * - `Shader.drawingContext`\r\n * - `Shader.glTexture`\r\n *\r\n * Additionally, you can provide a key to this method.\r\n * Doing so will create a Phaser Texture from this Shader,\r\n * store it in `Shader.texture`,\r\n * and save it into the Texture Manager, allowing you to then use it for\r\n * any texture-based Game Object, such as a Sprite or Image:\r\n *\r\n * ```javascript\r\n * var shader = this.add.shader('myShader', x, y, width, height);\r\n *\r\n * shader.setRenderToTexture('doodle');\r\n *\r\n * this.add.image(400, 300, 'doodle');\r\n * ```\r\n *\r\n * Note that it stores an active reference to this Shader. That means as this shader updates,\r\n * so does the texture and any object using it to render with. Also, if you destroy this\r\n * shader, be sure to clear any objects that may have been using it as a texture too.\r\n *\r\n * By default it will create a single base texture. You can add frames to the texture\r\n * by using the `Texture.add` method. After doing this, you can then allow Game Objects\r\n * to use a specific frame from a Render Texture.\r\n *\r\n * If you want to update a texture only sporadically, don't use this method.\r\n * Instead, use a DynamicTexture:\r\n *\r\n * ```javascript\r\n * var shader = this.add.shader('myShader', x, y, width, height);\r\n *\r\n * var dynamic = this.textures.addDynamicTexture('myTexture', shader.width, shader.height);\r\n *\r\n * // To update the texture:\r\n * dynamic.clear().draw(shader).render();\r\n * ```\r\n *\r\n * @method Phaser.GameObjects.Shader#setRenderToTexture\r\n * @since 3.19.0\r\n *\r\n * @param {string} [key] - The unique key to store the texture as within the global Texture Manager.\r\n *\r\n * @return {this} This Shader instance.\r\n */", "meta": { "filename": "Shader.js", "lineno": 345, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Changes this Shader so instead of rendering to the display list\rit renders to a WebGL Framebuffer and Texture instead.\rThis allows you to use the output of this shader as a texture.\r\rAfter calling this method the following properties are populated:\r- `Shader.drawingContext`\r- `Shader.glTexture`\r\rAdditionally, you can provide a key to this method.\rDoing so will create a Phaser Texture from this Shader,\rstore it in `Shader.texture`,\rand save it into the Texture Manager, allowing you to then use it for\rany texture-based Game Object, such as a Sprite or Image:\r\r```javascript\rvar shader = this.add.shader('myShader', x, y, width, height);\r\rshader.setRenderToTexture('doodle');\r\rthis.add.image(400, 300, 'doodle');\r```\r\rNote that it stores an active reference to this Shader. That means as this shader updates,\rso does the texture and any object using it to render with. Also, if you destroy this\rshader, be sure to clear any objects that may have been using it as a texture too.\r\rBy default it will create a single base texture. You can add frames to the texture\rby using the `Texture.add` method. After doing this, you can then allow Game Objects\rto use a specific frame from a Render Texture.\r\rIf you want to update a texture only sporadically, don't use this method.\rInstead, use a DynamicTexture:\r\r```javascript\rvar shader = this.add.shader('myShader', x, y, width, height);\r\rvar dynamic = this.textures.addDynamicTexture('myTexture', shader.width, shader.height);\r\r// To update the texture:\rdynamic.clear().draw(shader).render();\r```", "kind": "function", "name": "setRenderToTexture", "since": "3.19.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The unique key to store the texture as within the global Texture Manager.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shader instance." } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setRenderToTexture", "scope": "instance", "___id": "T000002R015556", "___s": true }, { "comment": "/**\r\n * Render the shader immediately.\r\n * This is useful for a Shader that is not part of the display list,\r\n * but you want to use with `renderToTexture`.\r\n *\r\n * @method Phaser.GameObjects.Shader#renderImmediate\r\n * @since 4.0.0\r\n * @return {this} This Shader instance.\r\n */", "meta": { "filename": "Shader.js", "lineno": 430, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Render the shader immediately.\rThis is useful for a Shader that is not part of the display list,\rbut you want to use with `renderToTexture`.", "kind": "function", "name": "renderImmediate", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shader instance." } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#renderImmediate", "scope": "instance", "___id": "T000002R015570", "___s": true }, { "comment": "/**\r\n * The function which sets uniforms for the shader.\r\n * This is called automatically during rendering.\r\n * It is set from the `config` object passed in the constructor.\r\n * You should use this function to set any uniform values you need for your shader to run.\r\n *\r\n * You can set this function directly after object creation,\r\n * but it's recommended to use the `config` object\r\n * to keep your logic encapsulated.\r\n *\r\n * The function is invoked with two arguments: `setUniform` and `drawingContext`.\r\n * `setUniform` is a function that takes two arguments: a string (the name of the uniform) and a value.\r\n * Ensure that the value matches the expected type in the shader.\r\n * You don't need to be too precise, as the system will convert\r\n * e.g. Array and Float32Array types as needed.\r\n * To set an array in a shader, append `[0]` to the uniform name.\r\n * `drawingContext` is a reference to the current drawing context,\r\n * which may be useful if you need to query the camera or similar.\r\n *\r\n * Note that `uProjectionMatrix` is set for you automatically.\r\n *\r\n * @method Phaser.GameObjects.Shader#setupUniforms\r\n * @since 4.0.0\r\n * @param {function} setUniform - The function which sets uniforms. `(name: string, value: any) => void`.\r\n * @param {Phaser.Renderer.WebGL.DrawingContext} drawingContext - A reference to the current drawing context.\r\n */", "meta": { "filename": "Shader.js", "lineno": 446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "The function which sets uniforms for the shader.\rThis is called automatically during rendering.\rIt is set from the `config` object passed in the constructor.\rYou should use this function to set any uniform values you need for your shader to run.\r\rYou can set this function directly after object creation,\rbut it's recommended to use the `config` object\rto keep your logic encapsulated.\r\rThe function is invoked with two arguments: `setUniform` and `drawingContext`.\r`setUniform` is a function that takes two arguments: a string (the name of the uniform) and a value.\rEnsure that the value matches the expected type in the shader.\rYou don't need to be too precise, as the system will convert\re.g. Array and Float32Array types as needed.\rTo set an array in a shader, append `[0]` to the uniform name.\r`drawingContext` is a reference to the current drawing context,\rwhich may be useful if you need to query the camera or similar.\r\rNote that `uProjectionMatrix` is set for you automatically.", "kind": "function", "name": "setupUniforms", "since": "4.0.0", "params": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The function which sets uniforms. `(name: string, value: any) => void`.", "name": "setUniform" }, { "type": { "names": [ "Phaser.Renderer.WebGL.DrawingContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.DrawingContext" } }, "description": "A reference to the current drawing context.", "name": "drawingContext" } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setupUniforms", "scope": "instance", "___id": "T000002R015572", "___s": true }, { "comment": "/**\r\n * Set the texture coordinates of the shader.\r\n * These values are used to provide texture mapping to the shader,\r\n * and are commonly used to drive generative output.\r\n *\r\n * By default, the shader uses the whole texture, the range 0-1.\r\n * The coordinates are in WebGL texture space, which is 0,0 in the bottom-left.\r\n * This method allows you to specify a region of the texture to use,\r\n * or even go outside the 0-1 bounds.\r\n * This can be useful if you want to use a single frame from a texture,\r\n * repeat the shader's texture, use a larger numeric range,\r\n * or distort the shader.\r\n *\r\n * Note that a quad is made of two triangles, divided by the diagonal\r\n * from the top-left to the bottom-right. This means that some permutations\r\n * of coordinates may affect just one or the other triangle.\r\n * This can cause abrupt warping along the diagonal.\r\n * Keep an eye on your output. Rectangles and parallelograms are safe bets.\r\n * So are rotation and scaling transforms. Moving a single point is risky.\r\n *\r\n * Call this method with no arguments to reset the shader to use the whole texture.\r\n *\r\n * @method Phaser.GameObjects.Shader#setTextureCoordinates\r\n * @since 4.0.0\r\n * @param {number} [topLeftX=0] - The top-left x coordinate of the texture.\r\n * @param {number} [topLeftY=1] - The top-left y coordinate of the texture.\r\n * @param {number} [topRightX=1] - The top-right x coordinate of the texture.\r\n * @param {number} [topRightY=1] - The top-right y coordinate of the texture.\r\n * @param {number} [bottomLeftX=0] - The bottom-left x coordinate of the texture.\r\n * @param {number} [bottomLeftY=0] - The bottom-left y coordinate of the texture.\r\n * @param {number} [bottomRightX=1] - The bottom-right x coordinate of the texture.\r\n * @param {number} [bottomRightY=0] - The bottom-right y coordinate of the texture.\r\n * @return {this} This Shader instance\r\n */", "meta": { "filename": "Shader.js", "lineno": 491, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Set the texture coordinates of the shader.\rThese values are used to provide texture mapping to the shader,\rand are commonly used to drive generative output.\r\rBy default, the shader uses the whole texture, the range 0-1.\rThe coordinates are in WebGL texture space, which is 0,0 in the bottom-left.\rThis method allows you to specify a region of the texture to use,\ror even go outside the 0-1 bounds.\rThis can be useful if you want to use a single frame from a texture,\rrepeat the shader's texture, use a larger numeric range,\ror distort the shader.\r\rNote that a quad is made of two triangles, divided by the diagonal\rfrom the top-left to the bottom-right. This means that some permutations\rof coordinates may affect just one or the other triangle.\rThis can cause abrupt warping along the diagonal.\rKeep an eye on your output. Rectangles and parallelograms are safe bets.\rSo are rotation and scaling transforms. Moving a single point is risky.\r\rCall this method with no arguments to reset the shader to use the whole texture.", "kind": "function", "name": "setTextureCoordinates", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The top-left x coordinate of the texture.", "name": "topLeftX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The top-left y coordinate of the texture.", "name": "topLeftY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The top-right x coordinate of the texture.", "name": "topRightX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The top-right y coordinate of the texture.", "name": "topRightY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The bottom-left x coordinate of the texture.", "name": "bottomLeftX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The bottom-left y coordinate of the texture.", "name": "bottomLeftY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The bottom-right x coordinate of the texture.", "name": "bottomRightX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The bottom-right y coordinate of the texture.", "name": "bottomRightY" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shader instance" } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setTextureCoordinates", "scope": "instance", "___id": "T000002R015576", "___s": true }, { "comment": "/**\r\n * Set the texture coordinates of the shader from a frame.\r\n * This is a convenience method that sets the texture coordinates\r\n * to match a frame from a texture.\r\n *\r\n * @method Phaser.GameObjects.Shader#setTextureCoordinatesFromFrame\r\n * @since 4.0.0\r\n * @param {Phaser.Textures.Frame|string} frame - The frame to set the texture coordinates from. If a string is given, it will be used to look up the frame in the texture.\r\n * @param {Phaser.Textures.Texture|string} [texture] - The texture that the frame is from. This is only used if `frame` is a string. If a string is given, it will be used to look up the texture in the Texture Manager. If not given, the first member of `Shader.textures` is used. If `Shader.textures` is empty, an error will occur.\r\n */", "meta": { "filename": "Shader.js", "lineno": 549, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Set the texture coordinates of the shader from a frame.\rThis is a convenience method that sets the texture coordinates\rto match a frame from a texture.", "kind": "function", "name": "setTextureCoordinatesFromFrame", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Textures.Frame", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Textures.Frame" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The frame to set the texture coordinates from. If a string is given, it will be used to look up the frame in the texture.", "name": "frame" }, { "type": { "names": [ "Phaser.Textures.Texture", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Textures.Texture" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "description": "The texture that the frame is from. This is only used if `frame` is a string. If a string is given, it will be used to look up the texture in the Texture Manager. If not given, the first member of `Shader.textures` is used. If `Shader.textures` is empty, an error will occur.", "name": "texture" } ], "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#setTextureCoordinatesFromFrame", "scope": "instance", "___id": "T000002R015586", "___s": true }, { "comment": "/**\r\n * Internal destroy handler, called as part of the destroy process.\r\n *\r\n * @method Phaser.GameObjects.Shader#preDestroy\r\n * @protected\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Shader.js", "lineno": 582, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Internal destroy handler, called as part of the destroy process.", "kind": "function", "name": "preDestroy", "access": "protected", "since": "3.17.0", "memberof": "Phaser.GameObjects.Shader", "longname": "Phaser.GameObjects.Shader#preDestroy", "scope": "instance", "___id": "T000002R015595", "___s": true }, { "comment": "/**\r\n * Creates a new Shader Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Shader Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#shader\r\n * @since 3.17.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Shader.ShaderConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Shader} The Game Object that was created.\r\n */", "meta": { "filename": "ShaderCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Creates a new Shader Game Object and returns it.\r\rNote: 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": [ "Phaser.Types.GameObjects.Shader.ShaderConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Shader.ShaderConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Shader" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#shader", "scope": "instance", "___id": "T000002R015610", "___s": true }, { "comment": "/**\r\n * Creates a new Shader Game Object and adds it to the Scene.\r\n *\r\n * A Shader Game Object renders a custom GLSL fragment shader as a rectangular Game Object, allowing you to\r\n * display procedural visual effects, generative graphics, or post-processing-style visuals directly within\r\n * your game world. The shader runs on the GPU and can receive custom uniforms as well as up to four texture\r\n * channel inputs (iChannel0 to iChannel3), making it compatible with shaders written in the Shadertoy style.\r\n *\r\n * Note: This method will only be available if the Shader Game Object and WebGL support have been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#shader\r\n * @webglOnly\r\n * @since 3.17.0\r\n *\r\n * @param {(string|Phaser.Types.GameObjects.Shader.ShaderQuadConfig)} config - The configuration object this Shader will use. It can also be a key that corresponds to a shader in the shader cache, which will be used as `fragmentKey` in a new config object.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the Game Object.\r\n * @param {number} [height=128] - The height of the Game Object.\r\n * @param {string[]} [textures] - Optional array of texture keys to bind to the iChannel0...3 uniforms. The textures must already exist in the Texture Manager.\r\n *\r\n * @return {Phaser.GameObjects.Shader} The Game Object that was created.\r\n */", "meta": { "filename": "ShaderFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader", "code": {} }, "description": "Creates a new Shader Game Object and adds it to the Scene.\r\rA Shader Game Object renders a custom GLSL fragment shader as a rectangular Game Object, allowing you to\rdisplay procedural visual effects, generative graphics, or post-processing-style visuals directly within\ryour game world. The shader runs on the GPU and can receive custom uniforms as well as up to four texture\rchannel inputs (iChannel0 to iChannel3), making it compatible with shaders written in the Shadertoy style.\r\rNote: This method will only be available if the Shader Game Object and WebGL support have been built into Phaser.", "kind": "function", "name": "shader", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "3.17.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.Shader.ShaderQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Shader.ShaderQuadConfig" } ] } }, "description": "The configuration object this Shader will use. It can also be a key that corresponds to a shader in the shader cache, which will be used as `fragmentKey` in a new config object.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "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" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Shader" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Shader" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#shader", "scope": "instance", "___id": "T000002R015621", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Shader\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader\\typedefs", "code": {} }, "kind": "namespace", "name": "Shader", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Shader", "scope": "static", "___id": "T000002R015637", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Shader.ShaderConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 3.50.0\r\n *\r\n * @property {string|Phaser.Types.GameObjects.Shader.ShaderQuadConfig} config - The configuration object this Shader will use. It can also be a key that corresponds to a shader in the shader cache, which will be used as `fragmentKey` in a new config object.\r\n * @property {number} [width=128] - The width of the Game Object.\r\n * @property {number} [height=128] - The height of the Game Object.\r\n */", "meta": { "filename": "ShaderConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader\\typedefs", "code": {} }, "kind": "typedef", "name": "ShaderConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "3.50.0", "properties": [ { "type": { "names": [ "string", "Phaser.Types.GameObjects.Shader.ShaderQuadConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Shader.ShaderQuadConfig" } ] } }, "description": "The configuration object this Shader will use. It can also be a key that corresponds to a shader in the shader cache, which will be used as `fragmentKey` in a new config object.", "name": "config" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the Game Object.", "name": "height" } ], "memberof": "Phaser.Types.GameObjects.Shader", "longname": "Phaser.Types.GameObjects.Shader.ShaderConfig", "scope": "static", "___id": "T000002R015638", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Shader.ShaderQuadConfig\r\n * @since 4.0.0\r\n *\r\n * @property {string} name - The name of the render node. This is also used for `shaderName` if not set.\r\n * @property {string} [shaderName] - The name of the shader. This is used as the stub for the internal shader name. If another shader with the same name exists, that will be used instead, so it's best to use a unique name.\r\n * @property {string} [fragmentSource] - The fragment shader source code. This overrides anything set in `fragmentKey`.\r\n * @property {string} [vertexSource] - The vertex shader source code. This overrides anything set in `vertexKey`.\r\n * @property {string} [fragmentKey] - The key of the fragment shader source to use from the shader cache.\r\n * @property {string} [vertexKey] - The key of the vertex shader source to use from the shader cache.\r\n * @property {function} [setupUniforms] - A function that sets any uniform values that the shader needs. It takes two parameters: `setUniform` and `drawingContext`. `setUniform` is a function `(name: string, value: any) => void` that you can call to set a uniform value. `drawingContext` is the current drawing context.\r\n * @property {object} [initialUniforms] - An object containing the initial uniform values to set. The keys are the uniform names, and the values are the uniform values. This is used to set up the shader before it is rendered for the first time.\r\n * @property {Phaser.Types.Renderer.WebGL.ShaderAdditionConfig[]} [shaderAdditions] - Additional snippets to add to the shader. An advanced configuration option. You can use `updateShaderConfig` to edit these at render time, resulting in different shaders.\r\n * @property {function} [updateShaderConfig] - A function that updates the shader configuration. An advanced configuration option. It takes three parameters: `drawingContext`, `gameObject`, `renderNode`. `drawingContext` is the current drawing context. `gameObject` is the object which is rendering. `renderNode` is the ShaderQuad render node which invoked the function.\r\n */", "meta": { "filename": "ShaderQuadConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shader\\typedefs", "code": {} }, "kind": "typedef", "name": "ShaderQuadConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the render node. This is also used for `shaderName` if not set.", "name": "name" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The name of the shader. This is used as the stub for the internal shader name. If another shader with the same name exists, that will be used instead, so it's best to use a unique name.", "name": "shaderName" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The fragment shader source code. This overrides anything set in `fragmentKey`.", "name": "fragmentSource" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The vertex shader source code. This overrides anything set in `vertexKey`.", "name": "vertexSource" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The key of the fragment shader source to use from the shader cache.", "name": "fragmentKey" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The key of the vertex shader source to use from the shader cache.", "name": "vertexKey" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "A function that sets any uniform values that the shader needs. It takes two parameters: `setUniform` and `drawingContext`. `setUniform` is a function `(name: string, value: any) => void` that you can call to set a uniform value. `drawingContext` is the current drawing context.", "name": "setupUniforms" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "An object containing the initial uniform values to set. The keys are the uniform names, and the values are the uniform values. This is used to set up the shader before it is rendered for the first time.", "name": "initialUniforms" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Renderer.WebGL.ShaderAdditionConfig", "type": "NameExpression" } ] } }, "optional": true, "description": "Additional snippets to add to the shader. An advanced configuration option. You can use `updateShaderConfig` to edit these at render time, resulting in different shaders.", "name": "shaderAdditions" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "optional": true, "description": "A function that updates the shader configuration. An advanced configuration option. It takes three parameters: `drawingContext`, `gameObject`, `renderNode`. `drawingContext` is the current drawing context. `gameObject` is the object which is rendering. `renderNode` is the ShaderQuad render node which invoked the function.", "name": "updateShaderConfig" } ], "memberof": "Phaser.Types.GameObjects.Shader", "longname": "Phaser.Types.GameObjects.Shader.ShaderQuadConfig", "scope": "static", "___id": "T000002R015639", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Arc Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports both fill and stroke colors.\r\n *\r\n * When it renders it displays an arc shape. You can control the start and end angles of the arc,\r\n * as well as if the angles are winding clockwise or anti-clockwise. With the default settings\r\n * it renders as a complete circle. By changing the angles you can create other arc shapes,\r\n * such as half-circles.\r\n *\r\n * Arcs also have an `iterations` property and corresponding `setIterations` method. This allows\r\n * you to control how smooth the shape renders in WebGL, by controlling the number of iterations\r\n * that take place during construction.\r\n *\r\n * @class Arc\r\n * @extends Phaser.GameObjects.Shape\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.13.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [radius=128] - The radius of the arc.\r\n * @param {number} [startAngle=0] - The start angle of the arc, in degrees.\r\n * @param {number} [endAngle=360] - The end angle of the arc, in degrees.\r\n * @param {boolean} [anticlockwise=false] - The winding order of the start and end angles.\r\n * @param {number} [fillColor] - The color the arc will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the arc will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n */", "meta": { "filename": "Arc.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "classdesc": "The Arc Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports both fill and stroke colors.\r\rWhen it renders it displays an arc shape. You can control the start and end angles of the arc,\ras well as if the angles are winding clockwise or anti-clockwise. With the default settings\rit renders as a complete circle. By changing the angles you can create other arc shapes,\rsuch as half-circles.\r\rArcs also have an `iterations` property and corresponding `setIterations` method. This allows\ryou to control how smooth the shape renders in WebGL, by controlling the number of iterations\rthat take place during construction.", "kind": "class", "name": "Arc", "augments": [ "Phaser.GameObjects.Shape" ], "memberof": "Phaser.GameObjects", "since": "3.13.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The radius of the arc.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The start angle of the arc, in degrees.", "name": "startAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 360, "description": "The end angle of the arc, in degrees.", "name": "endAngle" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "The winding order of the start and end angles.", "name": "anticlockwise" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the arc will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R015647", "___s": true }, { "comment": "/**\r\n * The number of iterations used when drawing the arc.\r\n * Increase this value for smoother arcs, at the cost of more polygons being rendered.\r\n * Modify this value by small amounts, such as 0.01.\r\n *\r\n * @name Phaser.GameObjects.Arc#iterations\r\n * @type {number}\r\n * @default 0.01\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Arc.js", "lineno": 125, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "description": "The number of iterations used when drawing the arc.\rIncrease this value for smoother arcs, at the cost of more polygons being rendered.\rModify this value by small amounts, such as 0.01.", "name": "iterations", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.01", "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "longname": "Phaser.GameObjects.Arc#iterations", "scope": "instance", "kind": "member", "___id": "T000002R015667", "___s": true }, { "comment": "/**\r\n * The radius of the arc, in pixels. Changing this value also updates the size of the\r\n * Game Object and triggers a recalculation of its geometry data.\r\n *\r\n * @name Phaser.GameObjects.Arc#radius\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Arc.js", "lineno": 151, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "description": "The radius of the arc, in pixels. Changing this value also updates the size of the\rGame Object and triggers a recalculation of its geometry data.", "name": "radius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "longname": "Phaser.GameObjects.Arc#radius", "scope": "instance", "kind": "member", "___id": "T000002R015672", "___s": true }, { "comment": "/**\r\n * The start angle of the arc, in degrees.\r\n *\r\n * @name Phaser.GameObjects.Arc#startAngle\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Arc.js", "lineno": 178, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "description": "The start angle of the arc, in degrees.", "name": "startAngle", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "longname": "Phaser.GameObjects.Arc#startAngle", "scope": "instance", "kind": "member", "___id": "T000002R015678", "___s": true }, { "comment": "/**\r\n * The end angle of the arc, in degrees.\r\n *\r\n * @name Phaser.GameObjects.Arc#endAngle\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Arc.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "description": "The end angle of the arc, in degrees.", "name": "endAngle", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "longname": "Phaser.GameObjects.Arc#endAngle", "scope": "instance", "kind": "member", "___id": "T000002R015683", "___s": true }, { "comment": "/**\r\n * The winding order of the start and end angles. If `true` the arc is drawn anti-clockwise\r\n * (counter-clockwise), otherwise it is drawn clockwise. This affects which direction the\r\n * arc sweeps between the start and end angles.\r\n *\r\n * @name Phaser.GameObjects.Arc#anticlockwise\r\n * @type {boolean}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Arc.js", "lineno": 224, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "description": "The winding order of the start and end angles. If `true` the arc is drawn anti-clockwise\r(counter-clockwise), otherwise it is drawn clockwise. This affects which direction the\rarc sweeps between the start and end angles.", "name": "anticlockwise", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Arc", "longname": "Phaser.GameObjects.Arc#anticlockwise", "scope": "instance", "kind": "member", "___id": "T000002R015688", "___s": true }, { "comment": "/**\r\n * Sets the radius of the arc.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Arc#setRadius\r\n * @since 3.13.0\r\n *\r\n * @param {number} value - The value to set the radius to.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Arc.js", "lineno": 249, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "description": "Sets the radius of the arc.\rThis call can be chained.", "kind": "function", "name": "setRadius", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to set the radius to.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "longname": "Phaser.GameObjects.Arc#setRadius", "scope": "instance", "___id": "T000002R015693", "___s": true }, { "comment": "/**\r\n * Sets the number of iterations used when drawing the arc.\r\n * Increase this value for smoother arcs, at the cost of more polygons being rendered.\r\n * Modify this value by small amounts, such as 0.01.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Arc#setIterations\r\n * @since 3.13.0\r\n *\r\n * @param {number} value - The value to set the iterations to.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Arc.js", "lineno": 267, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "description": "Sets the number of iterations used when drawing the arc.\rIncrease this value for smoother arcs, at the cost of more polygons being rendered.\rModify this value by small amounts, such as 0.01.\rThis call can be chained.", "kind": "function", "name": "setIterations", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to set the iterations to.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "longname": "Phaser.GameObjects.Arc#setIterations", "scope": "instance", "___id": "T000002R015696", "___s": true }, { "comment": "/**\r\n * Sets the starting angle of the arc, in degrees. Optionally also updates the winding order.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Arc#setStartAngle\r\n * @since 3.13.0\r\n *\r\n * @param {number} value - The value to set the starting angle to.\r\n * @param {boolean} [anticlockwise] - If `true` the arc will be drawn anti-clockwise. If `false` it will be drawn clockwise. If not given, the current `anticlockwise` property value is used.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Arc.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "description": "Sets the starting angle of the arc, in degrees. Optionally also updates the winding order.\rThis call can be chained.", "kind": "function", "name": "setStartAngle", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to set the starting angle to.", "name": "value" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If `true` the arc will be drawn anti-clockwise. If `false` it will be drawn clockwise. If not given, the current `anticlockwise` property value is used.", "name": "anticlockwise" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "longname": "Phaser.GameObjects.Arc#setStartAngle", "scope": "instance", "___id": "T000002R015700", "___s": true }, { "comment": "/**\r\n * Sets the ending angle of the arc, in degrees. Optionally also updates the winding order.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Arc#setEndAngle\r\n * @since 3.13.0\r\n *\r\n * @param {number} value - The value to set the ending angle to.\r\n * @param {boolean} [anticlockwise] - If `true` the arc will be drawn anti-clockwise. If `false` it will be drawn clockwise. If not given, the current `anticlockwise` property value is used.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Arc.js", "lineno": 313, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "description": "Sets the ending angle of the arc, in degrees. Optionally also updates the winding order.\rThis call can be chained.", "kind": "function", "name": "setEndAngle", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to set the ending angle to.", "name": "value" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "If `true` the arc will be drawn anti-clockwise. If `false` it will be drawn clockwise. If not given, the current `anticlockwise` property value is used.", "name": "anticlockwise" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Arc", "longname": "Phaser.GameObjects.Arc#setEndAngle", "scope": "instance", "___id": "T000002R015704", "___s": true }, { "comment": "/**\r\n * Creates a new Arc Shape Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Arc Game Object has been built into Phaser.\r\n *\r\n * The Arc Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports both fill and stroke colors.\r\n *\r\n * When it renders it displays an arc shape. You can control the start and end angles of the arc,\r\n * as well as if the angles are winding clockwise or anti-clockwise. With the default settings\r\n * it renders as a complete circle. By changing the angles you can create other arc shapes,\r\n * such as half-circles.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#arc\r\n * @since 3.13.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [radius=128] - The radius of the arc.\r\n * @param {number} [startAngle=0] - The start angle of the arc, in degrees.\r\n * @param {number} [endAngle=360] - The end angle of the arc, in degrees.\r\n * @param {boolean} [anticlockwise=false] - Whether the arc is drawn anticlockwise between the start and end angles. When `false` the arc is drawn clockwise.\r\n * @param {number} [fillColor] - The color the arc will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the arc will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n *\r\n * @return {Phaser.GameObjects.Arc} The Game Object that was created.\r\n */", "meta": { "filename": "ArcFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "description": "Creates a new Arc Shape Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Arc Game Object has been built into Phaser.\r\rThe Arc Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports both fill and stroke colors.\r\rWhen it renders it displays an arc shape. You can control the start and end angles of the arc,\ras well as if the angles are winding clockwise or anti-clockwise. With the default settings\rit renders as a complete circle. By changing the angles you can create other arc shapes,\rsuch as half-circles.", "kind": "function", "name": "arc", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The radius of the arc.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The start angle of the arc, in degrees.", "name": "startAngle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 360, "description": "The end angle of the arc, in degrees.", "name": "endAngle" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether the arc is drawn anticlockwise between the start and end angles. When `false` the arc is drawn clockwise.", "name": "anticlockwise" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the arc will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Arc" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#arc", "scope": "instance", "___id": "T000002R015742", "___s": true }, { "comment": "/**\r\n * Creates a new Circle Shape Game Object and adds it to the Scene.\r\n *\r\n * A Circle is an Arc with a fixed start angle of 0 and end angle of 360 degrees, so it always renders as a complete circle. Use the `arc` factory method if you need control over the start and end angles.\r\n *\r\n * Note: This method will only be available if the Arc Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#circle\r\n * @since 3.13.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [radius=128] - The radius of the circle.\r\n * @param {number} [fillColor] - The color the circle will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the circle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n *\r\n * @return {Phaser.GameObjects.Arc} The Game Object that was created.\r\n */", "meta": { "filename": "ArcFactory.js", "lineno": 46, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\arc", "code": {} }, "description": "Creates a new Circle Shape Game Object and adds it to the Scene.\r\rA Circle is an Arc with a fixed start angle of 0 and end angle of 360 degrees, so it always renders as a complete circle. Use the `arc` factory method if you need control over the start and end angles.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The radius of the circle.", "name": "radius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the circle will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Arc" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#circle", "scope": "instance", "___id": "T000002R015743", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Curve Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports both fill and stroke colors.\r\n *\r\n * To render a Curve Shape you must first create a `Phaser.Curves.Curve` object, then pass it to\r\n * the Curve Shape in the constructor.\r\n *\r\n * The Curve shape also has a `smoothness` property and corresponding `setSmoothness` method.\r\n * This allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations\r\n * that take place during construction. Increase and decrease the default value for smoother, or more\r\n * jagged, shapes.\r\n *\r\n * @class Curve\r\n * @extends Phaser.GameObjects.Shape\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.13.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {Phaser.Curves.Curve} [curve] - The Curve object to use to create the Shape.\r\n * @param {number} [fillColor] - The color the curve will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the curve will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n */", "meta": { "filename": "Curve.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\curve", "code": {} }, "classdesc": "The Curve Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports both fill and stroke colors.\r\rTo render a Curve Shape you must first create a `Phaser.Curves.Curve` object, then pass it to\rthe Curve Shape in the constructor.\r\rThe Curve shape also has a `smoothness` property and corresponding `setSmoothness` method.\rThis allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations\rthat take place during construction. Increase and decrease the default value for smoother, or more\rjagged, shapes.", "kind": "class", "name": "Curve", "augments": [ "Phaser.GameObjects.Shape" ], "memberof": "Phaser.GameObjects", "since": "3.13.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "Phaser.Curves.Curve" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Curves.Curve" } }, "optional": true, "description": "The Curve object to use to create the Shape.", "name": "curve" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the curve will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R015769", "___s": true }, { "comment": "/**\r\n * The smoothness of the curve. The number of points used when rendering it.\r\n * Increase this value for smoother curves, at the cost of more polygons being rendered.\r\n *\r\n * @name Phaser.GameObjects.Curve#smoothness\r\n * @type {number}\r\n * @default 32\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Curve.js", "lineno": 94, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\curve", "code": {} }, "description": "The smoothness of the curve. The number of points used when rendering it.\rIncrease this value for smoother curves, at the cost of more polygons being rendered.", "name": "smoothness", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "32", "since": "3.13.0", "memberof": "Phaser.GameObjects.Curve", "longname": "Phaser.GameObjects.Curve#smoothness", "scope": "instance", "kind": "member", "___id": "T000002R015781", "___s": true }, { "comment": "/**\r\n * Sets the smoothness of the curve. The number of points used when rendering it.\r\n * Increase this value for smoother curves, at the cost of more polygons being rendered.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Curve#setSmoothness\r\n * @since 3.13.0\r\n *\r\n * @param {number} value - The value to set the smoothness to.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Curve.js", "lineno": 119, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\curve", "code": {} }, "description": "Sets the smoothness of the curve. The number of points used when rendering it.\rIncrease this value for smoother curves, at the cost of more polygons being rendered.\rThis call can be chained.", "kind": "function", "name": "setSmoothness", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to set the smoothness to.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Curve", "longname": "Phaser.GameObjects.Curve#setSmoothness", "scope": "instance", "___id": "T000002R015786", "___s": true }, { "comment": "/**\r\n * Creates a new Curve Shape Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Curve Game Object has been built into Phaser.\r\n *\r\n * The Curve Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports both fill and stroke colors.\r\n *\r\n * To render a Curve Shape you must first create a `Phaser.Curves.Curve` object, then pass it to\r\n * the Curve Shape in the constructor.\r\n *\r\n * The Curve shape also has a `smoothness` property and corresponding `setSmoothness` method.\r\n * This allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations\r\n * that take place during construction. Increase and decrease the default value for smoother, or more\r\n * jagged, shapes.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#curve\r\n * @since 3.13.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {Phaser.Curves.Curve} [curve] - The Curve object to use to create the Shape.\r\n * @param {number} [fillColor] - The color the curve will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the curve will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n *\r\n * @return {Phaser.GameObjects.Curve} The Game Object that was created.\r\n */", "meta": { "filename": "CurveFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\curve", "code": {} }, "description": "Creates a new Curve Shape Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Curve Game Object has been built into Phaser.\r\rThe Curve Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports both fill and stroke colors.\r\rTo render a Curve Shape you must first create a `Phaser.Curves.Curve` object, then pass it to\rthe Curve Shape in the constructor.\r\rThe Curve shape also has a `smoothness` property and corresponding `setSmoothness` method.\rThis allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations\rthat take place during construction. Increase and decrease the default value for smoother, or more\rjagged, shapes.", "kind": "function", "name": "curve", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "Phaser.Curves.Curve" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Curves.Curve" } }, "optional": true, "description": "The Curve object to use to create the Shape.", "name": "curve" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the curve will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Curve" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#curve", "scope": "instance", "___id": "T000002R015819", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Ellipse Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports both fill and stroke colors.\r\n *\r\n * When it renders it displays an ellipse shape. You can control the width and height of the ellipse.\r\n * If the width and height match it will render as a circle. If the width is less than the height,\r\n * it will look more like an egg shape.\r\n *\r\n * The Ellipse shape also has a `smoothness` property and corresponding `setSmoothness` method.\r\n * This allows you to control how smooth the shape renders in WebGL, by controlling the number of points\r\n * used to approximate the curve. Increase the default value for smoother shapes, or decrease it for\r\n * more jagged, lower-polygon results.\r\n *\r\n * @class Ellipse\r\n * @extends Phaser.GameObjects.Shape\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.13.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the ellipse. An ellipse with equal width and height renders as a circle.\r\n * @param {number} [height=128] - The height of the ellipse. An ellipse with equal width and height renders as a circle.\r\n * @param {number} [fillColor] - The color the ellipse will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the ellipse will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\ellipse", "code": {} }, "classdesc": "The Ellipse Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports both fill and stroke colors.\r\rWhen it renders it displays an ellipse shape. You can control the width and height of the ellipse.\rIf the width and height match it will render as a circle. If the width is less than the height,\rit will look more like an egg shape.\r\rThe Ellipse shape also has a `smoothness` property and corresponding `setSmoothness` method.\rThis allows you to control how smooth the shape renders in WebGL, by controlling the number of points\rused to approximate the curve. Increase the default value for smoother shapes, or decrease it for\rmore jagged, lower-polygon results.", "kind": "class", "name": "Ellipse", "augments": [ "Phaser.GameObjects.Shape" ], "memberof": "Phaser.GameObjects", "since": "3.13.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the ellipse will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R015845", "___s": true }, { "comment": "/**\r\n * The smoothness of the ellipse. The number of points used when rendering it.\r\n * Increase this value for a smoother ellipse, at the cost of more polygons being rendered.\r\n *\r\n * @name Phaser.GameObjects.Ellipse#smoothness\r\n * @type {number}\r\n * @default 64\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 89, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\ellipse", "code": {} }, "description": "The smoothness of the ellipse. The number of points used when rendering it.\rIncrease this value for a smoother ellipse, at the cost of more polygons being rendered.", "name": "smoothness", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "64", "since": "3.13.0", "memberof": "Phaser.GameObjects.Ellipse", "longname": "Phaser.GameObjects.Ellipse#smoothness", "scope": "instance", "kind": "member", "___id": "T000002R015858", "___s": true }, { "comment": "/**\r\n * Sets the size of the ellipse by changing the underlying geometry data, rather than scaling the object.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Ellipse#setSize\r\n * @since 3.13.0\r\n *\r\n * @param {number} width - The width of the ellipse.\r\n * @param {number} height - The height of the ellipse.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 114, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\ellipse", "code": {} }, "description": "Sets the size of the ellipse by changing the underlying geometry data, rather than scaling the object.\rThis call can be chained.", "kind": "function", "name": "setSize", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the ellipse.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the ellipse.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "longname": "Phaser.GameObjects.Ellipse#setSize", "scope": "instance", "overrides": "Phaser.GameObjects.Shape#setSize", "___id": "T000002R015863", "___s": true }, { "comment": "/**\r\n * Sets the smoothness of the ellipse, controlling the number of points used when rendering it.\r\n * Increase this value for a smoother ellipse, at the cost of more polygons being rendered.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Ellipse#setSmoothness\r\n * @since 3.13.0\r\n *\r\n * @param {number} value - The value to set the smoothness to.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 138, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\ellipse", "code": {} }, "description": "Sets the smoothness of the ellipse, controlling the number of points used when rendering it.\rIncrease this value for a smoother ellipse, at the cost of more polygons being rendered.\rThis call can be chained.", "kind": "function", "name": "setSmoothness", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to set the smoothness to.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Ellipse", "longname": "Phaser.GameObjects.Ellipse#setSmoothness", "scope": "instance", "___id": "T000002R015867", "___s": true }, { "comment": "/**\r\n * Creates a new Ellipse Shape Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Ellipse Game Object has been built into Phaser.\r\n *\r\n * The Ellipse Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports both fill and stroke colors.\r\n *\r\n * When it renders it displays an ellipse shape. You can control the width and height of the ellipse.\r\n * If the width and height match it will render as a circle. If the width is less than the height,\r\n * it will look more like an egg shape.\r\n *\r\n * The Ellipse shape also has a `smoothness` property and corresponding `setSmoothness` method.\r\n * This allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations\r\n * that take place during construction. Increase and decrease the default value for smoother, or more\r\n * jagged, shapes.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#ellipse\r\n * @since 3.13.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the ellipse. An ellipse with equal width and height renders as a circle.\r\n * @param {number} [height=128] - The height of the ellipse. An ellipse with equal width and height renders as a circle.\r\n * @param {number} [fillColor] - The color the ellipse will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the ellipse will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n *\r\n * @return {Phaser.GameObjects.Ellipse} The Game Object that was created.\r\n */", "meta": { "filename": "EllipseFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\ellipse", "code": {} }, "description": "Creates a new Ellipse Shape Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Ellipse Game Object has been built into Phaser.\r\rThe Ellipse Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports both fill and stroke colors.\r\rWhen it renders it displays an ellipse shape. You can control the width and height of the ellipse.\rIf the width and height match it will render as a circle. If the width is less than the height,\rit will look more like an egg shape.\r\rThe Ellipse shape also has a `smoothness` property and corresponding `setSmoothness` method.\rThis allows you to control how smooth the shape renders in WebGL, by controlling the number of iterations\rthat take place during construction. Increase and decrease the default value for smoother, or more\rjagged, shapes.", "kind": "function", "name": "ellipse", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the ellipse will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Ellipse" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#ellipse", "scope": "instance", "___id": "T000002R015898", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Grid Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * A Grid Shape allows you to display a grid in your game, where you can control the size of the\r\n * grid as well as the width and height of the grid cells. You can set a fill color for each grid\r\n * cell as well as an alternate fill color. When the alternate fill color is set then the grid\r\n * cells will alternate the fill colors as they render, creating a chess-board effect. You can\r\n * also optionally have a stroke fill color. If set, this draws lines between the grid cells\r\n * in the given color. If you specify a stroke color with an alpha of zero, then it will draw\r\n * the cells spaced out, but without the lines between them.\r\n *\r\n * @class Grid\r\n * @extends Phaser.GameObjects.Shape\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.13.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the grid.\r\n * @param {number} [height=128] - The height of the grid.\r\n * @param {number} [cellWidth=32] - The width of one cell in the grid.\r\n * @param {number} [cellHeight=32] - The height of one cell in the grid.\r\n * @param {number} [fillColor] - The color the grid cells will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n * @param {number} [strokeFillColor] - The color of the lines between the grid cells. See the `setStrokeStyle` method.\r\n * @param {number} [strokeFillAlpha] - The alpha of the lines between the grid cells.\r\n */", "meta": { "filename": "Grid.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "classdesc": "The Grid Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rA Grid Shape allows you to display a grid in your game, where you can control the size of the\rgrid as well as the width and height of the grid cells. You can set a fill color for each grid\rcell as well as an alternate fill color. When the alternate fill color is set then the grid\rcells will alternate the fill colors as they render, creating a chess-board effect. You can\ralso optionally have a stroke fill color. If set, this draws lines between the grid cells\rin the given color. If you specify a stroke color with an alpha of zero, then it will draw\rthe 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the grid.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the grid.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The width of one cell in the grid.", "name": "cellWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The height of one cell in the grid.", "name": "cellHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the grid cells will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color of the lines between the grid cells. See the `setStrokeStyle` method.", "name": "strokeFillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The alpha of the lines between the grid cells.", "name": "strokeFillAlpha" } ], "scope": "static", "longname": "Phaser.GameObjects.Grid", "___id": "T000002R015957", "___s": true }, { "comment": "/**\r\n * The width of each grid cell.\r\n * Must be a positive value.\r\n *\r\n * @name Phaser.GameObjects.Grid#cellWidth\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Grid.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "The width of each grid cell.\rMust be a positive value.", "name": "cellWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#cellWidth", "scope": "instance", "kind": "member", "___id": "T000002R015968", "___s": true }, { "comment": "/**\r\n * The height of each grid cell.\r\n * Must be a positive value.\r\n *\r\n * @name Phaser.GameObjects.Grid#cellHeight\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Grid.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "The height of each grid cell.\rMust be a positive value.", "name": "cellHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#cellHeight", "scope": "instance", "kind": "member", "___id": "T000002R015970", "___s": true }, { "comment": "/**\r\n * Controls whether the grid renders alternating cells using the `altFillColor` and `altFillAlpha` values.\r\n * Set this via the `setAltFillStyle` method.\r\n *\r\n * @name Phaser.GameObjects.Grid#showAltCells\r\n * @type {boolean}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Grid.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "Controls whether the grid renders alternating cells using the `altFillColor` and `altFillAlpha` values.\rSet this via the `setAltFillStyle` method.", "name": "showAltCells", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#showAltCells", "scope": "instance", "kind": "member", "___id": "T000002R015972", "___s": true }, { "comment": "/**\r\n * The color the alternating grid cells will be filled with, i.e. 0xff0000 for red.\r\n *\r\n * @name Phaser.GameObjects.Grid#altFillColor\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Grid.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "The color the alternating grid cells will be filled with, i.e. 0xff0000 for red.", "name": "altFillColor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#altFillColor", "scope": "instance", "kind": "member", "___id": "T000002R015974", "___s": true }, { "comment": "/**\r\n * The alpha the alternating grid cells will be filled with.\r\n * You can also set the alpha of the overall Shape using its `alpha` property.\r\n *\r\n * @name Phaser.GameObjects.Grid#altFillAlpha\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Grid.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "The alpha the alternating grid cells will be filled with.\rYou can also set the alpha of the overall Shape using its `alpha` property.", "name": "altFillAlpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#altFillAlpha", "scope": "instance", "kind": "member", "___id": "T000002R015976", "___s": true }, { "comment": "/**\r\n * The padding around each cell. The effective gutter between cells is\r\n * twice this value.\r\n *\r\n * @name Phaser.GameObjects.Grid#cellPadding\r\n * @type {number}\r\n * @since 4.0.0\r\n * @default 0.5\r\n */", "meta": { "filename": "Grid.js", "lineno": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "The padding around each cell. The effective gutter between cells is\rtwice this value.", "name": "cellPadding", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "defaultvalue": "0.5", "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#cellPadding", "scope": "instance", "kind": "member", "___id": "T000002R015978", "___s": true }, { "comment": "/**\r\n * Whether to stroke on the outside edges of the Grid object.\r\n *\r\n * @name Phaser.GameObjects.Grid#strokeOutside\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default false\r\n */", "meta": { "filename": "Grid.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "Whether to stroke on the outside edges of the Grid object.", "name": "strokeOutside", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "false", "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#strokeOutside", "scope": "instance", "kind": "member", "___id": "T000002R015980", "___s": true }, { "comment": "/**\r\n * Whether to stroke on the outside edges of the Grid object\r\n * when the cell is incomplete, e.g. the grid size does not\r\n * evenly fit the cell size.\r\n *\r\n * This only has an effect if `strokeOutside` is `true`.\r\n * It will affect the right and bottom edges of the grid.\r\n *\r\n * @name Phaser.GameObjects.Grid#strokeOutsideIncomplete\r\n * @type {boolean}\r\n * @since 4.0.0\r\n * @default true\r\n */", "meta": { "filename": "Grid.js", "lineno": 135, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "Whether to stroke on the outside edges of the Grid object\rwhen the cell is incomplete, e.g. the grid size does not\revenly fit the cell size.\r\rThis only has an effect if `strokeOutside` is `true`.\rIt will affect the right and bottom edges of the grid.", "name": "strokeOutsideIncomplete", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "defaultvalue": "true", "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#strokeOutsideIncomplete", "scope": "instance", "kind": "member", "___id": "T000002R015982", "___s": true }, { "comment": "/**\r\n * Sets the fill color and alpha level that the alternating grid cells will use.\r\n *\r\n * If this method is called with no values then alternating grid cells will not be rendered in a different color.\r\n *\r\n * Also see the `setStrokeStyle` and `setFillStyle` methods.\r\n *\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Grid#setAltFillStyle\r\n * @since 3.13.0\r\n *\r\n * @param {number} [fillColor] - The color the alternating grid cells will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha=1] - The alpha the alternating grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Grid.js", "lineno": 163, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "Sets the fill color and alpha level that the alternating grid cells will use.\r\rIf this method is called with no values then alternating grid cells will not be rendered in a different color.\r\rAlso see the `setStrokeStyle` and `setFillStyle` methods.\r\rThis call can be chained.", "kind": "function", "name": "setAltFillStyle", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the alternating grid cells will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#setAltFillStyle", "scope": "instance", "___id": "T000002R015984", "___s": true }, { "comment": "/**\r\n * Sets the cell padding for the grid.\r\n * The cell padding is the space around each cell, between the cells.\r\n * The effective gutter between cells is twice this value.\r\n *\r\n * If this method is called with no value then the cell padding is set to zero.\r\n *\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Grid#setCellPadding\r\n * @since 4.0.0\r\n * @param {number} [value] - The cell padding value.\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Grid.js", "lineno": 198, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "Sets the cell padding for the grid.\rThe cell padding is the space around each cell, between the cells.\rThe effective gutter between cells is twice this value.\r\rIf this method is called with no value then the cell padding is set to zero.\r\rThis call can be chained.", "kind": "function", "name": "setCellPadding", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The cell padding value.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#setCellPadding", "scope": "instance", "___id": "T000002R015991", "___s": true }, { "comment": "/**\r\n * Controls whether a stroke is drawn around the outer perimeter of the entire Grid object,\r\n * in addition to the lines drawn between cells. Optionally, you can also control whether the\r\n * outer edge is stroked on partial cells, i.e. where the grid dimensions do not divide evenly\r\n * by the cell dimensions, leaving an incomplete cell on the right or bottom edge.\r\n *\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Grid#setStrokeOutside\r\n * @since 4.0.0\r\n * @param {boolean} strokeOutside - Whether to stroke the outside edges of the Grid object.\r\n * @param {boolean} [strokeOutsideIncomplete] - Whether to stroke the outside edges of the Grid object when the cell is incomplete.\r\n */", "meta": { "filename": "Grid.js", "lineno": 219, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "Controls whether a stroke is drawn around the outer perimeter of the entire Grid object,\rin addition to the lines drawn between cells. Optionally, you can also control whether the\router edge is stroked on partial cells, i.e. where the grid dimensions do not divide evenly\rby the cell dimensions, leaving an incomplete cell on the right or bottom edge.\r\rThis call can be chained.", "kind": "function", "name": "setStrokeOutside", "since": "4.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to stroke the outside edges of the Grid object.", "name": "strokeOutside" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Whether to stroke the outside edges of the Grid object when the cell is incomplete.", "name": "strokeOutsideIncomplete" } ], "memberof": "Phaser.GameObjects.Grid", "longname": "Phaser.GameObjects.Grid#setStrokeOutside", "scope": "instance", "___id": "T000002R015994", "___s": true }, { "comment": "/**\r\n * Creates a new Grid Shape Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Grid Game Object has been built into Phaser.\r\n *\r\n * The Grid Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports only fill colors and cannot be stroked.\r\n *\r\n * A Grid Shape allows you to display a grid in your game, where you can control the size of the\r\n * grid as well as the width and height of the grid cells. You can set a fill color for each grid\r\n * cell as well as an alternate fill color. When the alternate fill color is set then the grid\r\n * cells will alternate the fill colors as they render, creating a chess-board effect. You can\r\n * also optionally have an outline fill color. If set, this draws lines between the grid cells\r\n * in the given color. If you specify an outline color with an alpha of zero, then it will draw\r\n * the cells spaced out, but without the lines between them.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#grid\r\n * @since 3.13.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the grid.\r\n * @param {number} [height=128] - The height of the grid.\r\n * @param {number} [cellWidth=32] - The width of one cell in the grid.\r\n * @param {number} [cellHeight=32] - The height of one cell in the grid.\r\n * @param {number} [fillColor] - The color the grid cells will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the grid cells will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n * @param {number} [outlineFillColor] - The color of the lines between the grid cells.\r\n * @param {number} [outlineFillAlpha] - The alpha of the lines between the grid cells.\r\n *\r\n * @return {Phaser.GameObjects.Grid} The Game Object that was created.\r\n */", "meta": { "filename": "GridFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\grid", "code": {} }, "description": "Creates a new Grid Shape Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Grid Game Object has been built into Phaser.\r\rThe Grid Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports only fill colors and cannot be stroked.\r\rA Grid Shape allows you to display a grid in your game, where you can control the size of the\rgrid as well as the width and height of the grid cells. You can set a fill color for each grid\rcell as well as an alternate fill color. When the alternate fill color is set then the grid\rcells will alternate the fill colors as they render, creating a chess-board effect. You can\ralso optionally have an outline fill color. If set, this draws lines between the grid cells\rin the given color. If you specify an outline color with an alpha of zero, then it will draw\rthe cells spaced out, but without the lines between them.", "kind": "function", "name": "grid", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the grid.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the grid.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The width of one cell in the grid.", "name": "cellWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The height of one cell in the grid.", "name": "cellHeight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the grid cells will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color of the lines between the grid cells.", "name": "outlineFillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The alpha of the lines between the grid cells.", "name": "outlineFillAlpha" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Grid" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Grid" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#grid", "scope": "instance", "___id": "T000002R016054", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The IsoBox Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports only fill colors and cannot be stroked.\r\n *\r\n * An IsoBox is an 'isometric' rectangle. Each face of it has a different fill color. You can set\r\n * the color of the top, left and right faces of the rectangle respectively. You can also choose\r\n * which of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\r\n *\r\n * You cannot view an IsoBox from underneath, however you can change the 'angle' by setting\r\n * the `projection` property.\r\n *\r\n * @class IsoBox\r\n * @extends Phaser.GameObjects.Shape\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.13.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [size=48] - The width of the iso box in pixels. The left and right faces will be exactly half this value.\r\n * @param {number} [height=32] - 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.\r\n * @param {number} [fillTop=0xeeeeee] - The fill color of the top face of the iso box.\r\n * @param {number} [fillLeft=0x999999] - The fill color of the left face of the iso box.\r\n * @param {number} [fillRight=0xcccccc] - The fill color of the right face of the iso box.\r\n */", "meta": { "filename": "IsoBox.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isobox", "code": {} }, "classdesc": "The IsoBox Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports only fill colors and cannot be stroked.\r\rAn IsoBox is an 'isometric' rectangle. Each face of it has a different fill color. You can set\rthe color of the top, left and right faces of the rectangle respectively. You can also choose\rwhich of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\r\rYou cannot view an IsoBox from underneath, however you can change the 'angle' by setting\rthe `projection` property.", "kind": "class", "name": "IsoBox", "augments": [ "Phaser.GameObjects.Shape" ], "memberof": "Phaser.GameObjects", "since": "3.13.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xeeeeee", "description": "The fill color of the top face of the iso box.", "name": "fillTop" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x999999", "description": "The fill color of the left face of the iso box.", "name": "fillLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R016123", "___s": true }, { "comment": "/**\r\n * The projection level of the iso box. Change this to change the 'angle' at which you are looking at the box.\r\n *\r\n * @name Phaser.GameObjects.IsoBox#projection\r\n * @type {number}\r\n * @default 4\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoBox.js", "lineno": 64, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isobox", "code": {} }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "4", "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "longname": "Phaser.GameObjects.IsoBox#projection", "scope": "instance", "kind": "member", "___id": "T000002R016135", "___s": true }, { "comment": "/**\r\n * The color used to fill in the top of the iso box.\r\n *\r\n * @name Phaser.GameObjects.IsoBox#fillTop\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoBox.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isobox", "code": {} }, "description": "The color used to fill in the top of the iso box.", "name": "fillTop", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "longname": "Phaser.GameObjects.IsoBox#fillTop", "scope": "instance", "kind": "member", "___id": "T000002R016137", "___s": true }, { "comment": "/**\r\n * The color used to fill in the left-facing side of the iso box.\r\n *\r\n * @name Phaser.GameObjects.IsoBox#fillLeft\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoBox.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isobox", "code": {} }, "description": "The color used to fill in the left-facing side of the iso box.", "name": "fillLeft", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "longname": "Phaser.GameObjects.IsoBox#fillLeft", "scope": "instance", "kind": "member", "___id": "T000002R016139", "___s": true }, { "comment": "/**\r\n * The color used to fill in the right-facing side of the iso box.\r\n *\r\n * @name Phaser.GameObjects.IsoBox#fillRight\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoBox.js", "lineno": 92, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isobox", "code": {} }, "description": "The color used to fill in the right-facing side of the iso box.", "name": "fillRight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "longname": "Phaser.GameObjects.IsoBox#fillRight", "scope": "instance", "kind": "member", "___id": "T000002R016141", "___s": true }, { "comment": "/**\r\n * Controls whether the top face of the iso box will be rendered.\r\n *\r\n * @name Phaser.GameObjects.IsoBox#showTop\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoBox.js", "lineno": 101, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isobox", "code": {} }, "description": "Controls whether the top face of the iso box will be rendered.", "name": "showTop", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "longname": "Phaser.GameObjects.IsoBox#showTop", "scope": "instance", "kind": "member", "___id": "T000002R016143", "___s": true }, { "comment": "/**\r\n * Controls whether the left face of the iso box will be rendered.\r\n *\r\n * @name Phaser.GameObjects.IsoBox#showLeft\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoBox.js", "lineno": 111, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isobox", "code": {} }, "description": "Controls whether the left face of the iso box will be rendered.", "name": "showLeft", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "longname": "Phaser.GameObjects.IsoBox#showLeft", "scope": "instance", "kind": "member", "___id": "T000002R016145", "___s": true }, { "comment": "/**\r\n * Controls whether the right face of the iso box will be rendered.\r\n *\r\n * @name Phaser.GameObjects.IsoBox#showRight\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoBox.js", "lineno": 121, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isobox", "code": {} }, "description": "Controls whether the right face of the iso box will be rendered.", "name": "showRight", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoBox", "longname": "Phaser.GameObjects.IsoBox#showRight", "scope": "instance", "kind": "member", "___id": "T000002R016147", "___s": true }, { "comment": "/**\r\n * Sets the projection level of the iso box. Change this to change the 'angle' at which you are looking at the box.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.IsoBox#setProjection\r\n * @since 3.13.0\r\n *\r\n * @param {number} value - The value to set the projection to.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "IsoBox.js", "lineno": 139, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isobox", "code": {} }, "description": "Sets the projection level of the iso box. Change this to change the 'angle' at which you are looking at the box.\rThis call can be chained.", "kind": "function", "name": "setProjection", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to set the projection to.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "longname": "Phaser.GameObjects.IsoBox#setProjection", "scope": "instance", "___id": "T000002R016150", "___s": true }, { "comment": "/**\r\n * Sets which faces of the iso box will be rendered.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.IsoBox#setFaces\r\n * @since 3.13.0\r\n *\r\n * @param {boolean} [showTop=true] - Show the top-face of the iso box.\r\n * @param {boolean} [showLeft=true] - Show the left-face of the iso box.\r\n * @param {boolean} [showRight=true] - Show the right-face of the iso box.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "IsoBox.js", "lineno": 157, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isobox", "code": {} }, "description": "Sets which faces of the iso box will be rendered.\rThis call can be chained.", "kind": "function", "name": "setFaces", "since": "3.13.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Show the top-face of the iso box.", "name": "showTop" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Show the left-face of the iso box.", "name": "showLeft" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Show the right-face of the iso box.", "name": "showRight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "longname": "Phaser.GameObjects.IsoBox#setFaces", "scope": "instance", "___id": "T000002R016153", "___s": true }, { "comment": "/**\r\n * Sets the fill colors for each face of the iso box.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.IsoBox#setFillStyle\r\n * @since 3.13.0\r\n *\r\n * @param {number} [fillTop] - The color used to fill the top of the iso box.\r\n * @param {number} [fillLeft] - The color used to fill in the left-facing side of the iso box.\r\n * @param {number} [fillRight] - The color used to fill in the right-facing side of the iso box.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "IsoBox.js", "lineno": 183, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isobox", "code": {} }, "description": "Sets the fill colors for each face of the iso box.\rThis call can be chained.", "kind": "function", "name": "setFillStyle", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color used to fill the top of the iso box.", "name": "fillTop" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color used to fill in the left-facing side of the iso box.", "name": "fillLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color used to fill in the right-facing side of the iso box.", "name": "fillRight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoBox", "longname": "Phaser.GameObjects.IsoBox#setFillStyle", "scope": "instance", "overrides": "Phaser.GameObjects.Shape#setFillStyle", "___id": "T000002R016161", "___s": true }, { "comment": "/**\r\n * Creates a new IsoBox Shape Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the IsoBox Game Object has been built into Phaser.\r\n *\r\n * The IsoBox Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports only fill colors and cannot be stroked.\r\n *\r\n * An IsoBox is an 'isometric' rectangle. Each face of it has a different fill color. You can set\r\n * the color of the top, left and right faces of the rectangle respectively. You can also choose\r\n * which of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\r\n *\r\n * You cannot view an IsoBox from under-neath, however you can change the 'angle' by setting\r\n * the `projection` property.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#isobox\r\n * @since 3.13.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [size=48] - The width of the iso box in pixels. The left and right faces will be exactly half this value.\r\n * @param {number} [height=32] - 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.\r\n * @param {number} [fillTop=0xeeeeee] - The fill color of the top face of the iso box.\r\n * @param {number} [fillLeft=0x999999] - The fill color of the left face of the iso box.\r\n * @param {number} [fillRight=0xcccccc] - The fill color of the right face of the iso box.\r\n *\r\n * @return {Phaser.GameObjects.IsoBox} The Game Object that was created.\r\n */", "meta": { "filename": "IsoBoxFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isobox", "code": {} }, "description": "Creates a new IsoBox Shape Game Object and adds it to the Scene.\r\rNote: This method will only be available if the IsoBox Game Object has been built into Phaser.\r\rThe IsoBox Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports only fill colors and cannot be stroked.\r\rAn IsoBox is an 'isometric' rectangle. Each face of it has a different fill color. You can set\rthe color of the top, left and right faces of the rectangle respectively. You can also choose\rwhich of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\r\rYou cannot view an IsoBox from under-neath, however you can change the 'angle' by setting\rthe `projection` property.", "kind": "function", "name": "isobox", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xeeeeee", "description": "The fill color of the top face of the iso box.", "name": "fillTop" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x999999", "description": "The fill color of the left face of the iso box.", "name": "fillLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.IsoBox" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#isobox", "scope": "instance", "___id": "T000002R016180", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The IsoTriangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports only fill colors and cannot be stroked.\r\n *\r\n * An IsoTriangle is an 'isometric' triangle. Think of it like a pyramid. Each face has a different\r\n * fill color. You can set the color of the top, left and right faces of the triangle respectively\r\n * You can also choose which of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\r\n *\r\n * You cannot view an IsoTriangle from under-neath, however you can change the 'angle' by setting\r\n * the `projection` property. The `reversed` property controls if the IsoTriangle is rendered upside\r\n * down or not.\r\n *\r\n * @class IsoTriangle\r\n * @extends Phaser.GameObjects.Shape\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.13.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [size=48] - The width of the iso triangle in pixels. The left and right faces will be exactly half this value.\r\n * @param {number} [height=32] - 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.\r\n * @param {boolean} [reversed=false] - Is the iso triangle upside down?\r\n * @param {number} [fillTop=0xeeeeee] - The fill color of the top face of the iso triangle.\r\n * @param {number} [fillLeft=0x999999] - The fill color of the left face of the iso triangle.\r\n * @param {number} [fillRight=0xcccccc] - The fill color of the right face of the iso triangle.\r\n */", "meta": { "filename": "IsoTriangle.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isotriangle", "code": {} }, "classdesc": "The IsoTriangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports only fill colors and cannot be stroked.\r\rAn IsoTriangle is an 'isometric' triangle. Think of it like a pyramid. Each face has a different\rfill color. You can set the color of the top, left and right faces of the triangle respectively\rYou can also choose which of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\r\rYou cannot view an IsoTriangle from under-neath, however you can change the 'angle' by setting\rthe `projection` property. The `reversed` property controls if the IsoTriangle is rendered upside\rdown or not.", "kind": "class", "name": "IsoTriangle", "augments": [ "Phaser.GameObjects.Shape" ], "memberof": "Phaser.GameObjects", "since": "3.13.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is the iso triangle upside down?", "name": "reversed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xeeeeee", "description": "The fill color of the top face of the iso triangle.", "name": "fillTop" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x999999", "description": "The fill color of the left face of the iso triangle.", "name": "fillLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R016243", "___s": true }, { "comment": "/**\r\n * The projection level of the iso triangle. Change this to change the 'angle' at which you are looking at the pyramid.\r\n *\r\n * @name Phaser.GameObjects.IsoTriangle#projection\r\n * @type {number}\r\n * @default 4\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoTriangle.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isotriangle", "code": {} }, "description": "The projection level of the iso triangle. Change this to change the 'angle' at which you are looking at the pyramid.", "name": "projection", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "4", "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "longname": "Phaser.GameObjects.IsoTriangle#projection", "scope": "instance", "kind": "member", "___id": "T000002R016256", "___s": true }, { "comment": "/**\r\n * The color used to fill in the top of the iso triangle. This is only used if the triangle is reversed.\r\n *\r\n * @name Phaser.GameObjects.IsoTriangle#fillTop\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoTriangle.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isotriangle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "longname": "Phaser.GameObjects.IsoTriangle#fillTop", "scope": "instance", "kind": "member", "___id": "T000002R016258", "___s": true }, { "comment": "/**\r\n * The color used to fill in the left-facing side of the iso triangle.\r\n *\r\n * @name Phaser.GameObjects.IsoTriangle#fillLeft\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoTriangle.js", "lineno": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isotriangle", "code": {} }, "description": "The color used to fill in the left-facing side of the iso triangle.", "name": "fillLeft", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "longname": "Phaser.GameObjects.IsoTriangle#fillLeft", "scope": "instance", "kind": "member", "___id": "T000002R016260", "___s": true }, { "comment": "/**\r\n * The color used to fill in the right-facing side of the iso triangle.\r\n *\r\n * @name Phaser.GameObjects.IsoTriangle#fillRight\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoTriangle.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isotriangle", "code": {} }, "description": "The color used to fill in the right-facing side of the iso triangle.", "name": "fillRight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "longname": "Phaser.GameObjects.IsoTriangle#fillRight", "scope": "instance", "kind": "member", "___id": "T000002R016262", "___s": true }, { "comment": "/**\r\n * Controls whether the top face of the iso triangle will be rendered.\r\n *\r\n * @name Phaser.GameObjects.IsoTriangle#showTop\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoTriangle.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isotriangle", "code": {} }, "description": "Controls whether the top face of the iso triangle will be rendered.", "name": "showTop", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "longname": "Phaser.GameObjects.IsoTriangle#showTop", "scope": "instance", "kind": "member", "___id": "T000002R016264", "___s": true }, { "comment": "/**\r\n * Controls whether the left face of the iso triangle will be rendered.\r\n *\r\n * @name Phaser.GameObjects.IsoTriangle#showLeft\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoTriangle.js", "lineno": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isotriangle", "code": {} }, "description": "Controls whether the left face of the iso triangle will be rendered.", "name": "showLeft", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "longname": "Phaser.GameObjects.IsoTriangle#showLeft", "scope": "instance", "kind": "member", "___id": "T000002R016266", "___s": true }, { "comment": "/**\r\n * Controls whether the right face of the iso triangle will be rendered.\r\n *\r\n * @name Phaser.GameObjects.IsoTriangle#showRight\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoTriangle.js", "lineno": 124, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isotriangle", "code": {} }, "description": "Controls whether the right face of the iso triangle will be rendered.", "name": "showRight", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "longname": "Phaser.GameObjects.IsoTriangle#showRight", "scope": "instance", "kind": "member", "___id": "T000002R016268", "___s": true }, { "comment": "/**\r\n * Indicates whether the iso triangle is rendered upside down.\r\n *\r\n * @name Phaser.GameObjects.IsoTriangle#isReversed\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.13.0\r\n */", "meta": { "filename": "IsoTriangle.js", "lineno": 134, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isotriangle", "code": {} }, "description": "Indicates whether the iso triangle is rendered upside down.", "name": "isReversed", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.13.0", "memberof": "Phaser.GameObjects.IsoTriangle", "longname": "Phaser.GameObjects.IsoTriangle#isReversed", "scope": "instance", "kind": "member", "___id": "T000002R016270", "___s": true }, { "comment": "/**\r\n * Sets the projection level of the iso triangle. Change this to change the 'angle' at which you are looking at the pyramid.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.IsoTriangle#setProjection\r\n * @since 3.13.0\r\n *\r\n * @param {number} value - The value to set the projection to.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "IsoTriangle.js", "lineno": 152, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isotriangle", "code": {} }, "description": "Sets the projection level of the iso triangle. Change this to change the 'angle' at which you are looking at the pyramid.\rThis call can be chained.", "kind": "function", "name": "setProjection", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value to set the projection to.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "longname": "Phaser.GameObjects.IsoTriangle#setProjection", "scope": "instance", "___id": "T000002R016273", "___s": true }, { "comment": "/**\r\n * Sets if the iso triangle will be rendered upside down or not.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.IsoTriangle#setReversed\r\n * @since 3.13.0\r\n *\r\n * @param {boolean} reversed - Whether to render the iso triangle upside down.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "IsoTriangle.js", "lineno": 170, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isotriangle", "code": {} }, "description": "Sets if the iso triangle will be rendered upside down or not.\rThis call can be chained.", "kind": "function", "name": "setReversed", "since": "3.13.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to render the iso triangle upside down.", "name": "reversed" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "longname": "Phaser.GameObjects.IsoTriangle#setReversed", "scope": "instance", "___id": "T000002R016276", "___s": true }, { "comment": "/**\r\n * Sets which faces of the iso triangle will be rendered.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.IsoTriangle#setFaces\r\n * @since 3.13.0\r\n *\r\n * @param {boolean} [showTop=true] - Show the top-face of the iso triangle (only if `reversed` is true)\r\n * @param {boolean} [showLeft=true] - Show the left-face of the iso triangle.\r\n * @param {boolean} [showRight=true] - Show the right-face of the iso triangle.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "IsoTriangle.js", "lineno": 188, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isotriangle", "code": {} }, "description": "Sets which faces of the iso triangle will be rendered.\rThis call can be chained.", "kind": "function", "name": "setFaces", "since": "3.13.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Show the top-face of the iso triangle (only if `reversed` is true)", "name": "showTop" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Show the left-face of the iso triangle.", "name": "showLeft" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Show the right-face of the iso triangle.", "name": "showRight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "longname": "Phaser.GameObjects.IsoTriangle#setFaces", "scope": "instance", "___id": "T000002R016279", "___s": true }, { "comment": "/**\r\n * Sets the fill colors for each face of the iso triangle.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.IsoTriangle#setFillStyle\r\n * @since 3.13.0\r\n *\r\n * @param {number} [fillTop] - The color used to fill the top of the iso triangle.\r\n * @param {number} [fillLeft] - The color used to fill in the left-facing side of the iso triangle.\r\n * @param {number} [fillRight] - The color used to fill in the right-facing side of the iso triangle.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "IsoTriangle.js", "lineno": 214, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isotriangle", "code": {} }, "description": "Sets the fill colors for each face of the iso triangle.\rThis call can be chained.", "kind": "function", "name": "setFillStyle", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color used to fill the top of the iso triangle.", "name": "fillTop" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color used to fill in the left-facing side of the iso triangle.", "name": "fillLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color used to fill in the right-facing side of the iso triangle.", "name": "fillRight" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.IsoTriangle", "longname": "Phaser.GameObjects.IsoTriangle#setFillStyle", "scope": "instance", "overrides": "Phaser.GameObjects.Shape#setFillStyle", "___id": "T000002R016287", "___s": true }, { "comment": "/**\r\n * Creates a new IsoTriangle Shape Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the IsoTriangle Game Object has been built into Phaser.\r\n *\r\n * The IsoTriangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports only fill colors and cannot be stroked.\r\n *\r\n * An IsoTriangle is an 'isometric' triangle. Think of it like a pyramid. Each face has a different\r\n * fill color. You can set the color of the top, left and right faces of the triangle respectively.\r\n * You can also choose which of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\r\n *\r\n * You cannot view an IsoTriangle from underneath, however you can change the 'angle' by setting\r\n * the `projection` property. The `reversed` property controls if the IsoTriangle is rendered upside\r\n * down or not.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#isotriangle\r\n * @since 3.13.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [size=48] - The width of the iso triangle in pixels. The left and right faces will be exactly half this value.\r\n * @param {number} [height=32] - 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.\r\n * @param {boolean} [reversed=false] - Is the iso triangle upside down?\r\n * @param {number} [fillTop=0xeeeeee] - The fill color of the top face of the iso triangle.\r\n * @param {number} [fillLeft=0x999999] - The fill color of the left face of the iso triangle.\r\n * @param {number} [fillRight=0xcccccc] - The fill color of the right face of the iso triangle.\r\n *\r\n * @return {Phaser.GameObjects.IsoTriangle} The Game Object that was created.\r\n */", "meta": { "filename": "IsoTriangleFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\isotriangle", "code": {} }, "description": "Creates a new IsoTriangle Shape Game Object and adds it to the Scene.\r\rNote: This method will only be available if the IsoTriangle Game Object has been built into Phaser.\r\rThe IsoTriangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports only fill colors and cannot be stroked.\r\rAn IsoTriangle is an 'isometric' triangle. Think of it like a pyramid. Each face has a different\rfill color. You can set the color of the top, left and right faces of the triangle respectively.\rYou can also choose which of the faces are rendered via the `showTop`, `showLeft` and `showRight` properties.\r\rYou cannot view an IsoTriangle from underneath, however you can change the 'angle' by setting\rthe `projection` property. The `reversed` property controls if the IsoTriangle is rendered upside\rdown or not.", "kind": "function", "name": "isotriangle", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is the iso triangle upside down?", "name": "reversed" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0xeeeeee", "description": "The fill color of the top face of the iso triangle.", "name": "fillTop" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x999999", "description": "The fill color of the left face of the iso triangle.", "name": "fillLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.IsoTriangle" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#isotriangle", "scope": "instance", "___id": "T000002R016307", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Line Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports only stroke colors and cannot be filled.\r\n *\r\n * A Line Shape allows you to draw a line between two points in your game. You can control the\r\n * stroke color and thickness of the line. In WebGL only, you can also specify a different\r\n * thickness for the start and end of the line, allowing you to render lines that taper off.\r\n *\r\n * If you need to draw multiple lines in a sequence you may wish to use the Polygon Shape instead.\r\n *\r\n * Be aware that as with all Game Objects the default origin is 0.5. If you need to draw a Line\r\n * between two points and want the x1/y1 values to match the x/y values, then set the origin to 0.\r\n *\r\n * @class Line\r\n * @extends Phaser.GameObjects.Shape\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.13.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [x1=0] - The horizontal position of the start of the line.\r\n * @param {number} [y1=0] - The vertical position of the start of the line.\r\n * @param {number} [x2=128] - The horizontal position of the end of the line.\r\n * @param {number} [y2=0] - The vertical position of the end of the line.\r\n * @param {number} [strokeColor] - The color the line will be drawn in, i.e. 0xff0000 for red.\r\n * @param {number} [strokeAlpha] - The alpha the line will be drawn in. You can also set the alpha of the overall Shape using its `alpha` property.\r\n */", "meta": { "filename": "Line.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\line", "code": {} }, "classdesc": "The Line Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports only stroke colors and cannot be filled.\r\rA Line Shape allows you to draw a line between two points in your game. You can control the\rstroke color and thickness of the line. In WebGL only, you can also specify a different\rthickness for the start and end of the line, allowing you to render lines that taper off.\r\rIf you need to draw multiple lines in a sequence you may wish to use the Polygon Shape instead.\r\rBe aware that as with all Game Objects the default origin is 0.5. If you need to draw a Line\rbetween 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the start of the line.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the start of the line.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The horizontal position of the end of the line.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the end of the line.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the line will be drawn in, i.e. 0xff0000 for red.", "name": "strokeColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R016378", "___s": true }, { "comment": "/**\r\n * The width (or thickness) of the line.\r\n * See the setLineWidth method for extra details on changing this on WebGL.\r\n *\r\n * @name Phaser.GameObjects.Line#lineWidth\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Line.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\line", "code": {} }, "description": "The width (or thickness) of the line.\rSee the setLineWidth method for extra details on changing this on WebGL.", "name": "lineWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Line", "longname": "Phaser.GameObjects.Line#lineWidth", "scope": "instance", "kind": "member", "overrides": "Phaser.GameObjects.Shape#lineWidth", "___id": "T000002R016389", "___s": true }, { "comment": "/**\r\n * Sets the width of the line.\r\n *\r\n * When using the WebGL renderer you can have different start and end widths.\r\n * When using the Canvas renderer only the `startWidth` value is used. The `endWidth` is ignored.\r\n *\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Line#setLineWidth\r\n * @since 3.13.0\r\n *\r\n * @param {number} startWidth - The start width of the line.\r\n * @param {number} [endWidth] - The end width of the line. Only used in WebGL.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Line.js", "lineno": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\line", "code": {} }, "description": "Sets the width of the line.\r\rWhen using the WebGL renderer you can have different start and end widths.\rWhen using the Canvas renderer only the `startWidth` value is used. The `endWidth` is ignored.\r\rThis call can be chained.", "kind": "function", "name": "setLineWidth", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The start width of the line.", "name": "startWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The end width of the line. Only used in WebGL.", "name": "endWidth" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Line", "longname": "Phaser.GameObjects.Line#setLineWidth", "scope": "instance", "___id": "T000002R016395", "___s": true }, { "comment": "/**\r\n * Sets the start and end coordinates of this Line.\r\n *\r\n * @method Phaser.GameObjects.Line#setTo\r\n * @since 3.13.0\r\n *\r\n * @param {number} [x1=0] - The horizontal position of the start of the line.\r\n * @param {number} [y1=0] - The vertical position of the start of the line.\r\n * @param {number} [x2=0] - The horizontal position of the end of the line.\r\n * @param {number} [y2=0] - The vertical position of the end of the line.\r\n *\r\n * @return {this} This Line object.\r\n */", "meta": { "filename": "Line.js", "lineno": 136, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\line", "code": {} }, "description": "Sets the start and end coordinates of this Line.", "kind": "function", "name": "setTo", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the start of the line.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the start of the line.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the end of the line.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the end of the line.", "name": "y2" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Line object." } ], "memberof": "Phaser.GameObjects.Line", "longname": "Phaser.GameObjects.Line#setTo", "scope": "instance", "___id": "T000002R016401", "___s": true }, { "comment": "/**\r\n * Creates a new Line Shape Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Line Game Object has been built into Phaser.\r\n *\r\n * The Line Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports only stroke colors and cannot be filled.\r\n *\r\n * A Line Shape allows you to draw a line between two points in your game. You can control the\r\n * stroke color and thickness of the line. In WebGL only you can also specify a different\r\n * thickness for the start and end of the line, allowing you to render lines that taper-off.\r\n *\r\n * If you need to draw multiple lines in a sequence you may wish to use the Polygon Shape instead.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#line\r\n * @since 3.13.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [x1=0] - The horizontal position of the start of the line.\r\n * @param {number} [y1=0] - The vertical position of the start of the line.\r\n * @param {number} [x2=128] - The horizontal position of the end of the line.\r\n * @param {number} [y2=0] - The vertical position of the end of the line.\r\n * @param {number} [strokeColor] - The color the line will be drawn in, i.e. 0xff0000 for red.\r\n * @param {number} [strokeAlpha] - The alpha the line will be drawn in. You can also set the alpha of the overall Shape using its `alpha` property.\r\n *\r\n * @return {Phaser.GameObjects.Line} The Game Object that was created.\r\n */", "meta": { "filename": "LineFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\line", "code": {} }, "description": "Creates a new Line Shape Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Line Game Object has been built into Phaser.\r\rThe Line Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports only stroke colors and cannot be filled.\r\rA Line Shape allows you to draw a line between two points in your game. You can control the\rstroke color and thickness of the line. In WebGL only you can also specify a different\rthickness for the start and end of the line, allowing you to render lines that taper-off.\r\rIf 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the start of the line.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the start of the line.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The horizontal position of the end of the line.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the end of the line.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the line will be drawn in, i.e. 0xff0000 for red.", "name": "strokeColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Line" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#line", "scope": "instance", "___id": "T000002R016418", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Polygon Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports both fill and stroke colors.\r\n *\r\n * The Polygon Shape is created by providing a list of points, which are then used to create an\r\n * internal Polygon geometry object. The points can be set from a variety of formats:\r\n *\r\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'`\r\n * - An array of Point or Vector2 objects: `[new Phaser.Math.Vector2(x1, y1), ...]`\r\n * - An array of objects with public x/y properties: `[obj1, obj2, ...]`\r\n * - An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\r\n * - An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\r\n *\r\n * By default the `x` and `y` coordinates of this Shape refer to the center of it. However, depending\r\n * on the coordinates of the points provided, the final shape may be rendered offset from its origin.\r\n *\r\n * Note: The method `getBounds` will return incorrect bounds if any of the points in the Polygon are negative.\r\n * If this is the case, please use the function `Phaser.Geom.Polygon.GetAABB(polygon.geom)` instead and then\r\n * adjust the returned Rectangle position accordingly.\r\n *\r\n * @class Polygon\r\n * @extends Phaser.GameObjects.Shape\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.13.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {any} [points] - The points that make up the polygon.\r\n * @param {number} [fillColor] - The color the polygon will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the polygon will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n */", "meta": { "filename": "Polygon.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\polygon", "code": {} }, "classdesc": "The Polygon Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports both fill and stroke colors.\r\rThe Polygon Shape is created by providing a list of points, which are then used to create an\rinternal Polygon geometry object. The points can be set from a variety of formats:\r\r- A string containing paired values separated by a single space: `'40 0 40 20 100 20 100 80 40 80 40 100 0 50'`\r- An array of Point or Vector2 objects: `[new Phaser.Math.Vector2(x1, y1), ...]`\r- An array of objects with public x/y properties: `[obj1, obj2, ...]`\r- An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\r- An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\r\rBy default the `x` and `y` coordinates of this Shape refer to the center of it. However, depending\ron the coordinates of the points provided, the final shape may be rendered offset from its origin.\r\rNote: The method `getBounds` will return incorrect bounds if any of the points in the Polygon are negative.\rIf this is the case, please use the function `Phaser.Geom.Polygon.GetAABB(polygon.geom)` instead and then\radjust the returned Rectangle position accordingly.", "kind": "class", "name": "Polygon", "augments": [ "Phaser.GameObjects.Shape" ], "memberof": "Phaser.GameObjects", "since": "3.13.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The points that make up the polygon.", "name": "points" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the polygon will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R016468", "___s": true }, { "comment": "/**\r\n * Smooths the polygon over the number of iterations specified.\r\n * The base polygon data will be updated and replaced with the smoothed values.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Polygon#smooth\r\n * @since 3.13.0\r\n *\r\n * @param {number} [iterations=1] - The number of times to apply the polygon smoothing.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Polygon.js", "lineno": 84, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\polygon", "code": {} }, "description": "Smooths the polygon over the number of iterations specified.\rThe base polygon data will be updated and replaced with the smoothed values.\rThis call can be chained.", "kind": "function", "name": "smooth", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The number of times to apply the polygon smoothing.", "name": "iterations" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "longname": "Phaser.GameObjects.Polygon#smooth", "scope": "instance", "___id": "T000002R016476", "___s": true }, { "comment": "/**\r\n * Sets this Polygon to the given points.\r\n *\r\n * The points can be set from a variety of formats:\r\n *\r\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'`\r\n * - An array of Point or Vector2 objects: `[new Phaser.Math.Vector2(x1, y1), ...]`\r\n * - An array of objects with public x/y properties: `[obj1, obj2, ...]`\r\n * - An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\r\n * - An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\r\n *\r\n * Calling this method will reset the size (width, height) and display origin of this Shape.\r\n *\r\n * It also runs both GetAABB and EarCut on the given points, so please be careful not to do this\r\n * at a high frequency, or with too many points.\r\n *\r\n * @method Phaser.GameObjects.Polygon#setTo\r\n * @since 3.60.0\r\n *\r\n * @param {(string|number[]|Phaser.Types.Math.Vector2Like[])} [points] - Points defining the perimeter of this polygon. Please check function description above for the different supported formats.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Polygon.js", "lineno": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\polygon", "code": {} }, "description": "Sets this Polygon to the given points.\r\rThe points can be set from a variety of formats:\r\r- A string containing paired values separated by a single space: `'40 0 40 20 100 20 100 80 40 80 40 100 0 50'`\r- An array of Point or Vector2 objects: `[new Phaser.Math.Vector2(x1, y1), ...]`\r- An array of objects with public x/y properties: `[obj1, obj2, ...]`\r- An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\r- An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\r\rCalling this method will reset the size (width, height) and display origin of this Shape.\r\rIt also runs both GetAABB and EarCut on the given points, so please be careful not to do this\rat a high frequency, or with too many points.", "kind": "function", "name": "setTo", "since": "3.60.0", "params": [ { "type": { "names": [ "string", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Points defining the perimeter of this polygon. Please check function description above for the different supported formats.", "name": "points" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Polygon", "longname": "Phaser.GameObjects.Polygon#setTo", "scope": "instance", "___id": "T000002R016480", "___s": true }, { "comment": "/**\r\n * Creates a new Polygon Shape Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Polygon Game Object has been built into Phaser.\r\n *\r\n * The Polygon Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports both fill and stroke colors.\r\n *\r\n * The Polygon Shape is created by providing a list of points, which are then used to create an\r\n * internal Polygon geometry object. The points can be set from a variety of formats:\r\n *\r\n * - An array of Point or Vector2 objects: `[new Phaser.Math.Vector2(x1, y1), ...]`\r\n * - An array of objects with public x/y properties: `[obj1, obj2, ...]`\r\n * - An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\r\n * - An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\r\n *\r\n * By default the `x` and `y` coordinates of this Shape refer to the center of it. However, depending\r\n * on the coordinates of the points provided, the final shape may be rendered offset from its origin.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#polygon\r\n * @since 3.13.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {any} [points] - The points that make up the polygon.\r\n * @param {number} [fillColor] - The color the polygon will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the polygon will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n *\r\n * @return {Phaser.GameObjects.Polygon} The Game Object that was created.\r\n */", "meta": { "filename": "PolygonFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\polygon", "code": {} }, "description": "Creates a new Polygon Shape Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Polygon Game Object has been built into Phaser.\r\rThe Polygon Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports both fill and stroke colors.\r\rThe Polygon Shape is created by providing a list of points, which are then used to create an\rinternal Polygon geometry object. The points can be set from a variety of formats:\r\r- An array of Point or Vector2 objects: `[new Phaser.Math.Vector2(x1, y1), ...]`\r- An array of objects with public x/y properties: `[obj1, obj2, ...]`\r- An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\r- An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\r\rBy default the `x` and `y` coordinates of this Shape refer to the center of it. However, depending\ron 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The points that make up the polygon.", "name": "points" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the polygon will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Polygon" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#polygon", "scope": "instance", "___id": "T000002R016511", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Rectangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports both fill and stroke colors.\r\n *\r\n * You can change the size of the rectangle by changing the `width` and `height` properties.\r\n *\r\n * @class Rectangle\r\n * @extends Phaser.GameObjects.Shape\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.13.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the rectangle.\r\n * @param {number} [height=128] - The height of the rectangle.\r\n * @param {number} [fillColor] - The color the rectangle will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the rectangle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\rectangle", "code": {} }, "classdesc": "The Rectangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports both fill and stroke colors.\r\rYou 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the rectangle will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R016537", "___s": true }, { "comment": "/**\r\n * The radius of the rectangle if this is set to use rounded corners.\r\n * \r\n * Do not modify this property. Instead, call the method `setRounded` to set the\r\n * radius of the rounded corners.\r\n *\r\n * @name Phaser.GameObjects.Rectangle#radius\r\n * @type {number}\r\n * @readonly\r\n * @since 3.89.0\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\rectangle", "code": {} }, "description": "The radius of the rectangle if this is set to use rounded corners.\r\rDo not modify this property. Instead, call the method `setRounded` to set the\rradius of the rounded corners.", "name": "radius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.89.0", "memberof": "Phaser.GameObjects.Rectangle", "longname": "Phaser.GameObjects.Rectangle#radius", "scope": "instance", "kind": "member", "___id": "T000002R016546", "___s": true }, { "comment": "/**\r\n * Does this Rectangle have rounded corners?\r\n * \r\n * Do not modify this property. Instead, call the method `setRounded` to set the\r\n * radius state of this rectangle.\r\n *\r\n * @name Phaser.GameObjects.Rectangle#isRounded\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.89.0\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 70, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\rectangle", "code": {} }, "description": "Does this Rectangle have rounded corners?\r\rDo not modify this property. Instead, call the method `setRounded` to set the\rradius state of this rectangle.", "name": "isRounded", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.89.0", "memberof": "Phaser.GameObjects.Rectangle", "longname": "Phaser.GameObjects.Rectangle#isRounded", "scope": "instance", "kind": "member", "___id": "T000002R016548", "___s": true }, { "comment": "/**\r\n * Sets this rectangle to have rounded corners by specifying the radius of the corners.\r\n * \r\n * The radius of the rounded corners is limited by the smallest dimension of the rectangle.\r\n * \r\n * To disable rounded corners, set the `radius` parameter to 0.\r\n *\r\n * @method Phaser.GameObjects.Rectangle#setRounded\r\n * @since 3.89.0\r\n *\r\n * @param {number} [radius=16] - The radius of all four rounded corners.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 95, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\rectangle", "code": {} }, "description": "Sets this rectangle to have rounded corners by specifying the radius of the corners.\r\rThe radius of the rounded corners is limited by the smallest dimension of the rectangle.\r\rTo disable rounded corners, set the `radius` parameter to 0.", "kind": "function", "name": "setRounded", "since": "3.89.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 16, "description": "The radius of all four rounded corners.", "name": "radius" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "longname": "Phaser.GameObjects.Rectangle#setRounded", "scope": "instance", "___id": "T000002R016550", "___s": true }, { "comment": "/**\r\n * Sets the size of this Rectangle. This updates the underlying geometry, path data, display origin, and the default input hit area.\r\n *\r\n * If you have assigned a custom input hit area for this Rectangle, changing the Rectangle size will _not_ change the\r\n * size of the hit area. To do this you should adjust the `input.hitArea` object directly.\r\n *\r\n * @method Phaser.GameObjects.Rectangle#setSize\r\n * @since 3.13.0\r\n *\r\n * @param {number} width - The width of this Game Object.\r\n * @param {number} height - The height of this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 119, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\rectangle", "code": {} }, "description": "Sets the size of this Rectangle. This updates the underlying geometry, path data, display origin, and the default input hit area.\r\rIf you have assigned a custom input hit area for this Rectangle, changing the Rectangle size will _not_ change the\rsize of the hit area. To do this you should adjust the `input.hitArea` object directly.", "kind": "function", "name": "setSize", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Rectangle", "longname": "Phaser.GameObjects.Rectangle#setSize", "scope": "instance", "overrides": "Phaser.GameObjects.Shape#setSize", "___id": "T000002R016555", "___s": true }, { "comment": "/**\r\n * Creates a new Rectangle Shape Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Rectangle Game Object has been built into Phaser.\r\n *\r\n * The Rectangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports both fill and stroke colors.\r\n *\r\n * You can change the size of the rectangle by changing the `width` and `height` properties.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#rectangle\r\n * @since 3.13.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [width=128] - The width of the rectangle.\r\n * @param {number} [height=128] - The height of the rectangle.\r\n * @param {number} [fillColor] - The color the rectangle will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the rectangle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n *\r\n * @return {Phaser.GameObjects.Rectangle} The Game Object that was created.\r\n */", "meta": { "filename": "RectangleFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\rectangle", "code": {} }, "description": "Creates a new Rectangle Shape Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Rectangle Game Object has been built into Phaser.\r\rThe Rectangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports both fill and stroke colors.\r\rYou 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The height of the rectangle.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the rectangle will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Rectangle" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#rectangle", "scope": "instance", "___id": "T000002R016600", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Shape Game Object is a base class for the various built-in shape types, such as the Arc, Star, Polygon,\r\n * Rectangle, and Triangle. It provides a common interface for managing fill color, stroke color, line width,\r\n * and the precomputed path data used when rendering.\r\n *\r\n * You cannot add a Shape directly to your Scene. Instead, use one of the built-in subclasses, or extend this\r\n * class to create your own custom Shape types with their own geometry logic.\r\n *\r\n * Shape objects share the same render batch as the Graphics Game Object when rendering in WebGL.\r\n * They do not support gradients, path smoothing thresholds, or other advanced Graphics features.\r\n * In return, they store precomputed internal geometry data which allows them to render more efficiently\r\n * than dynamically-constructed Graphics objects.\r\n *\r\n * @class Shape\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.13.0\r\n *\r\n * @extends Phaser.GameObjects.Components.AlphaSingle\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.GetBounds\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {string} [type] - The internal type of the Shape.\r\n * @param {any} [data] - The data of the source shape geometry, if any.\r\n */", "meta": { "filename": "Shape.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "classdesc": "The Shape Game Object is a base class for the various built-in shape types, such as the Arc, Star, Polygon,\rRectangle, and Triangle. It provides a common interface for managing fill color, stroke color, line width,\rand the precomputed path data used when rendering.\r\rYou cannot add a Shape directly to your Scene. Instead, use one of the built-in subclasses, or extend this\rclass to create your own custom Shape types with their own geometry logic.\r\rShape objects share the same render batch as the Graphics Game Object when rendering in WebGL.\rThey do not support gradients, path smoothing thresholds, or other advanced Graphics features.\rIn return, they store precomputed internal geometry data which allows them to render more efficiently\rthan dynamically-constructed Graphics objects.", "kind": "class", "name": "Shape", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.AlphaSingle", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.RenderNodes", "Phaser.GameObjects.Components.ScrollFactor", "Phaser.GameObjects.Components.Transform", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.GameObjects", "since": "3.13.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The internal type of the Shape.", "name": "type" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The data of the source shape geometry, if any.", "name": "data" } ], "scope": "static", "longname": "Phaser.GameObjects.Shape", "___id": "T000002R016630", "___s": true }, { "comment": "/**\r\n * The source Shape data. Typically a geometry object.\r\n * You should not manipulate this directly.\r\n *\r\n * @name Phaser.GameObjects.Shape#geom\r\n * @type {any}\r\n * @readonly\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The source Shape data. Typically a geometry object.\rYou should not manipulate this directly.", "name": "geom", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "readonly": true, "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#geom", "scope": "instance", "kind": "member", "___id": "T000002R016636", "___s": true }, { "comment": "/**\r\n * Holds the polygon path data for filled rendering.\r\n *\r\n * @name Phaser.GameObjects.Shape#pathData\r\n * @type {number[]}\r\n * @readonly\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "Holds the polygon path data for filled rendering.", "name": "pathData", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "readonly": true, "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#pathData", "scope": "instance", "kind": "member", "___id": "T000002R016638", "___s": true }, { "comment": "/**\r\n * Holds the earcut polygon path index data for filled rendering.\r\n *\r\n * @name Phaser.GameObjects.Shape#pathIndexes\r\n * @type {number[]}\r\n * @readonly\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "Holds the earcut polygon path index data for filled rendering.", "name": "pathIndexes", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "readonly": true, "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#pathIndexes", "scope": "instance", "kind": "member", "___id": "T000002R016640", "___s": true }, { "comment": "/**\r\n * The fill color used by this Shape, as a hex value (e.g., 0xff0000 for red).\r\n * Only used when `isFilled` is `true`. Set via `setFillStyle`.\r\n *\r\n * @name Phaser.GameObjects.Shape#fillColor\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The fill color used by this Shape, as a hex value (e.g., 0xff0000 for red).\rOnly used when `isFilled` is `true`. Set via `setFillStyle`.", "name": "fillColor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#fillColor", "scope": "instance", "kind": "member", "___id": "T000002R016642", "___s": true }, { "comment": "/**\r\n * The alpha applied to the fill of this Shape, in the range 0 (fully transparent) to 1 (fully opaque).\r\n * Only used when `isFilled` is `true`. Set via `setFillStyle`.\r\n *\r\n * @name Phaser.GameObjects.Shape#fillAlpha\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 115, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The alpha applied to the fill of this Shape, in the range 0 (fully transparent) to 1 (fully opaque).\rOnly used when `isFilled` is `true`. Set via `setFillStyle`.", "name": "fillAlpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#fillAlpha", "scope": "instance", "kind": "member", "___id": "T000002R016644", "___s": true }, { "comment": "/**\r\n * The stroke color used by this Shape, as a hex value (e.g., 0x00ff00 for green).\r\n * Only used when `isStroked` is `true`. Set via `setStrokeStyle`.\r\n *\r\n * @name Phaser.GameObjects.Shape#strokeColor\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The stroke color used by this Shape, as a hex value (e.g., 0x00ff00 for green).\rOnly used when `isStroked` is `true`. Set via `setStrokeStyle`.", "name": "strokeColor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#strokeColor", "scope": "instance", "kind": "member", "___id": "T000002R016646", "___s": true }, { "comment": "/**\r\n * The alpha applied to the stroke of this Shape, in the range 0 (fully transparent) to 1 (fully opaque).\r\n * Only used when `isStroked` is `true`. Set via `setStrokeStyle`.\r\n *\r\n * @name Phaser.GameObjects.Shape#strokeAlpha\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 135, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The alpha applied to the stroke of this Shape, in the range 0 (fully transparent) to 1 (fully opaque).\rOnly used when `isStroked` is `true`. Set via `setStrokeStyle`.", "name": "strokeAlpha", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#strokeAlpha", "scope": "instance", "kind": "member", "___id": "T000002R016648", "___s": true }, { "comment": "/**\r\n * The width of the stroke line for this Shape, in pixels.\r\n * Only used when `isStroked` is `true`. Set via `setStrokeStyle`.\r\n *\r\n * @name Phaser.GameObjects.Shape#lineWidth\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The width of the stroke line for this Shape, in pixels.\rOnly used when `isStroked` is `true`. Set via `setStrokeStyle`.", "name": "lineWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#lineWidth", "scope": "instance", "kind": "member", "___id": "T000002R016650", "___s": true }, { "comment": "/**\r\n * Controls if this Shape is filled or not.\r\n * Note that some Shapes do not support being filled (such as Line shapes)\r\n *\r\n * @name Phaser.GameObjects.Shape#isFilled\r\n * @type {boolean}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 155, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "Controls if this Shape is filled or not.\rNote that some Shapes do not support being filled (such as Line shapes)", "name": "isFilled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#isFilled", "scope": "instance", "kind": "member", "___id": "T000002R016652", "___s": true }, { "comment": "/**\r\n * Controls if this Shape is stroked or not.\r\n * Note that some Shapes do not support being stroked (such as Iso Box shapes)\r\n *\r\n * @name Phaser.GameObjects.Shape#isStroked\r\n * @type {boolean}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 165, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "Controls if this Shape is stroked or not.\rNote that some Shapes do not support being stroked (such as Iso Box shapes)", "name": "isStroked", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#isStroked", "scope": "instance", "kind": "member", "___id": "T000002R016654", "___s": true }, { "comment": "/**\r\n * Controls if this Shape path is closed during rendering when stroked.\r\n * Note that some Shapes are always closed when stroked (such as Ellipse shapes)\r\n *\r\n * @name Phaser.GameObjects.Shape#closePath\r\n * @type {boolean}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 175, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "Controls if this Shape path is closed during rendering when stroked.\rNote that some Shapes are always closed when stroked (such as Ellipse shapes)", "name": "closePath", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#closePath", "scope": "instance", "kind": "member", "___id": "T000002R016656", "___s": true }, { "comment": "/**\r\n * The native (un-scaled) width of this Game Object.\r\n *\r\n * Changing this value will not change the size that the Game Object is rendered in-game.\r\n * For that you need to either set the scale of the Game Object (`setScale`) or use\r\n * the `displayWidth` property.\r\n *\r\n * @name Phaser.GameObjects.Shape#width\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 196, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The native (un-scaled) width of this Game Object.\r\rChanging this value will not change the size that the Game Object is rendered in-game.\rFor that you need to either set the scale of the Game Object (`setScale`) or use\rthe `displayWidth` property.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#width", "scope": "instance", "kind": "member", "___id": "T000002R016660", "___s": true }, { "comment": "/**\r\n * The native (un-scaled) height of this Game Object.\r\n *\r\n * Changing this value will not change the size that the Game Object is rendered in-game.\r\n * For that you need to either set the scale of the Game Object (`setScale`) or use\r\n * the `displayHeight` property.\r\n *\r\n * @name Phaser.GameObjects.Shape#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 209, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The native (un-scaled) height of this Game Object.\r\rChanging this value will not change the size that the Game Object is rendered in-game.\rFor that you need to either set the scale of the Game Object (`setScale`) or use\rthe `displayHeight` property.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#height", "scope": "instance", "kind": "member", "___id": "T000002R016662", "___s": true }, { "comment": "/**\r\n * Sets the fill color and alpha for this Shape.\r\n *\r\n * If you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\r\n *\r\n * Note that some Shapes do not support fill colors, such as the Line shape.\r\n *\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Shape#setFillStyle\r\n * @since 3.13.0\r\n *\r\n * @param {number} [color] - The color used to fill this shape. If not provided the Shape will not be filled.\r\n * @param {number} [alpha=1] - The alpha value used when filling this shape, if a fill color is given.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 248, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "Sets the fill color and alpha for this Shape.\r\rIf you wish for the Shape to not be filled then call this method with no arguments, or just set `isFilled` to `false`.\r\rNote that some Shapes do not support fill colors, such as the Line shape.\r\rThis call can be chained.", "kind": "function", "name": "setFillStyle", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#setFillStyle", "scope": "instance", "___id": "T000002R016668", "___s": true }, { "comment": "/**\r\n * Sets the stroke color and alpha for this Shape.\r\n *\r\n * If you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\r\n *\r\n * Note that some Shapes do not support being stroked, such as the Iso Box shape.\r\n *\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Shape#setStrokeStyle\r\n * @since 3.13.0\r\n *\r\n * @param {number} [lineWidth] - The width of line to stroke with. If not provided or undefined the Shape will not be stroked.\r\n * @param {number} [color] - The color used to stroke this shape. If not provided the Shape will not be stroked.\r\n * @param {number} [alpha=1] - The alpha value used when stroking this shape, if a stroke color is given.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 283, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "Sets the stroke color and alpha for this Shape.\r\rIf you wish for the Shape to not be stroked then call this method with no arguments, or just set `isStroked` to `false`.\r\rNote that some Shapes do not support being stroked, such as the Iso Box shape.\r\rThis call can be chained.", "kind": "function", "name": "setStrokeStyle", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#setStrokeStyle", "scope": "instance", "___id": "T000002R016675", "___s": true }, { "comment": "/**\r\n * Sets if this Shape path is closed during rendering when stroked.\r\n * Note that some Shapes are always closed when stroked (such as Ellipse shapes)\r\n *\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Shape#setClosePath\r\n * @since 3.13.0\r\n *\r\n * @param {boolean} value - Set to `true` if the Shape should be closed when stroked, otherwise `false`.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 320, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "Sets if this Shape path is closed during rendering when stroked.\rNote that some Shapes are always closed when stroked (such as Ellipse shapes)\r\rThis call can be chained.", "kind": "function", "name": "setClosePath", "since": "3.13.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Set to `true` if the Shape should be closed when stroked, otherwise `false`.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#setClosePath", "scope": "instance", "___id": "T000002R016683", "___s": true }, { "comment": "/**\r\n * Sets the displayed pixel size of this Shape by adjusting its `scaleX` and `scaleY` properties\r\n * relative to its native width and height. This is equivalent to calling `setScale` but lets you\r\n * specify the desired rendered dimensions in pixels rather than as a scale multiplier.\r\n *\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Shape#setDisplaySize\r\n * @since 3.53.0\r\n *\r\n * @param {number} width - The display width of this Shape, in pixels.\r\n * @param {number} height - The display height of this Shape, in pixels.\r\n *\r\n * @return {this} This Shape instance.\r\n */", "meta": { "filename": "Shape.js", "lineno": 368, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "Sets the displayed pixel size of this Shape by adjusting its `scaleX` and `scaleY` properties\rrelative to its native width and height. This is equivalent to calling `setScale` but lets you\rspecify the desired rendered dimensions in pixels rather than as a scale multiplier.\r\rThis call can be chained.", "kind": "function", "name": "setDisplaySize", "since": "3.53.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display width of this Shape, in pixels.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The display height of this Shape, in pixels.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Shape instance." } ], "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#setDisplaySize", "scope": "instance", "___id": "T000002R016690", "___s": true }, { "comment": "/**\r\n * Internal destroy handler, called as part of the destroy process.\r\n *\r\n * @method Phaser.GameObjects.Shape#preDestroy\r\n * @protected\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 391, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "Internal destroy handler, called as part of the destroy process.", "kind": "function", "name": "preDestroy", "access": "protected", "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#preDestroy", "scope": "instance", "___id": "T000002R016694", "___s": true }, { "comment": "/**\r\n * The displayed width of this Game Object.\r\n *\r\n * This value takes into account the scale factor.\r\n *\r\n * Setting this value will adjust the Game Object's scale property.\r\n *\r\n * @name Phaser.GameObjects.Shape#displayWidth\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 406, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The displayed width of this Game Object.\r\rThis value takes into account the scale factor.\r\rSetting this value will adjust the Game Object's scale property.", "name": "displayWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#displayWidth", "scope": "instance", "kind": "member", "___id": "T000002R016700", "___s": true }, { "comment": "/**\r\n * The displayed height of this Game Object.\r\n *\r\n * This value takes into account the scale factor.\r\n *\r\n * Setting this value will adjust the Game Object's scale property.\r\n *\r\n * @name Phaser.GameObjects.Shape#displayHeight\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Shape.js", "lineno": 431, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape", "code": {} }, "description": "The displayed height of this Game Object.\r\rThis value takes into account the scale factor.\r\rSetting this value will adjust the Game Object's scale property.", "name": "displayHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Shape", "longname": "Phaser.GameObjects.Shape#displayHeight", "scope": "instance", "kind": "member", "___id": "T000002R016705", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Star Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports both fill and stroke colors.\r\n *\r\n * As the name implies, the Star shape will display a star in your game. You can control several\r\n * aspects of it including the number of points that constitute the star. The default is 5. If\r\n * you change it to 4 it will render as a diamond. If you increase them, you'll get a more spiky\r\n * star shape.\r\n *\r\n * You can also control the inner and outer radius, which is how 'long' each point of the star is.\r\n * Modify these values to create more interesting shapes.\r\n *\r\n * @class Star\r\n * @extends Phaser.GameObjects.Shape\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.13.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [points=5] - The number of points on the star.\r\n * @param {number} [innerRadius=32] - The inner radius of the star, in pixels.\r\n * @param {number} [outerRadius=64] - The outer radius of the star, in pixels.\r\n * @param {number} [fillColor] - The color the star will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the star will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n */", "meta": { "filename": "Star.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\star", "code": {} }, "classdesc": "The Star Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports both fill and stroke colors.\r\rAs the name implies, the Star shape will display a star in your game. You can control several\raspects of it including the number of points that constitute the star. The default is 5. If\ryou change it to 4 it will render as a diamond. If you increase them, you'll get a more spiky\rstar shape.\r\rYou can also control the inner and outer radius, which is how 'long' each point of the star is.\rModify 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 5, "description": "The number of points on the star.", "name": "points" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The inner radius of the star, in pixels.", "name": "innerRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 64, "description": "The outer radius of the star, in pixels.", "name": "outerRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the star will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R016715", "___s": true }, { "comment": "/**\r\n * Sets the number of points that make up the Star shape.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Star#setPoints\r\n * @since 3.13.0\r\n *\r\n * @param {number} value - The number of points the Star will have.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Star.js", "lineno": 109, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\star", "code": {} }, "description": "Sets the number of points that make up the Star shape.\rThis call can be chained.", "kind": "function", "name": "setPoints", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of points the Star will have.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "longname": "Phaser.GameObjects.Star#setPoints", "scope": "instance", "___id": "T000002R016731", "___s": true }, { "comment": "/**\r\n * Sets the inner radius of the Star shape.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Star#setInnerRadius\r\n * @since 3.13.0\r\n *\r\n * @param {number} value - The inner radius of the star, in pixels.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Star.js", "lineno": 127, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\star", "code": {} }, "description": "Sets the inner radius of the Star shape.\rThis call can be chained.", "kind": "function", "name": "setInnerRadius", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The inner radius of the star, in pixels.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "longname": "Phaser.GameObjects.Star#setInnerRadius", "scope": "instance", "___id": "T000002R016734", "___s": true }, { "comment": "/**\r\n * Sets the outer radius of the Star shape.\r\n * This call can be chained.\r\n *\r\n * @method Phaser.GameObjects.Star#setOuterRadius\r\n * @since 3.13.0\r\n *\r\n * @param {number} value - The outer radius of the star, in pixels.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Star.js", "lineno": 145, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\star", "code": {} }, "description": "Sets the outer radius of the Star shape.\rThis call can be chained.", "kind": "function", "name": "setOuterRadius", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The outer radius of the star, in pixels.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Star", "longname": "Phaser.GameObjects.Star#setOuterRadius", "scope": "instance", "___id": "T000002R016737", "___s": true }, { "comment": "/**\r\n * The number of points that make up the Star shape.\r\n *\r\n * @name Phaser.GameObjects.Star#points\r\n * @type {number}\r\n * @default 5\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Star.js", "lineno": 163, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\star", "code": {} }, "description": "The number of points that make up the Star shape.", "name": "points", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "5", "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "longname": "Phaser.GameObjects.Star#points", "scope": "instance", "kind": "member", "___id": "T000002R016740", "___s": true }, { "comment": "/**\r\n * The inner radius of the Star shape, in pixels.\r\n *\r\n * @name Phaser.GameObjects.Star#innerRadius\r\n * @type {number}\r\n * @default 32\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Star.js", "lineno": 187, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\star", "code": {} }, "description": "The inner radius of the Star shape, in pixels.", "name": "innerRadius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "32", "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "longname": "Phaser.GameObjects.Star#innerRadius", "scope": "instance", "kind": "member", "___id": "T000002R016745", "___s": true }, { "comment": "/**\r\n * The outer radius of the Star shape, in pixels.\r\n *\r\n * @name Phaser.GameObjects.Star#outerRadius\r\n * @type {number}\r\n * @default 64\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Star.js", "lineno": 211, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\star", "code": {} }, "description": "The outer radius of the Star shape, in pixels.", "name": "outerRadius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "64", "since": "3.13.0", "memberof": "Phaser.GameObjects.Star", "longname": "Phaser.GameObjects.Star#outerRadius", "scope": "instance", "kind": "member", "___id": "T000002R016750", "___s": true }, { "comment": "/**\r\n * Creates a new Star Shape Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Star Game Object has been built into Phaser.\r\n *\r\n * The Star Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports both fill and stroke colors.\r\n *\r\n * As the name implies, the Star shape will display a star in your game. You can control several\r\n * aspects of it including the number of points that constitute the star. The default is 5. If\r\n * you change it to 4 it will render as a diamond. If you increase them, you'll get a more spiky\r\n * star shape.\r\n *\r\n * You can also control the inner and outer radius, which is how 'long' each point of the star is.\r\n * Modify these values to create more interesting shapes.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#star\r\n * @since 3.13.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [points=5] - The number of points on the star.\r\n * @param {number} [innerRadius=32] - The inner radius of the star.\r\n * @param {number} [outerRadius=64] - The outer radius of the star.\r\n * @param {number} [fillColor] - The color the star will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the star will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n *\r\n * @return {Phaser.GameObjects.Star} The Game Object that was created.\r\n */", "meta": { "filename": "StarFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\star", "code": {} }, "description": "Creates a new Star Shape Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Star Game Object has been built into Phaser.\r\rThe Star Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports both fill and stroke colors.\r\rAs the name implies, the Star shape will display a star in your game. You can control several\raspects of it including the number of points that constitute the star. The default is 5. If\ryou change it to 4 it will render as a diamond. If you increase them, you'll get a more spiky\rstar shape.\r\rYou can also control the inner and outer radius, which is how 'long' each point of the star is.\rModify these values to create more interesting shapes.", "kind": "function", "name": "star", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 5, "description": "The number of points on the star.", "name": "points" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 32, "description": "The inner radius of the star.", "name": "innerRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 64, "description": "The outer radius of the star.", "name": "outerRadius" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the star will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Star" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#star", "scope": "instance", "___id": "T000002R016791", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Triangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports both fill and stroke colors.\r\n *\r\n * The Triangle consists of 3 lines, joining up to form a triangular shape. You can control the\r\n * position of each point of these lines. The triangle is always closed and cannot have an open\r\n * face. If you require that, consider using a Polygon instead.\r\n *\r\n * @class Triangle\r\n * @extends Phaser.GameObjects.Shape\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.13.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [x1=0] - The horizontal position of the first point in the triangle.\r\n * @param {number} [y1=128] - The vertical position of the first point in the triangle.\r\n * @param {number} [x2=64] - The horizontal position of the second point in the triangle.\r\n * @param {number} [y2=0] - The vertical position of the second point in the triangle.\r\n * @param {number} [x3=128] - The horizontal position of the third point in the triangle.\r\n * @param {number} [y3=128] - The vertical position of the third point in the triangle.\r\n * @param {number} [fillColor] - The color the triangle will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the triangle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n */", "meta": { "filename": "Triangle.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\triangle", "code": {} }, "classdesc": "The Triangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports both fill and stroke colors.\r\rThe Triangle consists of 3 lines, joining up to form a triangular shape. You can control the\rposition of each point of these lines. The triangle is always closed and cannot have an open\rface. 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the first point in the triangle.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The vertical position of the first point in the triangle.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 64, "description": "The horizontal position of the second point in the triangle.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the second point in the triangle.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The horizontal position of the third point in the triangle.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The vertical position of the third point in the triangle.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the triangle will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R016835", "___s": true }, { "comment": "/**\r\n * Sets the positions of the three vertices of this Triangle shape and updates its internal path data for rendering.\r\n *\r\n * @method Phaser.GameObjects.Triangle#setTo\r\n * @since 3.13.0\r\n *\r\n * @param {number} [x1=0] - The horizontal position of the first point in the triangle.\r\n * @param {number} [y1=0] - The vertical position of the first point in the triangle.\r\n * @param {number} [x2=0] - The horizontal position of the second point in the triangle.\r\n * @param {number} [y2=0] - The vertical position of the second point in the triangle.\r\n * @param {number} [x3=0] - The horizontal position of the third point in the triangle.\r\n * @param {number} [y3=0] - The vertical position of the third point in the triangle.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Triangle.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\triangle", "code": {} }, "description": "Sets the positions of the three vertices of this Triangle shape and updates its internal path data for rendering.", "kind": "function", "name": "setTo", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the first point in the triangle.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the first point in the triangle.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the second point in the triangle.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the second point in the triangle.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the third point in the triangle.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the third point in the triangle.", "name": "y3" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Triangle", "longname": "Phaser.GameObjects.Triangle#setTo", "scope": "instance", "___id": "T000002R016850", "___s": true }, { "comment": "/**\r\n * Creates a new Triangle Shape Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Triangle Game Object has been built into Phaser.\r\n *\r\n * The Triangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\r\n * treat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\r\n * it for input or physics. It provides a quick and easy way for you to render this shape in your\r\n * game without using a texture, while still taking advantage of being fully batched in WebGL.\r\n *\r\n * This shape supports both fill and stroke colors.\r\n *\r\n * The Triangle consists of 3 lines, joining up to form a triangular shape. You can control the\r\n * position of each point of these lines. The triangle is always closed and cannot have an open\r\n * face. If you require that, consider using a Polygon instead.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#triangle\r\n * @since 3.13.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {number} [x1=0] - The horizontal position of the first point in the triangle.\r\n * @param {number} [y1=128] - The vertical position of the first point in the triangle.\r\n * @param {number} [x2=64] - The horizontal position of the second point in the triangle.\r\n * @param {number} [y2=0] - The vertical position of the second point in the triangle.\r\n * @param {number} [x3=128] - The horizontal position of the third point in the triangle.\r\n * @param {number} [y3=128] - The vertical position of the third point in the triangle.\r\n * @param {number} [fillColor] - The color the triangle will be filled with, i.e. 0xff0000 for red.\r\n * @param {number} [fillAlpha] - The alpha the triangle will be filled with. You can also set the alpha of the overall Shape using its `alpha` property.\r\n *\r\n * @return {Phaser.GameObjects.Triangle} The Game Object that was created.\r\n */", "meta": { "filename": "TriangleFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\shape\\triangle", "code": {} }, "description": "Creates a new Triangle Shape Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Triangle Game Object has been built into Phaser.\r\rThe Triangle Shape is a Game Object that can be added to a Scene, Group or Container. You can\rtreat it like any other Game Object in your game, such as tweening it, scaling it, or enabling\rit for input or physics. It provides a quick and easy way for you to render this shape in your\rgame without using a texture, while still taking advantage of being fully batched in WebGL.\r\rThis shape supports both fill and stroke colors.\r\rThe Triangle consists of 3 lines, joining up to form a triangular shape. You can control the\rposition of each point of these lines. The triangle is always closed and cannot have an open\rface. If you require that, consider using a Polygon instead.", "kind": "function", "name": "triangle", "since": "3.13.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of the first point in the triangle.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The vertical position of the first point in the triangle.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 64, "description": "The horizontal position of the second point in the triangle.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of the second point in the triangle.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The horizontal position of the third point in the triangle.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 128, "description": "The vertical position of the third point in the triangle.", "name": "y3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The color the triangle will be filled with, i.e. 0xff0000 for red.", "name": "fillColor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Triangle" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#triangle", "scope": "instance", "___id": "T000002R016876", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Sprite Game Object.\r\n *\r\n * A Sprite Game Object is used for the display of both static and animated images in your game.\r\n * Sprites can have input events and physics bodies. They can also be tweened, tinted, scrolled\r\n * and animated.\r\n *\r\n * The main difference between a Sprite and an Image Game Object is that you cannot animate Images.\r\n * As such, Sprites take a fraction longer to process and have a larger API footprint due to the Animation\r\n * Component. If you do not require animation then you can safely use Images to replace Sprites in all cases.\r\n *\r\n * @class Sprite\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.GameObjects.Components.Alpha\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Flip\r\n * @extends Phaser.GameObjects.Components.GetBounds\r\n * @extends Phaser.GameObjects.Components.Lighting\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Size\r\n * @extends Phaser.GameObjects.Components.TextureCrop\r\n * @extends Phaser.GameObjects.Components.Tint\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n */", "meta": { "filename": "Sprite.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "classdesc": "A Sprite Game Object.\r\rA Sprite Game Object is used for the display of both static and animated images in your game.\rSprites can have input events and physics bodies. They can also be tweened, tinted, scrolled\rand animated.\r\rThe main difference between a Sprite and an Image Game Object is that you cannot animate Images.\rAs such, Sprites take a fraction longer to process and have a larger API footprint due to the Animation\rComponent. 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.Lighting", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.RenderNodes", "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "scope": "static", "longname": "Phaser.GameObjects.Sprite", "___id": "T000002R016912", "___s": true }, { "comment": "/**\r\n * The Animation State component of this Sprite.\r\n *\r\n * This component provides features to apply animations to this Sprite.\r\n * It is responsible for playing, loading, queuing animations for later playback,\r\n * mixing between animations and setting the current animation frame to this Sprite.\r\n *\r\n * @name Phaser.GameObjects.Sprite#anims\r\n * @type {Phaser.Animations.AnimationState}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sprite.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "The Animation State component of this Sprite.\r\rThis component provides features to apply animations to this Sprite.\rIt is responsible for playing, loading, queuing animations for later playback,\rmixing between animations and setting the current animation frame to this Sprite.", "name": "anims", "type": { "names": [ "Phaser.Animations.AnimationState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationState" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Sprite", "longname": "Phaser.GameObjects.Sprite#anims", "scope": "instance", "kind": "member", "___id": "T000002R016919", "___s": true }, { "comment": "/**\r\n * Called automatically by Phaser when this Sprite is added to a Scene.\r\n *\r\n * Registers this Sprite with the Scene's update list so that its `preUpdate` method\r\n * is called each game step, allowing animations to advance each frame.\r\n *\r\n * @method Phaser.GameObjects.Sprite#addedToScene\r\n * @since 3.53.0\r\n */", "meta": { "filename": "Sprite.js", "lineno": 130, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Called automatically by Phaser when this Sprite is added to a Scene.\r\rRegisters this Sprite with the Scene's update list so that its `preUpdate` method\ris called each game step, allowing animations to advance each frame.", "kind": "function", "name": "addedToScene", "since": "3.53.0", "memberof": "Phaser.GameObjects.Sprite", "longname": "Phaser.GameObjects.Sprite#addedToScene", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#addedToScene", "___id": "T000002R016924", "___s": true }, { "comment": "/**\r\n * Called automatically by Phaser when this Sprite is removed from a Scene.\r\n *\r\n * Unregisters this Sprite from the Scene's update list so that its `preUpdate` method\r\n * is no longer called each game step.\r\n *\r\n * @method Phaser.GameObjects.Sprite#removedFromScene\r\n * @since 3.53.0\r\n */", "meta": { "filename": "Sprite.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Called automatically by Phaser when this Sprite is removed from a Scene.\r\rUnregisters this Sprite from the Scene's update list so that its `preUpdate` method\ris no longer called each game step.", "kind": "function", "name": "removedFromScene", "since": "3.53.0", "memberof": "Phaser.GameObjects.Sprite", "longname": "Phaser.GameObjects.Sprite#removedFromScene", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#removedFromScene", "___id": "T000002R016926", "___s": true }, { "comment": "/**\r\n * Update this Sprite's animations.\r\n *\r\n * @method Phaser.GameObjects.Sprite#preUpdate\r\n * @protected\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current timestamp.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "Sprite.js", "lineno": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Update this Sprite's animations.", "kind": "function", "name": "preUpdate", "access": "protected", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time, in ms, elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.GameObjects.Sprite", "longname": "Phaser.GameObjects.Sprite#preUpdate", "scope": "instance", "___id": "T000002R016928", "___s": true }, { "comment": "/**\r\n * Start playing the given animation on this Sprite.\r\n *\r\n * Animations in Phaser can either belong to the global Animation Manager, or specifically to this Sprite.\r\n *\r\n * The benefit of a global animation is that multiple Sprites can all play the same animation, without\r\n * having to duplicate the data. You can just create it once and then play it on any Sprite.\r\n *\r\n * The following code shows how to create a global repeating animation. The animation will be created\r\n * from all of the frames within the sprite sheet that was loaded with the key 'muybridge':\r\n *\r\n * ```javascript\r\n * var config = {\r\n * key: 'run',\r\n * frames: 'muybridge',\r\n * frameRate: 15,\r\n * repeat: -1\r\n * };\r\n *\r\n * // This code should be run from within a Scene:\r\n * this.anims.create(config);\r\n * ```\r\n *\r\n * However, if you wish to create an animation that is unique to this Sprite, and this Sprite alone,\r\n * you can call the `Animation.create` method instead. It accepts the exact same parameters as when\r\n * creating a global animation, however the resulting data is kept locally in this Sprite.\r\n *\r\n * With the animation created, either globally or locally, you can now play it on this Sprite:\r\n *\r\n * ```javascript\r\n * this.add.sprite(x, y).play('run');\r\n * ```\r\n *\r\n * Alternatively, if you wish to run it at a different frame rate, for example, you can pass a config\r\n * object instead:\r\n *\r\n * ```javascript\r\n * this.add.sprite(x, y).play({ key: 'run', frameRate: 24 });\r\n * ```\r\n *\r\n * When playing an animation on a Sprite it will first check to see if it can find a matching key\r\n * locally within the Sprite. If it can, it will play the local animation. If not, it will then\r\n * search the global Animation Manager and look for it there.\r\n *\r\n * If you need a Sprite to be able to play both local and global animations, make sure they don't\r\n * have conflicting keys.\r\n *\r\n * See the documentation for the `PlayAnimationConfig` config object for more details about this.\r\n *\r\n * Also, see the documentation in the Animation Manager for further details on creating animations.\r\n *\r\n * @method Phaser.GameObjects.Sprite#play\r\n * @fires Phaser.Animations.Events#ANIMATION_START\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig)} key - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.\r\n * @param {boolean} [ignoreIfPlaying=false] - If an animation is already playing then ignore this call.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Sprite.js", "lineno": 173, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Start playing the given animation on this Sprite.\r\rAnimations in Phaser can either belong to the global Animation Manager, or specifically to this Sprite.\r\rThe benefit of a global animation is that multiple Sprites can all play the same animation, without\rhaving to duplicate the data. You can just create it once and then play it on any Sprite.\r\rThe following code shows how to create a global repeating animation. The animation will be created\rfrom all of the frames within the sprite sheet that was loaded with the key 'muybridge':\r\r```javascript\rvar config = {\r key: 'run',\r frames: 'muybridge',\r frameRate: 15,\r repeat: -1\r};\r\r// This code should be run from within a Scene:\rthis.anims.create(config);\r```\r\rHowever, if you wish to create an animation that is unique to this Sprite, and this Sprite alone,\ryou can call the `Animation.create` method instead. It accepts the exact same parameters as when\rcreating a global animation, however the resulting data is kept locally in this Sprite.\r\rWith the animation created, either globally or locally, you can now play it on this Sprite:\r\r```javascript\rthis.add.sprite(x, y).play('run');\r```\r\rAlternatively, if you wish to run it at a different frame rate, for example, you can pass a config\robject instead:\r\r```javascript\rthis.add.sprite(x, y).play({ key: 'run', frameRate: 24 });\r```\r\rWhen playing an animation on a Sprite it will first check to see if it can find a matching key\rlocally within the Sprite. If it can, it will play the local animation. If not, it will then\rsearch the global Animation Manager and look for it there.\r\rIf you need a Sprite to be able to play both local and global animations, make sure they don't\rhave conflicting keys.\r\rSee the documentation for the `PlayAnimationConfig` config object for more details about this.\r\rAlso, see the documentation in the Animation Manager for further details on creating animations.", "kind": "function", "name": "play", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ] } }, "description": "The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If an animation is already playing then ignore this call.", "name": "ignoreIfPlaying" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Sprite", "longname": "Phaser.GameObjects.Sprite#play", "scope": "instance", "___id": "T000002R016930", "___s": true }, { "comment": "/**\r\n * Start playing the given animation on this Sprite, in reverse.\r\n *\r\n * Animations in Phaser can either belong to the global Animation Manager, or specifically to this Sprite.\r\n *\r\n * The benefit of a global animation is that multiple Sprites can all play the same animation, without\r\n * having to duplicate the data. You can just create it once and then play it on any Sprite.\r\n *\r\n * The following code shows how to create a global repeating animation. The animation will be created\r\n * from all of the frames within the sprite sheet that was loaded with the key 'muybridge':\r\n *\r\n * ```javascript\r\n * var config = {\r\n * key: 'run',\r\n * frames: 'muybridge',\r\n * frameRate: 15,\r\n * repeat: -1\r\n * };\r\n *\r\n * // This code should be run from within a Scene:\r\n * this.anims.create(config);\r\n * ```\r\n *\r\n * However, if you wish to create an animation that is unique to this Sprite, and this Sprite alone,\r\n * you can call the `Animation.create` method instead. It accepts the exact same parameters as when\r\n * creating a global animation, however the resulting data is kept locally in this Sprite.\r\n *\r\n * With the animation created, either globally or locally, you can now play it on this Sprite:\r\n *\r\n * ```javascript\r\n * this.add.sprite(x, y).playReverse('run');\r\n * ```\r\n *\r\n * Alternatively, if you wish to run it at a different frame rate, for example, you can pass a config\r\n * object instead:\r\n *\r\n * ```javascript\r\n * this.add.sprite(x, y).playReverse({ key: 'run', frameRate: 24 });\r\n * ```\r\n *\r\n * When playing an animation on a Sprite it will first check to see if it can find a matching key\r\n * locally within the Sprite. If it can, it will play the local animation. If not, it will then\r\n * search the global Animation Manager and look for it there.\r\n *\r\n * If you need a Sprite to be able to play both local and global animations, make sure they don't\r\n * have conflicting keys.\r\n *\r\n * See the documentation for the `PlayAnimationConfig` config object for more details about this.\r\n *\r\n * Also, see the documentation in the Animation Manager for further details on creating animations.\r\n *\r\n * @method Phaser.GameObjects.Sprite#playReverse\r\n * @fires Phaser.Animations.Events#ANIMATION_START\r\n * @since 3.50.0\r\n *\r\n * @param {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig)} key - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.\r\n * @param {boolean} [ignoreIfPlaying=false] - If an animation is already playing then ignore this call.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Sprite.js", "lineno": 238, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Start playing the given animation on this Sprite, in reverse.\r\rAnimations in Phaser can either belong to the global Animation Manager, or specifically to this Sprite.\r\rThe benefit of a global animation is that multiple Sprites can all play the same animation, without\rhaving to duplicate the data. You can just create it once and then play it on any Sprite.\r\rThe following code shows how to create a global repeating animation. The animation will be created\rfrom all of the frames within the sprite sheet that was loaded with the key 'muybridge':\r\r```javascript\rvar config = {\r key: 'run',\r frames: 'muybridge',\r frameRate: 15,\r repeat: -1\r};\r\r// This code should be run from within a Scene:\rthis.anims.create(config);\r```\r\rHowever, if you wish to create an animation that is unique to this Sprite, and this Sprite alone,\ryou can call the `Animation.create` method instead. It accepts the exact same parameters as when\rcreating a global animation, however the resulting data is kept locally in this Sprite.\r\rWith the animation created, either globally or locally, you can now play it on this Sprite:\r\r```javascript\rthis.add.sprite(x, y).playReverse('run');\r```\r\rAlternatively, if you wish to run it at a different frame rate, for example, you can pass a config\robject instead:\r\r```javascript\rthis.add.sprite(x, y).playReverse({ key: 'run', frameRate: 24 });\r```\r\rWhen playing an animation on a Sprite it will first check to see if it can find a matching key\rlocally within the Sprite. If it can, it will play the local animation. If not, it will then\rsearch the global Animation Manager and look for it there.\r\rIf you need a Sprite to be able to play both local and global animations, make sure they don't\rhave conflicting keys.\r\rSee the documentation for the `PlayAnimationConfig` config object for more details about this.\r\rAlso, see the documentation in the Animation Manager for further details on creating animations.", "kind": "function", "name": "playReverse", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "params": [ { "type": { "names": [ "string", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ] } }, "description": "The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If an animation is already playing then ignore this call.", "name": "ignoreIfPlaying" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Sprite", "longname": "Phaser.GameObjects.Sprite#playReverse", "scope": "instance", "___id": "T000002R016932", "___s": true }, { "comment": "/**\r\n * Waits for the specified delay, in milliseconds, then starts playback of the given animation.\r\n *\r\n * If the animation _also_ has a delay value set in its config, it will be **added** to the delay given here.\r\n *\r\n * If an animation is already running and a new animation is given to this method, it will wait for\r\n * the given delay before starting the new animation.\r\n *\r\n * If no animation is currently running, the given one begins after the delay.\r\n *\r\n * When playing an animation on a Sprite it will first check to see if it can find a matching key\r\n * locally within the Sprite. If it can, it will play the local animation. If not, it will then\r\n * search the global Animation Manager and look for it there.\r\n *\r\n * Prior to Phaser 3.50 this method was called 'delayedPlay'.\r\n *\r\n * @method Phaser.GameObjects.Sprite#playAfterDelay\r\n * @fires Phaser.Animations.Events#ANIMATION_START\r\n * @since 3.50.0\r\n *\r\n * @param {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig)} key - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.\r\n * @param {number} delay - The delay, in milliseconds, to wait before starting the animation playing.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Sprite.js", "lineno": 303, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Waits for the specified delay, in milliseconds, then starts playback of the given animation.\r\rIf the animation _also_ has a delay value set in its config, it will be **added** to the delay given here.\r\rIf an animation is already running and a new animation is given to this method, it will wait for\rthe given delay before starting the new animation.\r\rIf no animation is currently running, the given one begins after the delay.\r\rWhen playing an animation on a Sprite it will first check to see if it can find a matching key\rlocally within the Sprite. If it can, it will play the local animation. If not, it will then\rsearch the global Animation Manager and look for it there.\r\rPrior to Phaser 3.50 this method was called 'delayedPlay'.", "kind": "function", "name": "playAfterDelay", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "params": [ { "type": { "names": [ "string", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ] } }, "description": "The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delay, in milliseconds, to wait before starting the animation playing.", "name": "delay" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Sprite", "longname": "Phaser.GameObjects.Sprite#playAfterDelay", "scope": "instance", "___id": "T000002R016934", "___s": true }, { "comment": "/**\r\n * Waits for the current animation to complete the `repeatCount` number of repeat cycles, then starts playback\r\n * of the given animation.\r\n *\r\n * You can use this to ensure there are no harsh jumps between two sets of animations, i.e. going from an\r\n * idle animation to a walking animation, by making them blend smoothly into each other.\r\n *\r\n * If no animation is currently running, the given one will start immediately.\r\n *\r\n * When playing an animation on a Sprite it will first check to see if it can find a matching key\r\n * locally within the Sprite. If it can, it will play the local animation. If not, it will then\r\n * search the global Animation Manager and look for it there.\r\n *\r\n * @method Phaser.GameObjects.Sprite#playAfterRepeat\r\n * @fires Phaser.Animations.Events#ANIMATION_START\r\n * @since 3.50.0\r\n *\r\n * @param {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig)} key - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.\r\n * @param {number} [repeatCount=1] - How many times should the animation repeat before the next one starts?\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Sprite.js", "lineno": 333, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Waits for the current animation to complete the `repeatCount` number of repeat cycles, then starts playback\rof the given animation.\r\rYou can use this to ensure there are no harsh jumps between two sets of animations, i.e. going from an\ridle animation to a walking animation, by making them blend smoothly into each other.\r\rIf no animation is currently running, the given one will start immediately.\r\rWhen playing an animation on a Sprite it will first check to see if it can find a matching key\rlocally within the Sprite. If it can, it will play the local animation. If not, it will then\rsearch the global Animation Manager and look for it there.", "kind": "function", "name": "playAfterRepeat", "fires": [ "Phaser.Animations.Events#event:ANIMATION_START" ], "since": "3.50.0", "params": [ { "type": { "names": [ "string", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ] } }, "description": "The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How many times should the animation repeat before the next one starts?", "name": "repeatCount" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Sprite", "longname": "Phaser.GameObjects.Sprite#playAfterRepeat", "scope": "instance", "___id": "T000002R016936", "___s": true }, { "comment": "/**\r\n * Sets an animation, or an array of animations, to be played immediately after the current one completes or stops.\r\n *\r\n * The current animation must enter a 'completed' state for this to happen, i.e. finish all of its repeats, delays, etc,\r\n * or have the `stop` method called directly on it.\r\n *\r\n * An animation set to repeat forever will never enter a completed state.\r\n *\r\n * You can chain a new animation at any point, including before the current one starts playing, during it,\r\n * or when it ends (via its `animationcomplete` event).\r\n *\r\n * Chained animations are specific to a Game Object, meaning different Game Objects can have different chained\r\n * animations without impacting the animation they're playing.\r\n *\r\n * Call this method with no arguments to reset all currently chained animations.\r\n *\r\n * When playing an animation on a Sprite it will first check to see if it can find a matching key\r\n * locally within the Sprite. If it can, it will play the local animation. If not, it will then\r\n * search the global Animation Manager and look for it there.\r\n *\r\n * @method Phaser.GameObjects.Sprite#chain\r\n * @since 3.50.0\r\n *\r\n * @param {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig|string[]|Phaser.Animations.Animation[]|Phaser.Types.Animations.PlayAnimationConfig[])} [key] - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object, or an array of them.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Sprite.js", "lineno": 360, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Sets an animation, or an array of animations, to be played immediately after the current one completes or stops.\r\rThe current animation must enter a 'completed' state for this to happen, i.e. finish all of its repeats, delays, etc,\ror have the `stop` method called directly on it.\r\rAn animation set to repeat forever will never enter a completed state.\r\rYou can chain a new animation at any point, including before the current one starts playing, during it,\ror when it ends (via its `animationcomplete` event).\r\rChained animations are specific to a Game Object, meaning different Game Objects can have different chained\ranimations without impacting the animation they're playing.\r\rCall this method with no arguments to reset all currently chained animations.\r\rWhen playing an animation on a Sprite it will first check to see if it can find a matching key\rlocally within the Sprite. If it can, it will play the local animation. If not, it will then\rsearch the global Animation Manager and look for it there.", "kind": "function", "name": "chain", "since": "3.50.0", "params": [ { "type": { "names": [ "string", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig", "Array.", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Animations.Animation", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Animations.PlayAnimationConfig", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object, or an array of them.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Sprite", "longname": "Phaser.GameObjects.Sprite#chain", "scope": "instance", "___id": "T000002R016938", "___s": true }, { "comment": "/**\r\n * Immediately stops the current animation from playing and dispatches the `ANIMATION_STOP` events.\r\n *\r\n * If no animation is playing, no event will be dispatched.\r\n *\r\n * If there is another animation queued (via the `chain` method) then it will start playing immediately.\r\n *\r\n * @method Phaser.GameObjects.Sprite#stop\r\n * @fires Phaser.Animations.Events#ANIMATION_STOP\r\n * @since 3.50.0\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Sprite.js", "lineno": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Immediately stops the current animation from playing and dispatches the `ANIMATION_STOP` events.\r\rIf no animation is playing, no event will be dispatched.\r\rIf there is another animation queued (via the `chain` method) then it will start playing immediately.", "kind": "function", "name": "stop", "fires": [ "Phaser.Animations.Events#event:ANIMATION_STOP" ], "since": "3.50.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Sprite", "longname": "Phaser.GameObjects.Sprite#stop", "scope": "instance", "___id": "T000002R016940", "___s": true }, { "comment": "/**\r\n * Stops the current animation from playing after the specified time delay, given in milliseconds.\r\n *\r\n * It then dispatches the `ANIMATION_STOP` event.\r\n *\r\n * If no animation is running, no events will be dispatched.\r\n *\r\n * If there is another animation in the queue (set via the `chain` method) then it will start playing,\r\n * when the current one stops.\r\n *\r\n * @method Phaser.GameObjects.Sprite#stopAfterDelay\r\n * @fires Phaser.Animations.Events#ANIMATION_STOP\r\n * @since 3.50.0\r\n *\r\n * @param {number} delay - The number of milliseconds to wait before stopping this animation.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Sprite.js", "lineno": 410, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Stops the current animation from playing after the specified time delay, given in milliseconds.\r\rIt then dispatches the `ANIMATION_STOP` event.\r\rIf no animation is running, no events will be dispatched.\r\rIf there is another animation in the queue (set via the `chain` method) then it will start playing,\rwhen the current one stops.", "kind": "function", "name": "stopAfterDelay", "fires": [ "Phaser.Animations.Events#event:ANIMATION_STOP" ], "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of milliseconds to wait before stopping this animation.", "name": "delay" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Sprite", "longname": "Phaser.GameObjects.Sprite#stopAfterDelay", "scope": "instance", "___id": "T000002R016942", "___s": true }, { "comment": "/**\r\n * Stops the current animation from playing after the given number of repeats.\r\n *\r\n * It then dispatches the `ANIMATION_STOP` event.\r\n *\r\n * If no animation is running, no events will be dispatched.\r\n *\r\n * If there is another animation in the queue (set via the `chain` method) then it will start playing,\r\n * when the current one stops.\r\n *\r\n * @method Phaser.GameObjects.Sprite#stopAfterRepeat\r\n * @fires Phaser.Animations.Events#ANIMATION_STOP\r\n * @since 3.50.0\r\n *\r\n * @param {number} [repeatCount=1] - How many times should the animation repeat before stopping?\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Sprite.js", "lineno": 433, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Stops the current animation from playing after the given number of repeats.\r\rIt then dispatches the `ANIMATION_STOP` event.\r\rIf no animation is running, no events will be dispatched.\r\rIf there is another animation in the queue (set via the `chain` method) then it will start playing,\rwhen the current one stops.", "kind": "function", "name": "stopAfterRepeat", "fires": [ "Phaser.Animations.Events#event:ANIMATION_STOP" ], "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "How many times should the animation repeat before stopping?", "name": "repeatCount" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Sprite", "longname": "Phaser.GameObjects.Sprite#stopAfterRepeat", "scope": "instance", "___id": "T000002R016944", "___s": true }, { "comment": "/**\r\n * Stops the current animation from playing when it next sets the given frame.\r\n * If this frame doesn't exist within the animation it will not stop it from playing.\r\n *\r\n * It then dispatches the `ANIMATION_STOP` event.\r\n *\r\n * If no animation is running, no events will be dispatched.\r\n *\r\n * If there is another animation in the queue (set via the `chain` method) then it will start playing,\r\n * when the current one stops.\r\n *\r\n * @method Phaser.GameObjects.Sprite#stopOnFrame\r\n * @fires Phaser.Animations.Events#ANIMATION_STOP\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Animations.AnimationFrame} frame - The frame to check before stopping this animation.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Sprite.js", "lineno": 456, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Stops the current animation from playing when it next sets the given frame.\rIf this frame doesn't exist within the animation it will not stop it from playing.\r\rIt then dispatches the `ANIMATION_STOP` event.\r\rIf no animation is running, no events will be dispatched.\r\rIf there is another animation in the queue (set via the `chain` method) then it will start playing,\rwhen the current one stops.", "kind": "function", "name": "stopOnFrame", "fires": [ "Phaser.Animations.Events#event:ANIMATION_STOP" ], "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Animations.AnimationFrame" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationFrame" } }, "description": "The frame to check before stopping this animation.", "name": "frame" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Sprite", "longname": "Phaser.GameObjects.Sprite#stopOnFrame", "scope": "instance", "___id": "T000002R016946", "___s": true }, { "comment": "/**\r\n * Build a JSON representation of this Sprite.\r\n *\r\n * @method Phaser.GameObjects.Sprite#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.GameObjects.JSONGameObject} A JSON representation of the Game Object.\r\n */", "meta": { "filename": "Sprite.js", "lineno": 480, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Build a JSON representation of this Sprite.", "kind": "function", "name": "toJSON", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.JSONGameObject" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R016948", "___s": true }, { "comment": "/**\r\n * Creates a new Sprite Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Sprite Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#sprite\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Sprite.SpriteConfig} config - The configuration object this Game Object will use to create itself.\r\n * @param {boolean} [addToScene=true] - Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.\r\n *\r\n * @return {Phaser.GameObjects.Sprite} The Game Object that was created.\r\n */", "meta": { "filename": "SpriteCreator.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Creates a new Sprite Game Object and returns it.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Sprite.SpriteConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#sprite", "scope": "instance", "___id": "T000002R016962", "___s": true }, { "comment": "/**\r\n * Creates a new Sprite Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Sprite Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#sprite\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.GameObjects.Sprite} The Game Object that was created.\r\n */", "meta": { "filename": "SpriteFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite", "code": {} }, "description": "Creates a new Sprite Game Object and adds it to the Scene.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Sprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Sprite" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#sprite", "scope": "instance", "___id": "T000002R016970", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Sprite\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite\\typedefs", "code": {} }, "kind": "namespace", "name": "Sprite", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Sprite", "scope": "static", "___id": "T000002R016984", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Sprite.SpriteConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 3.0.0\r\n *\r\n * @property {(string|Phaser.Textures.Texture)} [key] - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @property {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n * @property {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig)} [anims] - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.\r\n * @property {boolean} [useSpriteSheet] - This property is used exclusively by `Tilemap.createFromTiles`. Set to `true` if this Sprite is being created by a Tilemap and is part of a spritesheet.\r\n */", "meta": { "filename": "SpriteConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\sprite\\typedefs", "code": {} }, "kind": "typedef", "name": "SpriteConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "3.0.0", "properties": [ { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "key" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" }, { "type": { "names": [ "string", "Phaser.Animations.Animation", "Phaser.Types.Animations.PlayAnimationConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Animations.Animation" }, { "type": "NameExpression", "name": "Phaser.Types.Animations.PlayAnimationConfig" } ] } }, "optional": true, "description": "The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.", "name": "anims" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "This property is used exclusively by `Tilemap.createFromTiles`. Set to `true` if this Sprite is being created by a Tilemap and is part of a spritesheet.", "name": "useSpriteSheet" } ], "memberof": "Phaser.Types.GameObjects.Sprite", "longname": "Phaser.Types.GameObjects.Sprite.SpriteConfig", "scope": "static", "___id": "T000002R016985", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A SpriteGPULayer GameObject. This is a WebGL only GameObject.\r\n * It is optimized for rendering very large numbers of quads\r\n * following simple tween animations.\r\n * It is suited to complex backgrounds with animation.\r\n *\r\n * A SpriteGPULayer is a composite object that contains a collection of\r\n * Member objects. It stores the rendering data for these\r\n * objects in a GPU buffer, and renders them in a single draw call.\r\n * Because it only updates the GPU buffer when necessary,\r\n * it is up to 100 times faster than rendering the objects individually.\r\n * Avoid changing the contents of the SpriteGPULayer frequently, as this\r\n * requires the whole buffer to be updated.\r\n *\r\n * The layer can generally perform well with a million small quads.\r\n * The exact performance will depend on the device and the size of the quads.\r\n * If the quads are large, the layer will be fill-rate limited.\r\n * Avoid drawing more than a few million pixels per frame.\r\n *\r\n * When populating the SpriteGPULayer, use `addMember` to add a new member\r\n * to the top of the layer. You should populate the layer all at once,\r\n * and leave it unchanged, rather than frequently adding and removing members,\r\n * because it is expensive to update the buffer.\r\n *\r\n * Rather than create a new `SpriteGPULayer.Member` object for each `addMember` call,\r\n * you can reuse the same object. This is more efficient,\r\n * because creating millions of objects has a major performance cost\r\n * and may cause garbage collection issues.\r\n *\r\n * Notes on modifying the SpriteGPULayer:\r\n *\r\n * The following operations are expensive. They require some or all of the\r\n * buffer to be updated:\r\n *\r\n * - `addData`\r\n * - `addMember`\r\n * - `editMember`\r\n * - `patchMember`\r\n * - `resize`\r\n * - `removeMembers`\r\n *\r\n * Members are added at the end of the buffer. Removed members are spliced out\r\n * of the buffer, causing the whole buffer to be updated.\r\n * The index of later members will change if you remove an earlier member.\r\n * If you need to maintain a structure, such as a grid of tiles,\r\n * it's best to \"remove\" a member by setting its scaleX, scaleY, and alpha to 0.\r\n * It is still rendered, but it does not fill any pixels.\r\n *\r\n * Changes to a small segment of the buffer are less expensive.\r\n * The buffer is split into several segments, and each segment can be updated\r\n * independently. Editing and patching members will only update the segments\r\n * that contain the members being edited.\r\n * Updating occurs at render time, so edits all happen at once.\r\n * This can reduce the amount of data that needs to be updated,\r\n * but it is still more expensive than not updating the buffer at all.\r\n * If you're updating a large number of segments, it may be more efficient\r\n * to call `setAllSegmentsNeedUpdate` and update the whole buffer at once\r\n * rather than make several segment updates in a row.\r\n *\r\n * The animations in the initial member data are used to compile the shader\r\n * and `frameDataTexture`. If you add new animations after the initial\r\n * compilation, the shader and texture will be rebuilt, which is expensive.\r\n *\r\n * Notes on textures:\r\n *\r\n * This layer gains much of its speed from inflexibility. It can only use one\r\n * texture, and that texture must be a single image.\r\n * It cannot use multi-atlas textures.\r\n *\r\n * Further, if the texture is not a power of two in size,\r\n * some texture seaming may occur if you line up sprites exactly.\r\n * This is because the GPU precision is limited by binary logic,\r\n * and texture coordinates will only be perfectly accurate for power of two textures.\r\n * This can be avoided by adding/extruding a pixel of padding around each frame\r\n * in the texture, or by using a power of two texture.\r\n *\r\n * Which should you use?\r\n *\r\n * - If you are using pixel art mode or round pixels,\r\n * you should aim to use a power of two texture.\r\n * - If you are using smooth mode, you can use a non-power of two texture,\r\n * but you should add padding around each frame to avoid seaming.\r\n * - If you are using a single image, or none of the frames in the texture\r\n * need to tile, it doesn't matter.\r\n *\r\n * @class SpriteGPULayer\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @webglOnly\r\n *\r\n * @extends Phaser.GameObjects.Components.Alpha\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.ElapseTimer\r\n * @extends Phaser.GameObjects.Components.Lighting\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.TextureCrop\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @constructor\r\n * @since 4.0.0\r\n * @param {Phaser.Scene} scene - The Scene to which this SpriteGPULayer belongs.\r\n * @param {Phaser.Textures.Texture} texture - The texture that will be used to render the SpriteGPULayer. This must be sourced from a single image; a multi atlas will not work.\r\n * @param {number} size - The maximum number of quads that this SpriteGPULayer will hold. This can be increased later if necessary.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "classdesc": "A SpriteGPULayer GameObject. This is a WebGL only GameObject.\rIt is optimized for rendering very large numbers of quads\rfollowing simple tween animations.\rIt is suited to complex backgrounds with animation.\r\rA SpriteGPULayer is a composite object that contains a collection of\rMember objects. It stores the rendering data for these\robjects in a GPU buffer, and renders them in a single draw call.\rBecause it only updates the GPU buffer when necessary,\rit is up to 100 times faster than rendering the objects individually.\rAvoid changing the contents of the SpriteGPULayer frequently, as this\rrequires the whole buffer to be updated.\r\rThe layer can generally perform well with a million small quads.\rThe exact performance will depend on the device and the size of the quads.\rIf the quads are large, the layer will be fill-rate limited.\rAvoid drawing more than a few million pixels per frame.\r\rWhen populating the SpriteGPULayer, use `addMember` to add a new member\rto the top of the layer. You should populate the layer all at once,\rand leave it unchanged, rather than frequently adding and removing members,\rbecause it is expensive to update the buffer.\r\rRather than create a new `SpriteGPULayer.Member` object for each `addMember` call,\ryou can reuse the same object. This is more efficient,\rbecause creating millions of objects has a major performance cost\rand may cause garbage collection issues.\r\rNotes on modifying the SpriteGPULayer:\r\rThe following operations are expensive. They require some or all of the\rbuffer to be updated:\r\r- `addData`\r- `addMember`\r- `editMember`\r- `patchMember`\r- `resize`\r- `removeMembers`\r\rMembers are added at the end of the buffer. Removed members are spliced out\rof the buffer, causing the whole buffer to be updated.\rThe index of later members will change if you remove an earlier member.\rIf you need to maintain a structure, such as a grid of tiles,\rit's best to \"remove\" a member by setting its scaleX, scaleY, and alpha to 0.\rIt is still rendered, but it does not fill any pixels.\r\rChanges to a small segment of the buffer are less expensive.\rThe buffer is split into several segments, and each segment can be updated\rindependently. Editing and patching members will only update the segments\rthat contain the members being edited.\rUpdating occurs at render time, so edits all happen at once.\rThis can reduce the amount of data that needs to be updated,\rbut it is still more expensive than not updating the buffer at all.\rIf you're updating a large number of segments, it may be more efficient\rto call `setAllSegmentsNeedUpdate` and update the whole buffer at once\rrather than make several segment updates in a row.\r\rThe animations in the initial member data are used to compile the shader\rand `frameDataTexture`. If you add new animations after the initial\rcompilation, the shader and texture will be rebuilt, which is expensive.\r\rNotes on textures:\r\rThis layer gains much of its speed from inflexibility. It can only use one\rtexture, and that texture must be a single image.\rIt cannot use multi-atlas textures.\r\rFurther, if the texture is not a power of two in size,\rsome texture seaming may occur if you line up sprites exactly.\rThis is because the GPU precision is limited by binary logic,\rand texture coordinates will only be perfectly accurate for power of two textures.\rThis can be avoided by adding/extruding a pixel of padding around each frame\rin the texture, or by using a power of two texture.\r\rWhich should you use?\r\r- If you are using pixel art mode or round pixels,\r you should aim to use a power of two texture.\r- If you are using smooth mode, you can use a non-power of two texture,\r but you should add padding around each frame to avoid seaming.\r- If you are using a single image, or none of the frames in the texture\r need to tile, it doesn't matter.", "kind": "class", "name": "SpriteGPULayer", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.Alpha", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.ElapseTimer", "Phaser.GameObjects.Components.Lighting", "Phaser.GameObjects.Components.RenderNodes", "Phaser.GameObjects.Components.TextureCrop", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.GameObjects", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this SpriteGPULayer belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture" } }, "description": "The texture that will be used to render the SpriteGPULayer. This must be sourced from a single image; a multi atlas will not work.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The maximum number of quads that this SpriteGPULayer will hold. This can be increased later if necessary.", "name": "size" } ], "scope": "static", "longname": "Phaser.GameObjects.SpriteGPULayer", "___id": "T000002R017056", "___s": true }, { "comment": "/**\r\n * The number of quad members in the SpriteGPULayer.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#memberCount\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 144, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "The number of quad members in the SpriteGPULayer.", "name": "memberCount", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#memberCount", "scope": "instance", "kind": "member", "___id": "T000002R017061", "___s": true }, { "comment": "/**\r\n * The maximum number of quad members that can be in the SpriteGPULayer.\r\n * This value is read-only. Change buffer size with `resize`.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#size\r\n * @type {number}\r\n * @since 4.0.0\r\n * @readonly\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 153, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "The maximum number of quad members that can be in the SpriteGPULayer.\rThis value is read-only. Change buffer size with `resize`.", "name": "size", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "readonly": true, "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#size", "scope": "instance", "kind": "member", "___id": "T000002R017063", "___s": true }, { "comment": "/**\r\n * The state of `bufferUpdateSegments` when it's full.\r\n * This is a constant value and should not be altered.\r\n * If you do, all hell will break loose.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#MAX_BUFFER_UPDATE_SEGMENTS_FULL\r\n * @type {number}\r\n * @since 4.0.0\r\n * @readonly\r\n * @default 0xffffff\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "The state of `bufferUpdateSegments` when it's full.\rThis is a constant value and should not be altered.\rIf you do, all hell will break loose.", "name": "MAX_BUFFER_UPDATE_SEGMENTS_FULL", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "readonly": true, "defaultvalue": "0xffffff", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#MAX_BUFFER_UPDATE_SEGMENTS_FULL", "scope": "instance", "kind": "member", "___id": "T000002R017067", "___s": true }, { "comment": "/**\r\n * Which segments of the buffer require updates.\r\n * This is a bitfield with segments equal to `_segments`.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#bufferUpdateSegments\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 200, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Which segments of the buffer require updates.\rThis is a bitfield with segments equal to `_segments`.", "name": "bufferUpdateSegments", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#bufferUpdateSegments", "scope": "instance", "kind": "member", "___id": "T000002R017069", "___s": true }, { "comment": "/**\r\n * The size of each segment of the buffer that requires updates.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#bufferUpdateSegmentSize\r\n * @type {number}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 210, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "The size of each segment of the buffer that requires updates.", "name": "bufferUpdateSegmentSize", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#bufferUpdateSegmentSize", "scope": "instance", "kind": "member", "___id": "T000002R017071", "___s": true }, { "comment": "/**\r\n * The gravity used by member animations in 'Gravity' mode.\r\n * This is the acceleration in pixels per second squared.\r\n * The default is 1024 pixels per second squared.\r\n *\r\n * Any animation can be set to `ease: 'Gravity'` to use this value.\r\n * Instead of `amplitude`, the animation takes\r\n * `velocity` (a number of pixels) and\r\n * `gravityFactor` (-1 to 1) parameters.\r\n * Note that a `gravityFactor` of 0 is assumed to be a mistake,\r\n * and will be converted to 1.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#gravity\r\n * @type {number}\r\n * @since 4.0.0\r\n * @default 1024\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 219, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "The gravity used by member animations in 'Gravity' mode.\rThis is the acceleration in pixels per second squared.\rThe default is 1024 pixels per second squared.\r\rAny animation can be set to `ease: 'Gravity'` to use this value.\rInstead of `amplitude`, the animation takes\r`velocity` (a number of pixels) and\r`gravityFactor` (-1 to 1) parameters.\rNote that a `gravityFactor` of 0 is assumed to be a mistake,\rand will be converted to 1.", "name": "gravity", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.0.0", "defaultvalue": "1024", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#gravity", "scope": "instance", "kind": "member", "___id": "T000002R017073", "___s": true }, { "comment": "/**\r\n * Strings for valid easing functions that can be assigned to\r\n * the `ease` property of an SpriteGPULayerMemberAnimation.\r\n * This is the reverse mapping of `this.EASE_CODES`.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#EASE\r\n * @type {object}\r\n * @since 4.0.0\r\n * @readonly\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 257, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Strings for valid easing functions that can be assigned to\rthe `ease` property of an SpriteGPULayerMemberAnimation.\rThis is the reverse mapping of `this.EASE_CODES`.", "name": "EASE", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "readonly": true, "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#EASE", "scope": "instance", "kind": "member", "___id": "T000002R017081", "___s": true }, { "comment": "/**\r\n * Codes for valid easing functions that can be assigned to\r\n * the `ease` property of an SpriteGPULayerMemberAnimation.\r\n * This is the reverse mapping of `this.EASE`.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#EASE_CODES\r\n * @type {object}\r\n * @since 4.0.0\r\n * @readonly\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 269, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Codes for valid easing functions that can be assigned to\rthe `ease` property of an SpriteGPULayerMemberAnimation.\rThis is the reverse mapping of `this.EASE`.", "name": "EASE_CODES", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "readonly": true, "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#EASE_CODES", "scope": "instance", "kind": "member", "___id": "T000002R017083", "___s": true }, { "comment": "/**\r\n * A texture containing the frame data for the SpriteGPULayer.\r\n * This is used by the vertex shader.\r\n *\r\n * The texture is composed of pixel strides, where each stride\r\n * is interpreted as 6 16-bit unsigned integers,\r\n * representing the x, y, width, height, and origin x and y of a frame.\r\n * The texture will be up to 4096 pixels wide and as tall as necessary.\r\n *\r\n * There are two sets of data in the texture: frames and animations.\r\n * Frames are taken from the `texture`.\r\n * Animations are defined by calling `setAnimations`,\r\n * and consist of runs of frames suited to shader animation.\r\n * Although the texture will be regenerated by `setAnimations`,\r\n * the frames are stored first, so their indices won't change.\r\n *\r\n * If you change the `texture` of this layer, you will need to\r\n * regenerate this by calling `generateFrameDataTexture`.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#frameDataTexture\r\n * @type {Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 284, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "A texture containing the frame data for the SpriteGPULayer.\rThis is used by the vertex shader.\r\rThe texture is composed of pixel strides, where each stride\ris interpreted as 6 16-bit unsigned integers,\rrepresenting the x, y, width, height, and origin x and y of a frame.\rThe texture will be up to 4096 pixels wide and as tall as necessary.\r\rThere are two sets of data in the texture: frames and animations.\rFrames are taken from the `texture`.\rAnimations are defined by calling `setAnimations`,\rand consist of runs of frames suited to shader animation.\rAlthough the texture will be regenerated by `setAnimations`,\rthe frames are stored first, so their indices won't change.\r\rIf you change the `texture` of this layer, you will need to\rregenerate this by calling `generateFrameDataTexture`.", "name": "frameDataTexture", "type": { "names": [ "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#frameDataTexture", "scope": "instance", "kind": "member", "___id": "T000002R017085", "___s": true }, { "comment": "/**\r\n * A map of frame names to indices in the frame data texture.\r\n * This is used to convert frame names to indices for the vertex shader.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#frameDataIndices\r\n * @type {object}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 309, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "A map of frame names to indices in the frame data texture.\rThis is used to convert frame names to indices for the vertex shader.", "name": "frameDataIndices", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#frameDataIndices", "scope": "instance", "kind": "member", "___id": "T000002R017087", "___s": true }, { "comment": "/**\r\n * A map of indices to frame names in the frame data texture.\r\n * This is used to convert frame indices back to names for debugging.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#frameDataIndicesInv\r\n * @type {object}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 319, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "A map of indices to frame names in the frame data texture.\rThis is used to convert frame indices back to names for debugging.", "name": "frameDataIndicesInv", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#frameDataIndicesInv", "scope": "instance", "kind": "member", "___id": "T000002R017089", "___s": true }, { "comment": "/**\r\n * An ordered list of animations in the frame data texture.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#animationData\r\n * @type {object[]}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 329, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "An ordered list of animations in the frame data texture.", "name": "animationData", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#animationData", "scope": "instance", "kind": "member", "___id": "T000002R017091", "___s": true }, { "comment": "/**\r\n * A map of animation names to animation parameters in\r\n * the frame data texture.\r\n * This is used to convert animation names to indices and durations\r\n * for the vertex shader.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#animationDataNames\r\n * @type {object}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 338, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "A map of animation names to animation parameters in\rthe frame data texture.\rThis is used to convert animation names to indices and durations\rfor the vertex shader.", "name": "animationDataNames", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#animationDataNames", "scope": "instance", "kind": "member", "___id": "T000002R017093", "___s": true }, { "comment": "/**\r\n * A map of frame indices to animation parameters in\r\n * the frame data texture.\r\n * These are the starting frame indices used by the vertex shader.\r\n * They can be used to map back to names in `animationDataIndices`.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#animationDataIndices\r\n * @type {object}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 350, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "A map of frame indices to animation parameters in\rthe frame data texture.\rThese are the starting frame indices used by the vertex shader.\rThey can be used to map back to names in `animationDataIndices`.", "name": "animationDataIndices", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#animationDataIndices", "scope": "instance", "kind": "member", "___id": "T000002R017095", "___s": true }, { "comment": "/**\r\n * The SubmitterSpriteGPULayer RenderNode for this SpriteGPULayer.\r\n *\r\n * This handles rendering the SpriteGPULayer to the GPU.\r\n * It is created automatically when the SpriteGPULayer is initialized.\r\n * Most RenderNodes are singletons stored in the RenderNodeManager,\r\n * but because this one holds very specific data,\r\n * it is stored in the SpriteGPULayer itself.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#submitterNode\r\n * @type {Phaser.Renderer.WebGL.RenderNodes.SubmitterSpriteGPULayer}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 364, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "The SubmitterSpriteGPULayer RenderNode for this SpriteGPULayer.\r\rThis handles rendering the SpriteGPULayer to the GPU.\rIt is created automatically when the SpriteGPULayer is initialized.\rMost RenderNodes are singletons stored in the RenderNodeManager,\rbut because this one holds very specific data,\rit is stored in the SpriteGPULayer itself.", "name": "submitterNode", "type": { "names": [ "Phaser.Renderer.WebGL.RenderNodes.SubmitterSpriteGPULayer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.RenderNodes.SubmitterSpriteGPULayer" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#submitterNode", "scope": "instance", "kind": "member", "___id": "T000002R017097", "___s": true }, { "comment": "/**\r\n * The next member buffer, used to store member data\r\n * before it is added to the GPU buffer.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#nextMember\r\n * @type {ArrayBuffer}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 384, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "The next member buffer, used to store member data\rbefore it is added to the GPU buffer.", "name": "nextMember", "type": { "names": [ "ArrayBuffer" ], "parsedType": { "type": "NameExpression", "name": "ArrayBuffer" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#nextMember", "scope": "instance", "kind": "member", "___id": "T000002R017101", "___s": true }, { "comment": "/**\r\n * A Float32Array view of the next member buffer.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#nextMemberF32\r\n * @type {Float32Array}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 394, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "A Float32Array view of the next member buffer.", "name": "nextMemberF32", "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#nextMemberF32", "scope": "instance", "kind": "member", "___id": "T000002R017103", "___s": true }, { "comment": "/**\r\n * A Uint32Array view of the next member buffer.\r\n * This is used to write 32-bit integer data to the buffer.\r\n * It is used for color data.\r\n *\r\n * @name Phaser.GameObjects.SpriteGPULayer#nextMemberU32\r\n * @type {Uint32Array}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 403, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "A Uint32Array view of the next member buffer.\rThis is used to write 32-bit integer data to the buffer.\rIt is used for color data.", "name": "nextMemberU32", "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#nextMemberU32", "scope": "instance", "kind": "member", "___id": "T000002R017105", "___s": true }, { "comment": "/**\r\n * Called when this SpriteGPULayer is added to a Scene.\r\n * Registers it with the Scene's update list so it receives `preUpdate` calls each frame.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#addedToScene\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 415, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Called when this SpriteGPULayer is added to a Scene.\rRegisters it with the Scene's update list so it receives `preUpdate` calls each frame.", "kind": "function", "name": "addedToScene", "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#addedToScene", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#addedToScene", "___id": "T000002R017107", "___s": true }, { "comment": "/**\r\n * Called when this SpriteGPULayer is removed from a Scene.\r\n * Deregisters it from the Scene's update list so it no longer receives `preUpdate` calls.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#removedFromScene\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 427, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Called when this SpriteGPULayer is removed from a Scene.\rDeregisters it from the Scene's update list so it no longer receives `preUpdate` calls.", "kind": "function", "name": "removedFromScene", "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#removedFromScene", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#removedFromScene", "___id": "T000002R017109", "___s": true }, { "comment": "/**\r\n * The update step for this SpriteGPULayer, called each frame by the Scene.\r\n * Advances the internal elapsed timer used for member animations.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#preUpdate\r\n * @since 4.0.0\r\n * @param {number} time - The current timestamp, as generated by the Request Animation Frame or SetTimeout.\r\n * @param {number} delta - The delta time, in milliseconds, elapsed since the last frame.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 439, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "The update step for this SpriteGPULayer, called each frame by the Scene.\rAdvances the internal elapsed timer used for member animations.", "kind": "function", "name": "preUpdate", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp, as generated by the Request Animation Frame or SetTimeout.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time, in milliseconds, elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#preUpdate", "scope": "instance", "___id": "T000002R017111", "___s": true }, { "comment": "/**\r\n * Get the number of bytes used to define a member.\r\n * If you are directly editing the buffer, you will need this value\r\n * as a 'stride' to move through the buffer.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#getDataByteSize\r\n * @since 4.0.0\r\n * @return {number} The number of bytes used for each member.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 453, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Get the number of bytes used to define a member.\rIf you are directly editing the buffer, you will need this value\ras a 'stride' to move through the buffer.", "kind": "function", "name": "getDataByteSize", "since": "4.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of bytes used for each member." } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#getDataByteSize", "scope": "instance", "___id": "T000002R017113", "___s": true }, { "comment": "/**\r\n * Return a list of features to enable in the shader program.\r\n * This is used when the shader program is compiled.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#getShaderFeatures\r\n * @since 4.0.0\r\n * @return {string[]} An array of features to enable in the shader program.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Return a list of features to enable in the shader program.\rThis is used when the shader program is compiled.", "kind": "function", "name": "getShaderFeatures", "since": "4.0.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "An array of features to enable in the shader program." } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#getShaderFeatures", "scope": "instance", "___id": "T000002R017115", "___s": true }, { "comment": "/**\r\n * Set the animations available to the SpriteGPULayer.\r\n * This will call `generateFrameDataTexture` to regenerate\r\n * `frameDataTexture`.\r\n *\r\n * Each animation can be either an Animation object, or an object\r\n * containing a name, duration, and an array of frame names/numbers.\r\n * If an Animation is used, it will be converted to the object form,\r\n * discarding any custom individual frame durations\r\n * and using the animation's duration as default.\r\n *\r\n * This is not a Phaser Animation. It is intended to cycle automatically\r\n * on the GPU without supervision or interaction. It will not emit events,\r\n * allow you to pause the animation, set number of repeats, etc.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#setAnimations\r\n * @since 4.0.0\r\n * @param {Phaser.Animations.Animation[]|Phaser.Types.GameObjects.SpriteGPULayer.SetAnimation[]} animations - An array of animations to set.\r\n * @return {this} This SpriteGPULayer object.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 493, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Set the animations available to the SpriteGPULayer.\rThis will call `generateFrameDataTexture` to regenerate\r`frameDataTexture`.\r\rEach animation can be either an Animation object, or an object\rcontaining a name, duration, and an array of frame names/numbers.\rIf an Animation is used, it will be converted to the object form,\rdiscarding any custom individual frame durations\rand using the animation's duration as default.\r\rThis is not a Phaser Animation. It is intended to cycle automatically\ron the GPU without supervision or interaction. It will not emit events,\rallow you to pause the animation, set number of repeats, etc.", "kind": "function", "name": "setAnimations", "since": "4.0.0", "params": [ { "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Animations.Animation", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.GameObjects.SpriteGPULayer.SetAnimation", "type": "NameExpression" } ] } ] } }, "description": "An array of animations to set.", "name": "animations" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This SpriteGPULayer object." } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#setAnimations", "scope": "instance", "___id": "T000002R017121", "___s": true }, { "comment": "/**\r\n * Generate `frameDataTexture` for the SpriteGPULayer.\r\n * This is used by the vertex shader to access frame data.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#generateFrameDataTexture\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 555, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Generate `frameDataTexture` for the SpriteGPULayer.\rThis is used by the vertex shader to access frame data.", "kind": "function", "name": "generateFrameDataTexture", "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#generateFrameDataTexture", "scope": "instance", "___id": "T000002R017140", "___s": true }, { "comment": "/**\r\n * Resizes the SpriteGPULayer buffer to a new size.\r\n * Optionally, clears the buffer.\r\n *\r\n * This is an expensive operation, as it requires the whole buffer to be updated.\r\n * It can take many frames to complete.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#resize\r\n * @since 4.0.0\r\n * @param {number} count - The new number of members in the SpriteGPULayer.\r\n * @param {boolean} [clear=false] - Whether to clear the buffer.\r\n * @return {this} This SpriteGPULayer object.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 657, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Resizes the SpriteGPULayer buffer to a new size.\rOptionally, clears the buffer.\r\rThis is an expensive operation, as it requires the whole buffer to be updated.\rIt can take many frames to complete.", "kind": "function", "name": "resize", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The new number of members in the SpriteGPULayer.", "name": "count" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to clear the buffer.", "name": "clear" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This SpriteGPULayer object." } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#resize", "scope": "instance", "___id": "T000002R017186", "___s": true }, { "comment": "/**\r\n * Sets a segment of the buffer to require an update.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#setSegmentNeedsUpdate\r\n * @since 4.0.0\r\n * @param {number} index - The index at which an update occurred, which requires the segment to be updated.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 699, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Sets a segment of the buffer to require an update.", "kind": "function", "name": "setSegmentNeedsUpdate", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index at which an update occurred, which requires the segment to be updated.", "name": "index" } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#setSegmentNeedsUpdate", "scope": "instance", "___id": "T000002R017197", "___s": true }, { "comment": "/**\r\n * Sets all segments of the buffer to require an update.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#setAllSegmentsNeedUpdate\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 720, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Sets all segments of the buffer to require an update.", "kind": "function", "name": "setAllSegmentsNeedUpdate", "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#setAllSegmentsNeedUpdate", "scope": "instance", "___id": "T000002R017201", "___s": true }, { "comment": "/**\r\n * Clears all segments of the buffer that require an update.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#clearAllSegmentsNeedUpdate\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 731, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Clears all segments of the buffer that require an update.", "kind": "function", "name": "clearAllSegmentsNeedUpdate", "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#clearAllSegmentsNeedUpdate", "scope": "instance", "___id": "T000002R017204", "___s": true }, { "comment": "/**\r\n * Adds data to the SpriteGPULayer buffer.\r\n * It is inserted at the end of the buffer.\r\n *\r\n * This is mostly used internally by the SpriteGPULayer.\r\n * It takes raw data as a buffer, which is very efficient,\r\n * but `addMember` is easier to use.\r\n *\r\n * Note that, if you add a member with an animation,\r\n * the animation must either already be enabled,\r\n * or you must enable it with `setAnimationEnabled`,\r\n * e.g. `layer.setAnimationEnabled('Linear', true)` or\r\n * `layer.setAnimationEnabled(layer.EASE_CODES[layer.EASE.Linear], true)`.\r\n *\r\n * This is a buffer modification, and is expensive.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#addData\r\n * @since 4.0.0\r\n * @param {Float32Array} member - The raw data to add to the buffer.\r\n * @return {this} This SpriteGPULayer object.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 742, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Adds data to the SpriteGPULayer buffer.\rIt is inserted at the end of the buffer.\r\rThis is mostly used internally by the SpriteGPULayer.\rIt takes raw data as a buffer, which is very efficient,\rbut `addMember` is easier to use.\r\rNote that, if you add a member with an animation,\rthe animation must either already be enabled,\ror you must enable it with `setAnimationEnabled`,\re.g. `layer.setAnimationEnabled('Linear', true)` or\r`layer.setAnimationEnabled(layer.EASE_CODES[layer.EASE.Linear], true)`.\r\rThis is a buffer modification, and is expensive.", "kind": "function", "name": "addData", "since": "4.0.0", "params": [ { "type": { "names": [ "Float32Array" ], "parsedType": { "type": "NameExpression", "name": "Float32Array" } }, "description": "The raw data to add to the buffer.", "name": "member" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This SpriteGPULayer object." } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#addData", "scope": "instance", "___id": "T000002R017207", "___s": true }, { "comment": "/**\r\n * Adds a member to the SpriteGPULayer.\r\n * This is the easiest way to add a member to the SpriteGPULayer.\r\n *\r\n * This is a buffer modification, and is expensive.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#addMember\r\n * @since 4.0.0\r\n * @param {Partial} [member] - The member to add to the SpriteGPULayer.\r\n * @return {this} This SpriteGPULayer object.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 782, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Adds a member to the SpriteGPULayer.\rThis is the easiest way to add a member to the SpriteGPULayer.\r\rThis is a buffer modification, and is expensive.", "kind": "function", "name": "addMember", "since": "4.0.0", "params": [ { "type": { "names": [ "Partial." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Partial" }, "applications": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.SpriteGPULayer.Member" } ] } }, "optional": true, "description": "The member to add to the SpriteGPULayer.", "name": "member" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This SpriteGPULayer object." } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#addMember", "scope": "instance", "___id": "T000002R017212", "___s": true }, { "comment": "/**\r\n * Edits a member of the SpriteGPULayer.\r\n * This will update the member's data in the GPU buffer.\r\n * Only the buffer segment containing the target member will be marked for update,\r\n * making this less expensive than a full buffer update.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#editMember\r\n * @since 4.0.0\r\n * @param {number} index - The index of the member to edit.\r\n * @param {Partial} member - The new member data.\r\n * @return {this} This SpriteGPULayer object.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 963, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Edits a member of the SpriteGPULayer.\rThis will update the member's data in the GPU buffer.\rOnly the buffer segment containing the target member will be marked for update,\rmaking this less expensive than a full buffer update.", "kind": "function", "name": "editMember", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the member to edit.", "name": "index" }, { "type": { "names": [ "Partial." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Partial" }, "applications": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.SpriteGPULayer.Member" } ] } }, "description": "The new member data.", "name": "member" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This SpriteGPULayer object." } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#editMember", "scope": "instance", "___id": "T000002R017274", "___s": true }, { "comment": "/**\r\n * Update a member of the SpriteGPULayer with raw data.\r\n * This will update the member's data in the GPU buffer.\r\n * Only the buffer segment containing the target member will be marked for update,\r\n * making this less expensive than a full buffer update.\r\n *\r\n * You can supply a mask to control which properties are updated.\r\n * This can be useful for updating only a subset of properties.\r\n * Try using `getMemberData` to copy an existing member's data,\r\n * then modify the data you want to change.\r\n *\r\n * The data must be passed in as an Uint32Array.\r\n * This will preserve data that other TypedArrays would not.\r\n * As it uses an underlying ArrayBuffer, you can work on the data\r\n * with any TypedArray view before submitting it.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#patchMember\r\n * @since 4.0.0\r\n * @param {number} index - The index of the member to patch.\r\n * @param {Uint32Array} member - The new member data.\r\n * @param {number[]} [mask] - The mask to apply to the member data. A value of 1 will update the member data, a value of 0 will keep the existing member data.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 990, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Update a member of the SpriteGPULayer with raw data.\rThis will update the member's data in the GPU buffer.\rOnly the buffer segment containing the target member will be marked for update,\rmaking this less expensive than a full buffer update.\r\rYou can supply a mask to control which properties are updated.\rThis can be useful for updating only a subset of properties.\rTry using `getMemberData` to copy an existing member's data,\rthen modify the data you want to change.\r\rThe data must be passed in as an Uint32Array.\rThis will preserve data that other TypedArrays would not.\rAs it uses an underlying ArrayBuffer, you can work on the data\rwith any TypedArray view before submitting it.", "kind": "function", "name": "patchMember", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the member to patch.", "name": "index" }, { "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "description": "The new member data.", "name": "member" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "The mask to apply to the member data. A value of 1 will update the member data, a value of 0 will keep the existing member data.", "name": "mask" } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#patchMember", "scope": "instance", "___id": "T000002R017279", "___s": true }, { "comment": "/**\r\n * Returns a member of the SpriteGPULayer.\r\n *\r\n * This returns an object copied from the buffer.\r\n * Editing it will not change anything in the SpriteGPULayer.\r\n * The object will be functionally identical to the data used to\r\n * create the buffer, but some values may be different.\r\n *\r\n * - Properties that support animation, but have no amplitude or duration or have easing 'None' (0), will be presented as numbers.\r\n * - Animation easing values will be presented as numbers (the values\r\n * in `this.EASE`).\r\n * - Animation delay values will be normalized to the duration,\r\n * e.g. a delay of 150 with a duration of 100 will return 50.\r\n * - Some rounding may occur due to floating point precision.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#getMember\r\n * @since 4.0.0\r\n * @param {number} index - The index of the member to get.\r\n * @return {?Phaser.Types.GameObjects.SpriteGPULayer.Member} The member data, or null if the index is out of bounds.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 1045, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Returns a member of the SpriteGPULayer.\r\rThis returns an object copied from the buffer.\rEditing it will not change anything in the SpriteGPULayer.\rThe object will be functionally identical to the data used to\rcreate the buffer, but some values may be different.\r\r- Properties that support animation, but have no amplitude or duration or have easing 'None' (0), will be presented as numbers.\r- Animation easing values will be presented as numbers (the values\r in `this.EASE`).\r- Animation delay values will be normalized to the duration,\r e.g. a delay of 150 with a duration of 100 will return 50.\r- Some rounding may occur due to floating point precision.", "kind": "function", "name": "getMember", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the member to get.", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.SpriteGPULayer.Member" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.SpriteGPULayer.Member", "nullable": true } }, "nullable": true, "description": "The member data, or null if the index is out of bounds." } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#getMember", "scope": "instance", "___id": "T000002R017289", "___s": true }, { "comment": "/**\r\n * Returns the raw data of a member of the SpriteGPULayer.\r\n * This can be useful as the base of efficient editing operations,\r\n * including calls to `addData` and `patchMember`,\r\n * so no data has to be converted.\r\n *\r\n * This returns an Uint32Array copied from the buffer.\r\n * Editing it will not change anything in the SpriteGPULayer.\r\n * The array will be functionally identical to the data used to\r\n * create the buffer.\r\n *\r\n * By default, the data is copied into `this.nextMember`.\r\n * You can use the views `this.nextMemberF32` and `this.nextMemberU32`\r\n * to access the data in different formats.\r\n * If you provide an `out` parameter, the data will be copied to that array,\r\n * and you must construct your own views.\r\n *\r\n * The primary data view is a 42-element array of 32-bit floats.\r\n * Some values are grouped to form animations, of the form:\r\n *\r\n * - 0: base value\r\n * - 1: amplitude\r\n * - 2: duration (if negative, the animation will yoyo)\r\n * - 3: delay (the integer part is the easing, the decimal part is the delay divided by 2 * duration; if negative, the animation will not loop)\r\n *\r\n * The overall structure is thus:\r\n *\r\n * - 0-3: x (animation)\r\n * - 4-7: y (animation)\r\n * - 8-11: rotation (animation)\r\n * - 12-15: scaleX (animation)\r\n * - 16-19: scaleY (animation)\r\n * - 20-23: alpha (animation)\r\n * - 24-27: frame index (animation)\r\n * - 28-31: tintBlend (animation)\r\n * - 32-35: no data\r\n * - 36: originX\r\n * - 37: originY\r\n * - 38: tintMode\r\n * - 39: creationTime\r\n * - 40: scrollFactorX\r\n * - 41: scrollFactorY\r\n *\r\n * Elements 32-35 are only visible in the Uint32Array view.\r\n * They store 32-bit RGBA values for the four corners of the tint:\r\n *\r\n * - 32: bottom-left\r\n * - 33: top-left\r\n * - 34: bottom-right\r\n * - 35: top-right\r\n *\r\n * If the ease for an animation is 'Gravity', the amplitude is replaced\r\n * with a two-part value: the integer part is the `velocity`,\r\n * and the fractional part is the remapped `gravityFactor`.\r\n * To get the true `gravityFactor`, use `gravityFactor * 2 - 1` to map from [0,1] to [-1,1].\r\n * An output `gravityFactor` of 0 actually means 1.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#getMemberData\r\n * @since 4.0.0\r\n * @param {number} index - The index of the member to get.\r\n * @param {Uint32Array} [out] - An optional array to copy the data to. If not provided, `this.nextMember` will be populated, and `nextMemberU32` will be returned.\r\n * @return {?Uint32Array} The member data, or null if the index is out of bounds.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 1153, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Returns the raw data of a member of the SpriteGPULayer.\rThis can be useful as the base of efficient editing operations,\rincluding calls to `addData` and `patchMember`,\rso no data has to be converted.\r\rThis returns an Uint32Array copied from the buffer.\rEditing it will not change anything in the SpriteGPULayer.\rThe array will be functionally identical to the data used to\rcreate the buffer.\r\rBy default, the data is copied into `this.nextMember`.\rYou can use the views `this.nextMemberF32` and `this.nextMemberU32`\rto access the data in different formats.\rIf you provide an `out` parameter, the data will be copied to that array,\rand you must construct your own views.\r\rThe primary data view is a 42-element array of 32-bit floats.\rSome values are grouped to form animations, of the form:\r\r- 0: base value\r- 1: amplitude\r- 2: duration (if negative, the animation will yoyo)\r- 3: delay (the integer part is the easing, the decimal part is the delay divided by 2 * duration; if negative, the animation will not loop)\r\rThe overall structure is thus:\r\r- 0-3: x (animation)\r- 4-7: y (animation)\r- 8-11: rotation (animation)\r- 12-15: scaleX (animation)\r- 16-19: scaleY (animation)\r- 20-23: alpha (animation)\r- 24-27: frame index (animation)\r- 28-31: tintBlend (animation)\r- 32-35: no data\r- 36: originX\r- 37: originY\r- 38: tintMode\r- 39: creationTime\r- 40: scrollFactorX\r- 41: scrollFactorY\r\rElements 32-35 are only visible in the Uint32Array view.\rThey store 32-bit RGBA values for the four corners of the tint:\r\r- 32: bottom-left\r- 33: top-left\r- 34: bottom-right\r- 35: top-right\r\rIf the ease for an animation is 'Gravity', the amplitude is replaced\rwith a two-part value: the integer part is the `velocity`,\rand the fractional part is the remapped `gravityFactor`.\rTo get the true `gravityFactor`, use `gravityFactor * 2 - 1` to map from [0,1] to [-1,1].\rAn output `gravityFactor` of 0 actually means 1.", "kind": "function", "name": "getMemberData", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the member to get.", "name": "index" }, { "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "optional": true, "description": "An optional array to copy the data to. If not provided, `this.nextMember` will be populated, and `nextMemberU32` will be returned.", "name": "out" } ], "returns": [ { "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array", "nullable": true } }, "nullable": true, "description": "The member data, or null if the index is out of bounds." } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#getMemberData", "scope": "instance", "___id": "T000002R017338", "___s": true }, { "comment": "/**\r\n * Removes a member or a number of members from the SpriteGPULayer.\r\n * This will update the GPU buffer.\r\n * This is an expensive operation, as it requires the whole buffer to be updated.\r\n *\r\n * The buffer is not resized.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#removeMembers\r\n * @since 4.0.0\r\n * @param {number} index - The index of the member to remove.\r\n * @param {number} [count=1] - The number of members to remove, default 1.\r\n * @return {this} This SpriteGPULayer object.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 1241, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Removes a member or a number of members from the SpriteGPULayer.\rThis will update the GPU buffer.\rThis is an expensive operation, as it requires the whole buffer to be updated.\r\rThe buffer is not resized.", "kind": "function", "name": "removeMembers", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the member to remove.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The number of members to remove, default 1.", "name": "count" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This SpriteGPULayer object." } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#removeMembers", "scope": "instance", "___id": "T000002R017347", "___s": true }, { "comment": "/**\r\n * Inserts members into the SpriteGPULayer.\r\n * This will update the GPU buffer.\r\n * This is an expensive operation, as it requires the whole buffer to be\r\n * updated after the insertion point.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#insertMembers\r\n * @since 4.0.0\r\n * @param {number} index - The index at which to insert members.\r\n * @param {Phaser.Types.GameObjects.SpriteGPULayer.Member|Phaser.Types.GameObjects.SpriteGPULayer.Member[]} members - The members to insert.\r\n * @return {this} This SpriteGPULayer object.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 1288, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Inserts members into the SpriteGPULayer.\rThis will update the GPU buffer.\rThis is an expensive operation, as it requires the whole buffer to be\rupdated after the insertion point.", "kind": "function", "name": "insertMembers", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index at which to insert members.", "name": "index" }, { "type": { "names": [ "Phaser.Types.GameObjects.SpriteGPULayer.Member", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.GameObjects.SpriteGPULayer.Member" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.GameObjects.SpriteGPULayer.Member", "type": "NameExpression" } ] } ] } }, "description": "The members to insert.", "name": "members" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This SpriteGPULayer object." } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#insertMembers", "scope": "instance", "___id": "T000002R017359", "___s": true }, { "comment": "/**\r\n * Inserts raw data into the SpriteGPULayer.\r\n * This will update the GPU buffer.\r\n * This is an expensive operation, as it requires the whole buffer to be\r\n * updated after the insertion point.\r\n *\r\n * The data must be passed in as a Uint32Array.\r\n * This will preserve data that other TypedArrays would not.\r\n * As it uses an underlying ArrayBuffer, you can work on the data\r\n * with any TypedArray view before submitting it.\r\n *\r\n * The buffer can contain 1 or more members.\r\n * Ensure that the buffer is the correct size for the number of members.\r\n * See `getMemberData` for the structure of the data.\r\n *\r\n * Note that, if you add a member with an animation,\r\n * the animation must either already be enabled,\r\n * or you must enable it with `setAnimationEnabled`,\r\n * e.g. `layer.setAnimationEnabled('Linear', true)` or\r\n * `layer.setAnimationEnabled(layer.EASE_CODES[layer.EASE.Linear], true)`.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#insertMembersData\r\n * @since 4.0.0\r\n * @param {number} index - The index at which to insert members.\r\n * @param {Uint32Array} data - The members to insert.\r\n * @return {this} This SpriteGPULayer object.\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 1349, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Inserts raw data into the SpriteGPULayer.\rThis will update the GPU buffer.\rThis is an expensive operation, as it requires the whole buffer to be\rupdated after the insertion point.\r\rThe data must be passed in as a Uint32Array.\rThis will preserve data that other TypedArrays would not.\rAs it uses an underlying ArrayBuffer, you can work on the data\rwith any TypedArray view before submitting it.\r\rThe buffer can contain 1 or more members.\rEnsure that the buffer is the correct size for the number of members.\rSee `getMemberData` for the structure of the data.\r\rNote that, if you add a member with an animation,\rthe animation must either already be enabled,\ror you must enable it with `setAnimationEnabled`,\re.g. `layer.setAnimationEnabled('Linear', true)` or\r`layer.setAnimationEnabled(layer.EASE_CODES[layer.EASE.Linear], true)`.", "kind": "function", "name": "insertMembersData", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index at which to insert members.", "name": "index" }, { "type": { "names": [ "Uint32Array" ], "parsedType": { "type": "NameExpression", "name": "Uint32Array" } }, "description": "The members to insert.", "name": "data" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This SpriteGPULayer object." } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#insertMembersData", "scope": "instance", "___id": "T000002R017372", "___s": true }, { "comment": "/**\r\n * Set the enabled state of an animation.\r\n * This will enable or disable the animation in the shader program.\r\n * This method is called automatically when animations are added with\r\n * `addMember`, so you should not need to call it manually.\r\n *\r\n * Every enabled animation has a cost in the shader program.\r\n * In particular, low-end devices may be unable to compile a large number\r\n * of animations, so be careful when enabling many animations.\r\n *\r\n * Note that animations are not disabled automatically,\r\n * even if they are not used by any members.\r\n * There are probably too many members for this to be efficient.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#setAnimationEnabled\r\n * @since 4.0.0\r\n * @param {string} name - The name of the animation to enable or disable.\r\n * @param {boolean} enabled - Whether to enable or disable the animation.\r\n * @return {this} This SpriteGPULayer object\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 1604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Set the enabled state of an animation.\rThis will enable or disable the animation in the shader program.\rThis method is called automatically when animations are added with\r`addMember`, so you should not need to call it manually.\r\rEvery enabled animation has a cost in the shader program.\rIn particular, low-end devices may be unable to compile a large number\rof animations, so be careful when enabling many animations.\r\rNote that animations are not disabled automatically,\reven if they are not used by any members.\rThere are probably too many members for this to be efficient.", "kind": "function", "name": "setAnimationEnabled", "since": "4.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the animation to enable or disable.", "name": "name" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to enable or disable the animation.", "name": "enabled" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This SpriteGPULayer object" } ], "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#setAnimationEnabled", "scope": "instance", "___id": "T000002R017449", "___s": true }, { "comment": "/**\r\n * Internal destroy handler, called as part of the destroy process.\r\n *\r\n * @method Phaser.GameObjects.SpriteGPULayer#preDestroy\r\n * @protected\r\n * @since 4.0.0\r\n */", "meta": { "filename": "SpriteGPULayer.js", "lineno": 1631, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Internal destroy handler, called as part of the destroy process.", "kind": "function", "name": "preDestroy", "access": "protected", "since": "4.0.0", "memberof": "Phaser.GameObjects.SpriteGPULayer", "longname": "Phaser.GameObjects.SpriteGPULayer#preDestroy", "scope": "instance", "___id": "T000002R017452", "___s": true }, { "comment": "/**\r\n * Creates a new SpriteGPULayer Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the SpriteGPULayer Game Object\r\n * has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#spriteGPULayer\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.SpriteGPULayer.SpriteGPULayerConfig} config - The configuration object this Game Object will use to create itself. The `size` property sets the maximum number of sprites the layer can hold, and defaults to 1 if not specified.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.SpriteGPULayer} The Game Object that was created.\r\n */", "meta": { "filename": "SpriteGPULayerCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Creates a new SpriteGPULayer Game Object and returns it.\r\rNote: This method will only be available if the SpriteGPULayer Game Object\rhas been built into Phaser.", "kind": "function", "name": "spriteGPULayer", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.SpriteGPULayer.SpriteGPULayerConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.SpriteGPULayer.SpriteGPULayerConfig" } }, "description": "The configuration object this Game Object will use to create itself. The `size` property sets the maximum number of sprites the layer can hold, and defaults to 1 if not specified.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.SpriteGPULayer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.SpriteGPULayer" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#spriteGPULayer", "scope": "instance", "___id": "T000002R017459", "___s": true }, { "comment": "/**\r\n * Creates a new SpriteGPULayer Game Object and adds it to the Scene.\r\n *\r\n * A SpriteGPULayer is a high-performance batch renderer that draws a collection\r\n * of sprites sharing the same texture in a single GPU draw call. Use it when you\r\n * need to render many instances of the same sprite with minimal draw call overhead,\r\n * such as for particle-like effects, tilemaps, or large crowds of identical objects.\r\n *\r\n * Note: This method will only be available if the SpriteGPULayer Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#spriteGPULayer\r\n * @since 4.0.0\r\n *\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {number} [size] - The maximum number of sprites the SpriteGPULayer can render in a single batch. Default 1.\r\n *\r\n * @return {Phaser.GameObjects.SpriteGPULayer} The Game Object that was created.\r\n */", "meta": { "filename": "SpriteGPULayerFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer", "code": {} }, "description": "Creates a new SpriteGPULayer Game Object and adds it to the Scene.\r\rA SpriteGPULayer is a high-performance batch renderer that draws a collection\rof sprites sharing the same texture in a single GPU draw call. Use it when you\rneed to render many instances of the same sprite with minimal draw call overhead,\rsuch as for particle-like effects, tilemaps, or large crowds of identical objects.\r\rNote: This method will only be available if the SpriteGPULayer Game Object has been built into Phaser.", "kind": "function", "name": "spriteGPULayer", "since": "4.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The maximum number of sprites the SpriteGPULayer can render in a single batch. Default 1.", "name": "size" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.SpriteGPULayer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.SpriteGPULayer" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#spriteGPULayer", "scope": "instance", "___id": "T000002R017470", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.SpriteGPULayer\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer\\typedefs", "code": {} }, "kind": "namespace", "name": "SpriteGPULayer", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.SpriteGPULayer", "scope": "static", "___id": "T000002R017482", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.SpriteGPULayer.Member\r\n * @since 4.0.0\r\n *\r\n * @property {number|Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation} x - The x position of the member.\r\n * @property {number|Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation} y - The y position of the member.\r\n * @property {number|Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation} rotation - The rotation of the member.\r\n * @property {number|Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation} scaleX - The x scale of the member.\r\n * @property {number|Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation} scaleY - The y scale of the member.\r\n * @property {number} originX - The X pivot of the frame. Default 0.5, in the range 0 to 1 across the frame. If the frame has a custom pivot, it will offset this value.\r\n * @property {number} originY - The Y pivot of the frame. Default 0.5, in the range 0 to 1 across the frame. If the frame has a custom pivot, it will offset this value.\r\n * @property {Phaser.TintModes} tintMode - The tint mode of the member. Tint modes which require secondary colors will treat the secondary colors as black.\r\n * @property {number} creationTime - The time the member was created. This is measured from the initialization of `layer.timeElapsed`. Use this to control members added after the layer was created.\r\n * @property {number} scrollFactorX - The horizontal camera scroll factor of the member.\r\n * @property {number} scrollFactorY - The vertical camera scroll factor y of the member.\r\n * @property {string|number|{name: string}} frame - The frame of the member. You can pass a frame name, the index of the frame in its texture, or a `Phaser.Types.Textures.Frame` object. The frame must exist in the texture the member is using.\r\n * @property {string|number} [animation] - The animation to use. If not set, the member will use `frame` as a static texture.\r\n * @property {number|Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation} tintBlend - The tint blend mode of the member. 0 is no tint (equivalent to white), 1 is full tint. Use this to animate tint values, which are otherwise too complex to animate.\r\n * @property {number} tintBottomLeft - The bottom-left tint color of the member, as a 24-bit RGB value.\r\n * @property {number} tintTopLeft - The top-left tint color of the member, as a 24-bit RGB value.\r\n * @property {number} tintBottomRight - The bottom-right tint color of the member, as a 24-bit RGB value.\r\n * @property {number} tintTopRight - The top-right tint color of the member, as a 24-bit RGB value.\r\n * @property {number} alphaBottomLeft - The bottom-left alpha value of the member, in the range 0-1.\r\n * @property {number} alphaTopLeft - The top-left alpha value of the member, in the range 0-1.\r\n * @property {number} alphaBottomRight - The bottom-right alpha value of the member, in the range 0-1.\r\n * @property {number} alphaTopRight - The top-right alpha value of the member, in the range 0-1.\r\n * @property {number|Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation} alpha - The alpha value of the member, in the range 0-1. This multiplies all four corner alpha values, and can be animated.\r\n */", "meta": { "filename": "Member.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer\\typedefs", "code": {} }, "kind": "typedef", "name": "Member", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "number", "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation" } ] } }, "description": "The x position of the member.", "name": "x" }, { "type": { "names": [ "number", "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation" } ] } }, "description": "The y position of the member.", "name": "y" }, { "type": { "names": [ "number", "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation" } ] } }, "description": "The rotation of the member.", "name": "rotation" }, { "type": { "names": [ "number", "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation" } ] } }, "description": "The x scale of the member.", "name": "scaleX" }, { "type": { "names": [ "number", "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation" } ] } }, "description": "The y scale of the member.", "name": "scaleY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X pivot of the frame. Default 0.5, in the range 0 to 1 across the frame. If the frame has a custom pivot, it will offset this value.", "name": "originX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y pivot of the frame. Default 0.5, in the range 0 to 1 across the frame. If the frame has a custom pivot, it will offset this value.", "name": "originY" }, { "type": { "names": [ "Phaser.TintModes" ], "parsedType": { "type": "NameExpression", "name": "Phaser.TintModes" } }, "description": "The tint mode of the member. Tint modes which require secondary colors will treat the secondary colors as black.", "name": "tintMode" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time the member was created. This is measured from the initialization of `layer.timeElapsed`. Use this to control members added after the layer was created.", "name": "creationTime" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal camera scroll factor of the member.", "name": "scrollFactorX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical camera scroll factor y of the member.", "name": "scrollFactorY" }, { "type": { "names": [ "string", "number", "Object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "RecordType", "fields": [ { "type": "FieldType", "key": { "type": "NameExpression", "name": "name" }, "value": { "type": "NameExpression", "name": "string" } } ] } ] } }, "description": "The frame of the member. You can pass a frame name, the index of the frame in its texture, or a `Phaser.Types.Textures.Frame` object. The frame must exist in the texture the member is using.", "name": "frame" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "The animation to use. If not set, the member will use `frame` as a static texture.", "name": "animation" }, { "type": { "names": [ "number", "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation" } ] } }, "description": "The tint blend mode of the member. 0 is no tint (equivalent to white), 1 is full tint. Use this to animate tint values, which are otherwise too complex to animate.", "name": "tintBlend" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left tint color of the member, as a 24-bit RGB value.", "name": "tintBottomLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left tint color of the member, as a 24-bit RGB value.", "name": "tintTopLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right tint color of the member, as a 24-bit RGB value.", "name": "tintBottomRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right tint color of the member, as a 24-bit RGB value.", "name": "tintTopRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-left alpha value of the member, in the range 0-1.", "name": "alphaBottomLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left alpha value of the member, in the range 0-1.", "name": "alphaTopLeft" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The bottom-right alpha value of the member, in the range 0-1.", "name": "alphaBottomRight" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-right alpha value of the member, in the range 0-1.", "name": "alphaTopRight" }, { "type": { "names": [ "number", "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation" } ] } }, "description": "The alpha value of the member, in the range 0-1. This multiplies all four corner alpha values, and can be animated.", "name": "alpha" } ], "memberof": "Phaser.Types.GameObjects.SpriteGPULayer", "longname": "Phaser.Types.GameObjects.SpriteGPULayer.Member", "scope": "static", "___id": "T000002R017483", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation\r\n * @since 4.0.0\r\n *\r\n * @property {number} [base=0] - The base value of the animation.\r\n * @property {number|string} [ease=0] - The ease value of the animation. This must be a key or value of `SpriteGPULayer.EASE`, e.g. 'Linear', 'Quad.easeIn', etc.\r\n * @property {number} [amplitude=0] - The amplitude of the animation.\r\n * @property {number} [duration=0] - The duration of the animation, in milliseconds. Must be non-negative.\r\n * @property {number} [delay=0] - The delay of the animation, in milliseconds.\r\n * @property {boolean} [loop=true] - Whether the animation loops from 0-1 (optionally using yoyo from 0-1-1), or continues beyond 1. Non-looping animations can be useful for one-off particle effects.\r\n * @property {boolean} [yoyo=true] - Whether the animation runs backwards when it completes. If false, it starts over from the beginning.\r\n * @property {number} [gravityFactor=1] - The gravity factor of the animation. This is used instead of `amplitude` if the ease is 'Gravity'.\r\n * @property {number} [velocity=0] - The velocity of the animation. Must be an integer. This is used instead of `amplitude` if the ease is 'Gravity'.\r\n */", "meta": { "filename": "MemberAnimation.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer\\typedefs", "code": {} }, "kind": "typedef", "name": "MemberAnimation", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The base value of the animation.", "name": "base" }, { "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "defaultvalue": 0, "description": "The ease value of the animation. This must be a key or value of `SpriteGPULayer.EASE`, e.g. 'Linear', 'Quad.easeIn', etc.", "name": "ease" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The amplitude of the animation.", "name": "amplitude" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The duration of the animation, in milliseconds. Must be non-negative.", "name": "duration" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The delay of the animation, in milliseconds.", "name": "delay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether the animation loops from 0-1 (optionally using yoyo from 0-1-1), or continues beyond 1. Non-looping animations can be useful for one-off particle effects.", "name": "loop" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether the animation runs backwards when it completes. If false, it starts over from the beginning.", "name": "yoyo" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The gravity factor of the animation. This is used instead of `amplitude` if the ease is 'Gravity'.", "name": "gravityFactor" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The velocity of the animation. Must be an integer. This is used instead of `amplitude` if the ease is 'Gravity'.", "name": "velocity" } ], "memberof": "Phaser.Types.GameObjects.SpriteGPULayer", "longname": "Phaser.Types.GameObjects.SpriteGPULayer.MemberAnimation", "scope": "static", "___id": "T000002R017484", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.SpriteGPULayer.SetAnimation\r\n * @since 4.0.0\r\n *\r\n * @property {string} name - The name of the animation.\r\n * @property {number[]|string[]} frames - An array containing the frames of the animation.\r\n * @property {number} duration - The duration of the animation, in milliseconds. Must be non-negative.\r\n */", "meta": { "filename": "SetAnimation.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer\\typedefs", "code": {} }, "kind": "typedef", "name": "SetAnimation", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the animation.", "name": "name" }, { "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "description": "An array containing the frames of the animation.", "name": "frames" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration of the animation, in milliseconds. Must be non-negative.", "name": "duration" } ], "memberof": "Phaser.Types.GameObjects.SpriteGPULayer", "longname": "Phaser.Types.GameObjects.SpriteGPULayer.SetAnimation", "scope": "static", "___id": "T000002R017485", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.SpriteGPULayer.SpriteGPULayerConfig\r\n * @since 4.0.0\r\n *\r\n * @property {number} size - The size of the SpriteGPULayer; the number of quads reserved in memory. This can be increased later.\r\n * @property {(string|Phaser.Textures.Texture)} [key] - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @property {number} [alpha=1] - The alpha (opacity) of the Game Object.\r\n * @property {number} [blendMode=BlendModes.DEFAULT] - The blend mode of the GameObject.\r\n * @property {boolean} [visible=true] - The visible state of the Game Object.\r\n */", "meta": { "filename": "SpriteGPULayerConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\spritegpulayer\\typedefs", "code": {} }, "kind": "typedef", "name": "SpriteGPULayerConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The size of the SpriteGPULayer; the number of quads reserved in memory. This can be increased later.", "name": "size" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "optional": true, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The alpha (opacity) of the Game Object.", "name": "alpha" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "BlendModes.DEFAULT", "description": "The blend mode of the GameObject.", "name": "blendMode" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "The visible state of the Game Object.", "name": "visible" } ], "memberof": "Phaser.Types.GameObjects.SpriteGPULayer", "longname": "Phaser.Types.GameObjects.SpriteGPULayer.SpriteGPULayerConfig", "scope": "static", "___id": "T000002R017486", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Stamp Game Object.\r\n *\r\n * A Stamp is a lightweight Game Object which ignores camera scroll and transform,\r\n * so it is always rendered at a fixed position on-screen regardless of where the\r\n * camera is looking. This makes it ideal for HUDs, score counters, overlays, and\r\n * other screen-space elements that should not move with the game world.\r\n *\r\n * Its primary role is as an internal helper for DynamicTexture rendering, where it\r\n * is used to draw (stamp) textures onto a DynamicTexture surface without the overhead\r\n * of a full scene Game Object lifecycle. It is otherwise functionally similar to\r\n * an Image Game Object.\r\n *\r\n * @class Stamp\r\n * @extends Phaser.GameObjects.Image\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 4.0.0\r\n *\r\n * @extends Phaser.GameObjects.Components.Alpha\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Flip\r\n * @extends Phaser.GameObjects.Components.GetBounds\r\n * @extends Phaser.GameObjects.Components.Lighting\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Size\r\n * @extends Phaser.GameObjects.Components.TextureCrop\r\n * @extends Phaser.GameObjects.Components.Tint\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n */", "meta": { "filename": "Stamp.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stamp", "code": {} }, "classdesc": "A Stamp Game Object.\r\rA Stamp is a lightweight Game Object which ignores camera scroll and transform,\rso it is always rendered at a fixed position on-screen regardless of where the\rcamera is looking. This makes it ideal for HUDs, score counters, overlays, and\rother screen-space elements that should not move with the game world.\r\rIts primary role is as an internal helper for DynamicTexture rendering, where it\ris used to draw (stamp) textures onto a DynamicTexture surface without the overhead\rof a full scene Game Object lifecycle. It is otherwise functionally similar to\ran Image Game Object.", "kind": "class", "name": "Stamp", "augments": [ "Phaser.GameObjects.Image", "Phaser.GameObjects.Components.Alpha", "Phaser.GameObjects.Components.BlendMode", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.Flip", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Lighting", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.RenderNodes", "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": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "scope": "static", "longname": "Phaser.GameObjects.Stamp", "___id": "T000002R017491", "___s": true }, { "comment": "/**\r\n * Creates a new Stamp Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Stamp Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#stamp\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Sprite.SpriteConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Stamp} The Game Object that was created.\r\n */", "meta": { "filename": "StampCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stamp", "code": {} }, "description": "Creates a new Stamp Game Object and returns it.\r\rNote: This method will only be available if the Stamp Game Object has been built into Phaser.", "kind": "function", "name": "stamp", "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Sprite.SpriteConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Sprite.SpriteConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.Stamp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Stamp" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#stamp", "scope": "instance", "___id": "T000002R017515", "___s": true }, { "comment": "/**\r\n * Creates a new Stamp Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Stamp Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#stamp\r\n * @since 4.0.0\r\n *\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.\r\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.GameObjects.Stamp} The Game Object that was created.\r\n */", "meta": { "filename": "StampFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stamp", "code": {} }, "description": "Creates a new Stamp Game Object and adds it to the Scene.\r\rNote: This method will only be available if the Stamp Game Object has been built into Phaser.", "kind": "function", "name": "stamp", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Stamp" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Stamp" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#stamp", "scope": "instance", "___id": "T000002R017523", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Stencil Game Object.\r\n *\r\n * A Stencil is a special type of Game Object used to place stencils over the canvas.\r\n * You can use it to efficiently control where subsequent objects are rendered.\r\n * It is WebGL-only.\r\n * Study the documentation carefully to understand how it works.\r\n *\r\n * A Stencil is an extended Container Game Object.\r\n * It contains a list of child Game Objects to render to the stencil buffer.\r\n * Think of these as opaque sheets of card held up over the canvas,\r\n * preventing anything from being drawn through them.\r\n *\r\n * The stencil buffer is provided by WebGL.\r\n * It is available if the game render config set `stencil` to `true`.\r\n * It is an 8-bit attachment to framebuffers, like an extra alpha channel.\r\n * But if the stencil channel is not 0 at a pixel, WebGL will skip rendering that pixel.\r\n * There are no degrees of transparency, only on or off.\r\n *\r\n * When you draw objects with alpha to a Stencil,\r\n * a special `alphaStrategy` is used. Compatible shaders switch from rendering\r\n * alpha, to discarding fragments based on their alpha value.\r\n * By default, this uses dithering to preserve alpha gradients.\r\n * You can change `stencilAlphaStrategy` to a threshold value to instead\r\n * discard without dithering.\r\n * If `stencilAlphaStrategy` is `'keep'`,\r\n * or the child's shader does not support alpha strategies,\r\n * transparent pixels will be drawn as opaque to the stencil buffer!\r\n * This is rarely what you want.\r\n * Fragment shaders must `discard` fragments for them to be transparent to the stencil buffer.\r\n *\r\n * By default, most Phaser shaders support alpha strategies.\r\n * Notable exceptions include:\r\n *\r\n * - PointLight (additive lighting)\r\n * - Shader game objects, and extended classes like Noise\r\n *\r\n * To apply an alpha strategy without a compatible shader,\r\n * force stencil composition by setting `stencilCompositeCheck` to `true`.\r\n * This will composite the stencil contents to a framebuffer,\r\n * which is rendered using a compatible shader.\r\n *\r\n * Stencils are drawn as order-independent layers.\r\n * You can add or remove layers in sequence using `addLayer` and `removeLayer`.\r\n * Each layer adds or subtracts 1 from the stencil buffer.\r\n * Only when the stencil is 0 at a pixel will anything be drawn there.\r\n * (This 0-test is a rule set by the renderer's base DrawingContext.)\r\n * Note that overlapping geometry within the same Stencil is additive,\r\n * and can adjust the layer by more than 1 in aggregate.\r\n * The results can be surprising, so try to avoid overlaps.\r\n *\r\n * You can invert the stencil by setting `stencilInvert` to `true`.\r\n * This will use an extra draw call to invert the stencil:\r\n * it adds a layer everywhere that the children would not draw.\r\n * It is more efficient to render a shape that covers the whole area you wish to stencil,\r\n * but if that's not possible, you can use this.\r\n * Inversion makes it possible to render to parts of the screen not touched\r\n * by child geometry.\r\n * It works by filling the camera, then drawing the child stencil in reverse.\r\n *\r\n * You can remove the stencil by using {@link Phaser.GameObjects.StencilReference}.\r\n * This object copies a target Stencil, and re-renders it\r\n * with different stencil options, elsewhere in the display list.\r\n * This is an efficient way to re-use stencil geometry.\r\n *\r\n * You can also clear the stencil by setting `stencilLayerMode` to `clear`.\r\n * It replaces all stencil buffer values with the `stencilClearValue`.\r\n * This should normally set them back to 0 so everything renders again.\r\n * This destroys all layer information.\r\n * It does not use the child list.\r\n * Be careful not to mess up your scene this way.\r\n *\r\n * Set `stencilLayerMode` to `clearRegion` to fill a region\r\n * of the stencil buffer defined by the children, with the `stencilClearValue`.\r\n * This can be used as a selective eraser, or to set a region to a specific value.\r\n *\r\n * You cannot invert the stencil if the `stencilLayerMode` is `clear` or `clearRegion`.\r\n *\r\n * Sequential stencil layers combine and persist,\r\n * because they are drawn to the stencil buffer and stay there until the next frame.\r\n * Do not add too many layers, though. There are only 8 bits in the stencil buffer,\r\n * so it only safely supports 255 layers.\r\n * If you go over this limit, the buffer wraps back to 0.\r\n * You can still add and remove layers in this case,\r\n * and they will continue to be accurately tracked,\r\n * but layer 256 (and subsequent multiples of 256) will be effectively 0 and allow drawing.\r\n * The same applies if you remove layers below 0: it wraps back to 255\r\n * and prevents drawing.\r\n *\r\n * Deactivate `stencilValueWrap` to prevent the stencil buffer from wrapping.\r\n * This is useful when defining stencils with subtraction,\r\n * and you don't want to underflow from 0 to 255.\r\n * For example, you can use one stencil in `clearRegion` to define a value,\r\n * then use another stencil in `subtractLayer` to erase parts of that region.\r\n * But be careful when using stencils for different purposes:\r\n * if you mix stencil data, you will get unexpected results.\r\n *\r\n * Nested stencils are a separate concern.\r\n * If you add a Stencil as the child of another Stencil,\r\n * the parent Stencil will composite its contents to a framebuffer,\r\n * including child stencils.\r\n * This effectively traps the child stencil in the framebuffer,\r\n * and only the final composite from the framebuffer needs to be considered.\r\n * It is used as the source for the stencil, subject to alpha strategy.\r\n * This requires extra draw calls to composite,\r\n * and framebuffers have poor anti-aliasing quality,\r\n * so you should avoid nesting stencils unless you know what you are doing.\r\n *\r\n * To determine whether the stencil needs to composite to a framebuffer,\r\n * it runs a check before rendering (`'auto'` mode).\r\n * If you know the answer already,\r\n * or if you have a custom game object that Phaser doesn't understand,\r\n * you can set `stencilCompositeCheck` to `true` or `false`\r\n * to skip the auto check.\r\n * If you set it to `false`, it will never composite,\r\n * and any child stencils may render in unexpected ways.\r\n * (Generally, they will appear backwards from what you expect:\r\n * child stencils will not affect the parent stencil, but things drawn later.)\r\n *\r\n * Best practice: use few stencils and don't nest them.\r\n *\r\n * Stencil is best used for efficient, sharp-edged, reused masks.\r\n * You can draw a stencil once, and it will affect everything that is drawn later.\r\n * Its rendering cost is minimal: it is just the draw cost of its children.\r\n * This can be as low as 1 call.\r\n * If there are nested stencils, it will take more calls for the framebuffer.\r\n *\r\n * If you need better quality alpha handling, consider using a Mask filter instead.\r\n * Filters have a higher rendering cost, and apply to just 1 object at a time,\r\n * but they have the best quality.\r\n * (And you can apply them to Containers, to cheat the object limitation.)\r\n *\r\n * @class Stencil\r\n * @extends Phaser.GameObjects.Container\r\n * @extends Phaser.GameObjects.Components.StencilModifier\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 4.2.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {Phaser.GameObjects.GameObject[]} [children] - An optional array of Game Objects to add to the Stencil.\r\n * @param {Phaser.Types.GameObjects.Stencil.StencilOptions} [options] - The options for the Stencil.\r\n */", "meta": { "filename": "Stencil.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencil", "code": {} }, "classdesc": "A Stencil Game Object.\r\rA Stencil is a special type of Game Object used to place stencils over the canvas.\rYou can use it to efficiently control where subsequent objects are rendered.\rIt is WebGL-only.\rStudy the documentation carefully to understand how it works.\r\rA Stencil is an extended Container Game Object.\rIt contains a list of child Game Objects to render to the stencil buffer.\rThink of these as opaque sheets of card held up over the canvas,\rpreventing anything from being drawn through them.\r\rThe stencil buffer is provided by WebGL.\rIt is available if the game render config set `stencil` to `true`.\rIt is an 8-bit attachment to framebuffers, like an extra alpha channel.\rBut if the stencil channel is not 0 at a pixel, WebGL will skip rendering that pixel.\rThere are no degrees of transparency, only on or off.\r\rWhen you draw objects with alpha to a Stencil,\ra special `alphaStrategy` is used. Compatible shaders switch from rendering\ralpha, to discarding fragments based on their alpha value.\rBy default, this uses dithering to preserve alpha gradients.\rYou can change `stencilAlphaStrategy` to a threshold value to instead\rdiscard without dithering.\rIf `stencilAlphaStrategy` is `'keep'`,\ror the child's shader does not support alpha strategies,\rtransparent pixels will be drawn as opaque to the stencil buffer!\rThis is rarely what you want.\rFragment shaders must `discard` fragments for them to be transparent to the stencil buffer.\r\rBy default, most Phaser shaders support alpha strategies.\rNotable exceptions include:\r\r- PointLight (additive lighting)\r- Shader game objects, and extended classes like Noise\r\rTo apply an alpha strategy without a compatible shader,\rforce stencil composition by setting `stencilCompositeCheck` to `true`.\rThis will composite the stencil contents to a framebuffer,\rwhich is rendered using a compatible shader.\r\rStencils are drawn as order-independent layers.\rYou can add or remove layers in sequence using `addLayer` and `removeLayer`.\rEach layer adds or subtracts 1 from the stencil buffer.\rOnly when the stencil is 0 at a pixel will anything be drawn there.\r(This 0-test is a rule set by the renderer's base DrawingContext.)\rNote that overlapping geometry within the same Stencil is additive,\rand can adjust the layer by more than 1 in aggregate.\rThe results can be surprising, so try to avoid overlaps.\r\rYou can invert the stencil by setting `stencilInvert` to `true`.\rThis will use an extra draw call to invert the stencil:\rit adds a layer everywhere that the children would not draw.\rIt is more efficient to render a shape that covers the whole area you wish to stencil,\rbut if that's not possible, you can use this.\rInversion makes it possible to render to parts of the screen not touched\rby child geometry.\rIt works by filling the camera, then drawing the child stencil in reverse.\r\rYou can remove the stencil by using {@link Phaser.GameObjects.StencilReference}.\rThis object copies a target Stencil, and re-renders it\rwith different stencil options, elsewhere in the display list.\rThis is an efficient way to re-use stencil geometry.\r\rYou can also clear the stencil by setting `stencilLayerMode` to `clear`.\rIt replaces all stencil buffer values with the `stencilClearValue`.\rThis should normally set them back to 0 so everything renders again.\rThis destroys all layer information.\rIt does not use the child list.\rBe careful not to mess up your scene this way.\r\rSet `stencilLayerMode` to `clearRegion` to fill a region\rof the stencil buffer defined by the children, with the `stencilClearValue`.\rThis can be used as a selective eraser, or to set a region to a specific value.\r\rYou cannot invert the stencil if the `stencilLayerMode` is `clear` or `clearRegion`.\r\rSequential stencil layers combine and persist,\rbecause they are drawn to the stencil buffer and stay there until the next frame.\rDo not add too many layers, though. There are only 8 bits in the stencil buffer,\rso it only safely supports 255 layers.\rIf you go over this limit, the buffer wraps back to 0.\rYou can still add and remove layers in this case,\rand they will continue to be accurately tracked,\rbut layer 256 (and subsequent multiples of 256) will be effectively 0 and allow drawing.\rThe same applies if you remove layers below 0: it wraps back to 255\rand prevents drawing.\r\rDeactivate `stencilValueWrap` to prevent the stencil buffer from wrapping.\rThis is useful when defining stencils with subtraction,\rand you don't want to underflow from 0 to 255.\rFor example, you can use one stencil in `clearRegion` to define a value,\rthen use another stencil in `subtractLayer` to erase parts of that region.\rBut be careful when using stencils for different purposes:\rif you mix stencil data, you will get unexpected results.\r\rNested stencils are a separate concern.\rIf you add a Stencil as the child of another Stencil,\rthe parent Stencil will composite its contents to a framebuffer,\rincluding child stencils.\rThis effectively traps the child stencil in the framebuffer,\rand only the final composite from the framebuffer needs to be considered.\rIt is used as the source for the stencil, subject to alpha strategy.\rThis requires extra draw calls to composite,\rand framebuffers have poor anti-aliasing quality,\rso you should avoid nesting stencils unless you know what you are doing.\r\rTo determine whether the stencil needs to composite to a framebuffer,\rit runs a check before rendering (`'auto'` mode).\rIf you know the answer already,\ror if you have a custom game object that Phaser doesn't understand,\ryou can set `stencilCompositeCheck` to `true` or `false`\rto skip the auto check.\rIf you set it to `false`, it will never composite,\rand any child stencils may render in unexpected ways.\r(Generally, they will appear backwards from what you expect:\rchild stencils will not affect the parent stencil, but things drawn later.)\r\rBest practice: use few stencils and don't nest them.\r\rStencil is best used for efficient, sharp-edged, reused masks.\rYou can draw a stencil once, and it will affect everything that is drawn later.\rIts rendering cost is minimal: it is just the draw cost of its children.\rThis can be as low as 1 call.\rIf there are nested stencils, it will take more calls for the framebuffer.\r\rIf you need better quality alpha handling, consider using a Mask filter instead.\rFilters have a higher rendering cost, and apply to just 1 object at a time,\rbut they have the best quality.\r(And you can apply them to Containers, to cheat the object limitation.)", "kind": "class", "name": "Stencil", "augments": [ "Phaser.GameObjects.Container", "Phaser.GameObjects.Components.StencilModifier" ], "memberof": "Phaser.GameObjects", "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of Game Objects to add to the Stencil.", "name": "children" }, { "type": { "names": [ "Phaser.Types.GameObjects.Stencil.StencilOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Stencil.StencilOptions" } }, "optional": true, "description": "The options for the Stencil.", "name": "options" } ], "scope": "static", "longname": "Phaser.GameObjects.Stencil", "___id": "T000002R017533", "___s": true }, { "comment": "/**\r\n * The stencil render step.\r\n * This is an internal function, which is automatically assigned;\r\n * you should not call it directly.\r\n *\r\n * This runs before other render steps,\r\n * so it can set up the drawing context to render properly.\r\n * It delegates to the appropriate render step function based on the `stencilLayerMode`.\r\n *\r\n * @method Phaser.GameObjects.Stencil#stencilRenderStep\r\n * @webglOnly\r\n * @since 4.2.0\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - A reference to the current active WebGL renderer.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered in this call.\r\n * @param {Phaser.Renderer.WebGL.DrawingContext} drawingContext - The current drawing context.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentMatrix] - This transform matrix is defined if the game object is nested\r\n * @param {number} [renderStep=0] - The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions.\r\n * @param {Phaser.GameObjects.GameObject[]} [displayList] - The display list which is currently being rendered.\r\n * @param {number} [displayListIndex] - The index of the Game Object within the display list.\r\n */", "meta": { "filename": "Stencil.js", "lineno": 208, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencil", "code": {} }, "description": "The stencil render step.\rThis is an internal function, which is automatically assigned;\ryou should not call it directly.\r\rThis runs before other render steps,\rso it can set up the drawing context to render properly.\rIt delegates to the appropriate render step function based on the `stencilLayerMode`.", "kind": "function", "name": "stencilRenderStep", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "A reference to the current active WebGL renderer.", "name": "renderer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered in this call.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Renderer.WebGL.DrawingContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.DrawingContext" } }, "description": "The current drawing context.", "name": "drawingContext" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "This transform matrix is defined if the game object is nested", "name": "parentMatrix" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions.", "name": "renderStep" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "optional": true, "description": "The display list which is currently being rendered.", "name": "displayList" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The index of the Game Object within the display list.", "name": "displayListIndex" } ], "memberof": "Phaser.GameObjects.Stencil", "longname": "Phaser.GameObjects.Stencil#stencilRenderStep", "scope": "instance", "___id": "T000002R017546", "___s": true }, { "comment": "/**\r\n * The render step used when the `stencilLayerMode` is `addLayer` or `subtractLayer`.\r\n * You should not call this directly.\r\n *\r\n * @method Phaser.GameObjects.Stencil#stencilRenderStepLayers\r\n * @webglOnly\r\n * @since 4.2.0\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - A reference to the current active WebGL renderer.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered in this call.\r\n * @param {Phaser.Renderer.WebGL.DrawingContext} drawingContext - The current drawing context.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentMatrix] - This transform matrix is defined if the game object is nested\r\n * @param {number} [renderStep=0] - The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions.\r\n * @param {Phaser.GameObjects.GameObject[]} [displayList] - The display list which is currently being rendered.\r\n * @param {number} [displayListIndex] - The index of the Game Object within the display list.\r\n */", "meta": { "filename": "Stencil.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencil", "code": {} }, "description": "The render step used when the `stencilLayerMode` is `addLayer` or `subtractLayer`.\rYou should not call this directly.", "kind": "function", "name": "stencilRenderStepLayers", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "A reference to the current active WebGL renderer.", "name": "renderer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered in this call.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Renderer.WebGL.DrawingContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.DrawingContext" } }, "description": "The current drawing context.", "name": "drawingContext" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "This transform matrix is defined if the game object is nested", "name": "parentMatrix" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions.", "name": "renderStep" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "optional": true, "description": "The display list which is currently being rendered.", "name": "displayList" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The index of the Game Object within the display list.", "name": "displayListIndex" } ], "memberof": "Phaser.GameObjects.Stencil", "longname": "Phaser.GameObjects.Stencil#stencilRenderStepLayers", "scope": "instance", "___id": "T000002R017548", "___s": true }, { "comment": "/**\r\n * The render step used when the `stencilLayerMode` is `clear`.\r\n * You should not call this directly.\r\n *\r\n * @method Phaser.GameObjects.Stencil#stencilRenderStepClear\r\n * @webglOnly\r\n * @since 4.2.0\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - A reference to the current active WebGL renderer.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered in this call.\r\n * @param {Phaser.Renderer.WebGL.DrawingContext} drawingContext - The current drawing context.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentMatrix] - This transform matrix is defined if the game object is nested\r\n * @param {number} [renderStep=0] - The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions.\r\n * @param {Phaser.GameObjects.GameObject[]} [displayList] - The display list which is currently being rendered.\r\n * @param {number} [displayListIndex] - The index of the Game Object within the display list.\r\n */", "meta": { "filename": "Stencil.js", "lineno": 326, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencil", "code": {} }, "description": "The render step used when the `stencilLayerMode` is `clear`.\rYou should not call this directly.", "kind": "function", "name": "stencilRenderStepClear", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "A reference to the current active WebGL renderer.", "name": "renderer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered in this call.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Renderer.WebGL.DrawingContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.DrawingContext" } }, "description": "The current drawing context.", "name": "drawingContext" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "This transform matrix is defined if the game object is nested", "name": "parentMatrix" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions.", "name": "renderStep" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "optional": true, "description": "The display list which is currently being rendered.", "name": "displayList" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The index of the Game Object within the display list.", "name": "displayListIndex" } ], "memberof": "Phaser.GameObjects.Stencil", "longname": "Phaser.GameObjects.Stencil#stencilRenderStepClear", "scope": "instance", "___id": "T000002R017559", "___s": true }, { "comment": "/**\r\n * The render step used when the `stencilLayerMode` is `clearRegion`.\r\n * You should not call this directly.\r\n *\r\n * @method Phaser.GameObjects.Stencil#stencilRenderStepClearRegion\r\n * @webglOnly\r\n * @since 4.2.0\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - A reference to the current active WebGL renderer.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered in this call.\r\n * @param {Phaser.Renderer.WebGL.DrawingContext} drawingContext - The current drawing context.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentMatrix] - This transform matrix is defined if the game object is nested\r\n * @param {number} [renderStep=0] - The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions.\r\n * @param {Phaser.GameObjects.GameObject[]} [displayList] - The display list which is currently being rendered.\r\n * @param {number} [displayListIndex] - The index of the Game Object within the display list.\r\n */", "meta": { "filename": "Stencil.js", "lineno": 352, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencil", "code": {} }, "description": "The render step used when the `stencilLayerMode` is `clearRegion`.\rYou should not call this directly.", "kind": "function", "name": "stencilRenderStepClearRegion", "tags": [ { "originalTitle": "webglOnly", "title": "webglonly", "text": "" } ], "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "A reference to the current active WebGL renderer.", "name": "renderer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered in this call.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Renderer.WebGL.DrawingContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.DrawingContext" } }, "description": "The current drawing context.", "name": "drawingContext" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "This transform matrix is defined if the game object is nested", "name": "parentMatrix" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions.", "name": "renderStep" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "optional": true, "description": "The display list which is currently being rendered.", "name": "displayList" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The index of the Game Object within the display list.", "name": "displayListIndex" } ], "memberof": "Phaser.GameObjects.Stencil", "longname": "Phaser.GameObjects.Stencil#stencilRenderStepClearRegion", "scope": "instance", "___id": "T000002R017565", "___s": true }, { "comment": "/**\r\n * Checks if the game object or any of its children has a stencil.\r\n * This is used internally to determine if the stencil should composite its contents to a framebuffer.\r\n *\r\n * This is a depth-first, succeed-fast search.\r\n *\r\n * @method Phaser.GameObjects.Stencil#hasStencilChildren\r\n * @since 4.2.0\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to check.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The camera to check.\r\n * @returns {boolean} Whether the game object or any of its children has a stencil.\r\n */", "meta": { "filename": "Stencil.js", "lineno": 408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencil", "code": {} }, "description": "Checks if the game object or any of its children has a stencil.\rThis is used internally to determine if the stencil should composite its contents to a framebuffer.\r\rThis is a depth-first, succeed-fast search.", "kind": "function", "name": "hasStencilChildren", "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to check.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The camera to check.", "name": "camera" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the game object or any of its children has a stencil." } ], "memberof": "Phaser.GameObjects.Stencil", "longname": "Phaser.GameObjects.Stencil#hasStencilChildren", "scope": "instance", "___id": "T000002R017572", "___s": true }, { "comment": "/**\r\n * Creates a new Stencil Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Stencil Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#stencil\r\n * @since 4.2.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Stencil.StencilConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Stencil} The Game Object that was created.\r\n */", "meta": { "filename": "StencilCreator.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencil", "code": {} }, "description": "Creates a new Stencil Game Object and returns it.\r\rNote: This method will only be available if the Stencil Game Object has been built into Phaser.", "kind": "function", "name": "stencil", "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Stencil.StencilConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Stencil.StencilConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.Stencil" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Stencil" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#stencil", "scope": "instance", "___id": "T000002R017582", "___s": true }, { "comment": "/**\r\n * Creates a new Stencil Game Object and adds it to the Scene.\r\n *\r\n * A Stencil is a special type of Game Object used to place stencils over the canvas.\r\n * You can use it to efficiently control where subsequent objects are rendered.\r\n * It is WebGL-only.\r\n * Study the documentation ({@link Phaser.GameObjects.Stencil}) carefully to understand how it works.\r\n *\r\n * A Stencil is an extended Container Game Object.\r\n * It contains a list of child Game Objects to render to the stencil buffer.\r\n * Think of these as opaque sheets of card held up over the canvas,\r\n * preventing anything from being drawn through them.\r\n *\r\n * Note: This method will only be available if the Stencil Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#stencil\r\n * @since 4.2.0\r\n *\r\n * @param {number} [x=0] - The horizontal position of this Game Object in the world.\r\n * @param {number} [y=0] - The vertical position of this Game Object in the world.\r\n * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} [children] - An optional Game Object, or array of Game Objects, to add to this Stencil.\r\n * @param {Phaser.Types.GameObjects.Stencil.StencilOptions} [options] - The options for the Stencil.\r\n *\r\n * @return {Phaser.GameObjects.Stencil} The Game Object that was created.\r\n */", "meta": { "filename": "StencilFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencil", "code": {} }, "description": "Creates a new Stencil Game Object and adds it to the Scene.\r\rA Stencil is a special type of Game Object used to place stencils over the canvas.\rYou can use it to efficiently control where subsequent objects are rendered.\rIt is WebGL-only.\rStudy the documentation ({@link Phaser.GameObjects.Stencil}) carefully to understand how it works.\r\rA Stencil is an extended Container Game Object.\rIt contains a list of child Game Objects to render to the stencil buffer.\rThink of these as opaque sheets of card held up over the canvas,\rpreventing anything from being drawn through them.\r\rNote: This method will only be available if the Stencil Game Object has been built into Phaser.", "kind": "function", "name": "stencil", "since": "4.2.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An optional Game Object, or array of Game Objects, to add to this Stencil.", "name": "children" }, { "type": { "names": [ "Phaser.Types.GameObjects.Stencil.StencilOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Stencil.StencilOptions" } }, "optional": true, "description": "The options for the Stencil.", "name": "options" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Stencil" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Stencil" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#stencil", "scope": "instance", "___id": "T000002R017592", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Stencil\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencil\\typedefs", "code": {} }, "kind": "namespace", "name": "Stencil", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Stencil", "scope": "static", "___id": "T000002R017593", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Stencil.StencilConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 4.2.0\r\n *\r\n * @property {Phaser.GameObjects.GameObject[]} [children] - An optional array of Game Objects to add to the Stencil.\r\n * @property {Phaser.Types.GameObjects.Stencil.StencilOptions} [options] - The options for the Stencil.\r\n */", "meta": { "filename": "StencilConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencil\\typedefs", "code": {} }, "kind": "typedef", "name": "StencilConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "4.2.0", "properties": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of Game Objects to add to the Stencil.", "name": "children" }, { "type": { "names": [ "Phaser.Types.GameObjects.Stencil.StencilOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Stencil.StencilOptions" } }, "optional": true, "description": "The options for the Stencil.", "name": "options" } ], "memberof": "Phaser.Types.GameObjects.Stencil", "longname": "Phaser.Types.GameObjects.Stencil.StencilConfig", "scope": "static", "___id": "T000002R017594", "___s": true }, { "comment": "/**\r\n * @typedef {'addLayer'|'subtractLayer'|'clear'|'clearRegion'} Phaser.Types.GameObjects.Stencil.StencilLayerMode\r\n * @since 4.2.0\r\n */", "meta": { "filename": "StencilLayerModes.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencil\\typedefs", "code": {} }, "kind": "typedef", "name": "StencilLayerMode", "type": { "names": [ "'addLayer'", "'subtractLayer'", "'clear'", "'clearRegion'" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "'addLayer'" }, { "type": "NameExpression", "name": "'subtractLayer'" }, { "type": "NameExpression", "name": "'clear'" }, { "type": "NameExpression", "name": "'clearRegion'" } ] } }, "since": "4.2.0", "memberof": "Phaser.Types.GameObjects.Stencil", "longname": "Phaser.Types.GameObjects.Stencil.StencilLayerMode", "scope": "static", "___id": "T000002R017595", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Stencil.StencilOptions\r\n * @since 4.2.0\r\n *\r\n * @property {Phaser.Types.Renderer.WebGL.AlphaStrategy} [stencilAlphaStrategy='dither'] - The alpha strategy to use when rendering the stencil.\r\n * @property {number} [stencilClearValue=0] - The value to clear the stencil to, if the `stencilLayerMode` is `clear` or `clearRegion`. Must be between 0 and 255.\r\n * @property {boolean|'auto'} [stencilCompositeCheck='auto'] - Whether to composite the contents of the stencil to a framebuffer.\r\n * @property {boolean} [stencilInvert=false] - Whether to invert the stencil, using an extra draw call. This only works with the `addLayer` and `subtractLayer` modes.\r\n * @property {Phaser.Types.GameObjects.Stencil.StencilLayerMode} [stencilLayerMode='addLayer'] - The mode which the Stencil runs in.\r\n * @property {boolean} [stencilValueWrap=true] - Whether to wrap the value in the stencil buffer when it overflows or underflows when using the `addLayer` or `subtractLayer` mode. This is useful when defining stencils with subtraction, and you don't want to underflow from 0 to 255.\r\n */", "meta": { "filename": "StencilOptions.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencil\\typedefs", "code": {} }, "kind": "typedef", "name": "StencilOptions", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.2.0", "properties": [ { "type": { "names": [ "Phaser.Types.Renderer.WebGL.AlphaStrategy" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Renderer.WebGL.AlphaStrategy" } }, "optional": true, "defaultvalue": "'dither'", "description": "The alpha strategy to use when rendering the stencil.", "name": "stencilAlphaStrategy" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The value to clear the stencil to, if the `stencilLayerMode` is `clear` or `clearRegion`. Must be between 0 and 255.", "name": "stencilClearValue" }, { "type": { "names": [ "boolean", "'auto'" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "'auto'" } ] } }, "optional": true, "defaultvalue": "'auto'", "description": "Whether to composite the contents of the stencil to a framebuffer.", "name": "stencilCompositeCheck" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to invert the stencil, using an extra draw call. This only works with the `addLayer` and `subtractLayer` modes.", "name": "stencilInvert" }, { "type": { "names": [ "Phaser.Types.GameObjects.Stencil.StencilLayerMode" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Stencil.StencilLayerMode" } }, "optional": true, "defaultvalue": "'addLayer'", "description": "The mode which the Stencil runs in.", "name": "stencilLayerMode" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether to wrap the value in the stencil buffer when it overflows or underflows when using the `addLayer` or `subtractLayer` mode. This is useful when defining stencils with subtraction, and you don't want to underflow from 0 to 255.", "name": "stencilValueWrap" } ], "memberof": "Phaser.Types.GameObjects.Stencil", "longname": "Phaser.Types.GameObjects.Stencil.StencilOptions", "scope": "static", "___id": "T000002R017596", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A StencilReference Game Object.\r\n *\r\n * A StencilReference is a special type of Game Object that uses a Stencil\r\n * as a reference for its own rendering. This allows you to re-render a Stencil\r\n * using different settings.\r\n *\r\n * For example, you can add a layer with a Stencil with some complex geometry,\r\n * draw objects affected by the stencil layer,\r\n * then use a StencilReference to subtract the same layer without recreating it.\r\n *\r\n * It is WebGL-only.\r\n *\r\n * A StencilReference temporarily changes the settings on the target Stencil,\r\n * then restores them after rendering.\r\n * Thus, it keeps the original Stencil's transforms.\r\n * The stencil options can be changed by setting the properties on this object.\r\n * Note that these properties will be set to default values,\r\n * so if you have configured the targetStencil with its own properties,\r\n * you should configure this with those properties as well,\r\n * altered to your requirements.\r\n *\r\n * See the {@link Phaser.GameObjects.Stencil} documentation for more details.\r\n *\r\n * @class StencilReference\r\n * @extends Phaser.GameObjects.GameObject\r\n * @extends Phaser.GameObjects.Components.StencilModifier\r\n * @extends Phaser.GameObjects.Components.Visible\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 4.2.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {Phaser.GameObjects.Stencil} targetStencil - The Stencil to use as a reference.\r\n * @param {Phaser.Types.GameObjects.Stencil.StencilOptions} [options] - The options for the StencilReference.\r\n */", "meta": { "filename": "StencilReference.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencilreference", "code": {} }, "classdesc": "A StencilReference Game Object.\r\rA StencilReference is a special type of Game Object that uses a Stencil\ras a reference for its own rendering. This allows you to re-render a Stencil\rusing different settings.\r\rFor example, you can add a layer with a Stencil with some complex geometry,\rdraw objects affected by the stencil layer,\rthen use a StencilReference to subtract the same layer without recreating it.\r\rIt is WebGL-only.\r\rA StencilReference temporarily changes the settings on the target Stencil,\rthen restores them after rendering.\rThus, it keeps the original Stencil's transforms.\rThe stencil options can be changed by setting the properties on this object.\rNote that these properties will be set to default values,\rso if you have configured the targetStencil with its own properties,\ryou should configure this with those properties as well,\raltered to your requirements.\r\rSee the {@link Phaser.GameObjects.Stencil} documentation for more details.", "kind": "class", "name": "StencilReference", "augments": [ "Phaser.GameObjects.GameObject", "Phaser.GameObjects.Components.StencilModifier", "Phaser.GameObjects.Components.Visible" ], "memberof": "Phaser.GameObjects", "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "Phaser.GameObjects.Stencil" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Stencil" } }, "description": "The Stencil to use as a reference.", "name": "targetStencil" }, { "type": { "names": [ "Phaser.Types.GameObjects.Stencil.StencilOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Stencil.StencilOptions" } }, "optional": true, "description": "The options for the StencilReference.", "name": "options" } ], "scope": "static", "longname": "Phaser.GameObjects.StencilReference", "___id": "T000002R017602", "___s": true }, { "comment": "/**\r\n * The Stencil to use as a reference.\r\n *\r\n * @name Phaser.GameObjects.StencilReference#targetStencil\r\n * @type {Phaser.GameObjects.Stencil}\r\n * @since 4.2.0\r\n */", "meta": { "filename": "StencilReference.js", "lineno": 62, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencilreference", "code": {} }, "description": "The Stencil to use as a reference.", "name": "targetStencil", "type": { "names": [ "Phaser.GameObjects.Stencil" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Stencil" } }, "since": "4.2.0", "memberof": "Phaser.GameObjects.StencilReference", "longname": "Phaser.GameObjects.StencilReference#targetStencil", "scope": "instance", "kind": "member", "___id": "T000002R017607", "___s": true }, { "comment": "/**\r\n * The blend mode to use when rendering the stencil reference.\r\n * This is read-only, and is only used for internal compliance.\r\n * Stencil drawing uses its own combination rules.\r\n *\r\n * @name Phaser.GameObjects.StencilReference#blendMode\r\n * @type {number}\r\n * @since 4.2.0\r\n * @readonly\r\n * @default Phaser.BlendModes.SKIP_CHECK\r\n */", "meta": { "filename": "StencilReference.js", "lineno": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencilreference", "code": {} }, "description": "The blend mode to use when rendering the stencil reference.\rThis is read-only, and is only used for internal compliance.\rStencil drawing uses its own combination rules.", "name": "blendMode", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "4.2.0", "readonly": true, "defaultvalue": "Phaser.BlendModes.SKIP_CHECK", "memberof": "Phaser.GameObjects.StencilReference", "longname": "Phaser.GameObjects.StencilReference#blendMode", "scope": "instance", "kind": "member", "___id": "T000002R017617", "___s": true }, { "comment": "/**\r\n * Pre-destroy callback.\r\n * @method Phaser.GameObjects.StencilReference#preDestroy\r\n * @since 4.2.0\r\n */", "meta": { "filename": "StencilReference.js", "lineno": 128, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencilreference", "code": {} }, "description": "Pre-destroy callback.", "kind": "function", "name": "preDestroy", "since": "4.2.0", "memberof": "Phaser.GameObjects.StencilReference", "longname": "Phaser.GameObjects.StencilReference#preDestroy", "scope": "instance", "___id": "T000002R017621", "___s": true }, { "comment": "/**\r\n * Creates a new StencilReference Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the StencilReference Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#stencilreference\r\n * @since 4.2.0\r\n *\r\n * @param {Phaser.Types.GameObjects.StencilReference.StencilReferenceConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.StencilReference} The Game Object that was created.\r\n */", "meta": { "filename": "StencilReferenceCreator.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencilreference", "code": {} }, "description": "Creates a new StencilReference Game Object and returns it.\r\rNote: This method will only be available if the StencilReference Game Object has been built into Phaser.", "kind": "function", "name": "stencilreference", "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.StencilReference.StencilReferenceConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.StencilReference.StencilReferenceConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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.StencilReference" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.StencilReference" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#stencilreference", "scope": "instance", "___id": "T000002R017630", "___s": true }, { "comment": "/**\r\n * Creates a new StencilReference Game Object and adds it to the Scene.\r\n *\r\n * A StencilReference is a special type of Game Object that can be used to reference a Stencil.\r\n * You can use a StencilReference to reference a Stencil, and then use the StencilReference to render the Stencil.\r\n * This is useful for creating complex stencil effects.\r\n *\r\n * Note: This method will only be available if the StencilReference Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#stencilreference\r\n * @since 4.2.0\r\n *\r\n * @param {Phaser.GameObjects.Stencil} targetStencil - The Stencil to use as a reference.\r\n * @param {Phaser.Types.GameObjects.Stencil.StencilOptions} [options] - The options for the StencilReference.\r\n *\r\n * @return {Phaser.GameObjects.StencilReference} The Game Object that was created.\r\n */", "meta": { "filename": "StencilReferenceFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencilreference", "code": {} }, "description": "Creates a new StencilReference Game Object and adds it to the Scene.\r\rA StencilReference is a special type of Game Object that can be used to reference a Stencil.\rYou can use a StencilReference to reference a Stencil, and then use the StencilReference to render the Stencil.\rThis is useful for creating complex stencil effects.\r\rNote: This method will only be available if the StencilReference Game Object has been built into Phaser.", "kind": "function", "name": "stencilreference", "since": "4.2.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Stencil" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Stencil" } }, "description": "The Stencil to use as a reference.", "name": "targetStencil" }, { "type": { "names": [ "Phaser.Types.GameObjects.Stencil.StencilOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Stencil.StencilOptions" } }, "optional": true, "description": "The options for the StencilReference.", "name": "options" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.StencilReference" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.StencilReference" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#stencilreference", "scope": "instance", "___id": "T000002R017638", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.StencilReference\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencilreference\\typedefs", "code": {} }, "kind": "namespace", "name": "StencilReference", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.StencilReference", "scope": "static", "___id": "T000002R017669", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.StencilReference.StencilReferenceConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 4.2.0\r\n *\r\n * @property {Phaser.GameObjects.Stencil} [targetStencil] - The Stencil to use as a reference.\r\n * @property {Phaser.Types.GameObjects.Stencil.StencilOptions} [options] - The options for the StencilReference.\r\n */", "meta": { "filename": "StencilReferenceConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\stencilreference\\typedefs", "code": {} }, "kind": "typedef", "name": "StencilReferenceConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "4.2.0", "properties": [ { "type": { "names": [ "Phaser.GameObjects.Stencil" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Stencil" } }, "optional": true, "description": "The Stencil to use as a reference.", "name": "targetStencil" }, { "type": { "names": [ "Phaser.Types.GameObjects.Stencil.StencilOptions" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Stencil.StencilOptions" } }, "optional": true, "description": "The options for the StencilReference.", "name": "options" } ], "memberof": "Phaser.Types.GameObjects.StencilReference", "longname": "Phaser.Types.GameObjects.StencilReference.StencilReferenceConfig", "scope": "static", "___id": "T000002R017670", "___s": true }, { "comment": "/**\r\n * Calculates and returns the rendered dimensions of a Text object, including the width of each line, the maximum line width, the total height (accounting for line spacing), and the number of drawn lines (respecting `maxLines`).\r\n *\r\n * @function Phaser.GameObjects.GetTextSize\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Text} text - The Text object to calculate the size from.\r\n * @param {Phaser.Types.GameObjects.Text.TextMetrics} size - The Text metrics to use when calculating the size.\r\n * @param {string[]} lines - The lines of text to calculate the size from.\r\n *\r\n * @return {Phaser.Types.GameObjects.Text.GetTextSizeObject} An object containing dimensions of the Text object.\r\n */", "meta": { "filename": "GetTextSize.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Calculates and returns the rendered dimensions of a Text object, including the width of each line, the maximum line width, the total height (accounting for line spacing), and the number of drawn lines (respecting `maxLines`).", "kind": "function", "name": "GetTextSize", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The Text object to calculate the size from.", "name": "text" }, { "type": { "names": [ "Phaser.Types.GameObjects.Text.TextMetrics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextMetrics" } }, "description": "The Text metrics to use when calculating the size.", "name": "size" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "The lines of text to calculate the size from.", "name": "lines" } ], "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.Text.GetTextSizeObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.GetTextSizeObject" } }, "description": "An object containing dimensions of the Text object." } ], "memberof": "Phaser.GameObjects", "longname": "Phaser.GameObjects.GetTextSize", "scope": "static", "___id": "T000002R017671", "___s": true }, { "comment": "/**\r\n * Calculates the ascent, descent, and fontSize metrics for a given TextStyle by rendering text to a temporary offscreen canvas and measuring the pixel boundaries. It uses the `actualBoundingBoxAscent`/`actualBoundingBoxDescent` API where available, falling back to a pixel-scanning approach for older browsers.\r\n *\r\n * @function Phaser.GameObjects.MeasureText\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.TextStyle} textStyle - The TextStyle object to measure.\r\n *\r\n * @return {Phaser.Types.GameObjects.Text.TextMetrics} An object containing the ascent, descent and fontSize of the TextStyle.\r\n */", "meta": { "filename": "MeasureText.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Calculates the ascent, descent, and fontSize metrics for a given TextStyle by rendering text to a temporary offscreen canvas and measuring the pixel boundaries. It uses the `actualBoundingBoxAscent`/`actualBoundingBoxDescent` API where available, falling back to a pixel-scanning approach for older browsers.", "kind": "function", "name": "MeasureText", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.TextStyle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.TextStyle" } }, "description": "The TextStyle object to measure.", "name": "textStyle" } ], "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.Text.TextMetrics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextMetrics" } }, "description": "An object containing the ascent, descent and fontSize of the TextStyle." } ], "memberof": "Phaser.GameObjects", "longname": "Phaser.GameObjects.MeasureText", "scope": "static", "___id": "T000002R017703", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Text Game Object.\r\n *\r\n * Text objects work by creating their own internal hidden Canvas and then renders text to it using\r\n * the standard Canvas `fillText` API. It then creates a texture from this canvas which is rendered\r\n * to your game during the render pass.\r\n *\r\n * Because it uses the Canvas API you can take advantage of all the features this offers, such as\r\n * applying gradient fills to the text, or strokes, shadows and more. You can also use custom fonts\r\n * loaded externally, such as Google or TypeKit Web fonts.\r\n *\r\n * **Important:** The font name must be quoted if it contains certain combinations of digits or\r\n * special characters, either when creating the Text object, or when setting the font via `setFont`\r\n * or `setFontFamily`, e.g.:\r\n *\r\n * ```javascript\r\n * this.add.text(0, 0, 'Hello World', { fontFamily: 'Georgia, \"Goudy Bookletter 1911\", Times, serif' });\r\n * ```\r\n *\r\n * ```javascript\r\n * this.add.text(0, 0, 'Hello World', { font: '\"Press Start 2P\"' });\r\n * ```\r\n *\r\n * You can only display fonts that are currently loaded and available to the browser: therefore fonts must\r\n * be pre-loaded. Phaser does not do this for you, so you will require the use of a 3rd party font loader,\r\n * or have the fonts readily available in the CSS on the page in which your Phaser game resides.\r\n *\r\n * See {@link http://www.jordanm.co.uk/tinytype this compatibility table} for the available default fonts\r\n * across mobile browsers.\r\n *\r\n * A note on performance: Every time the contents of a Text object changes, i.e. changing the text being\r\n * displayed, or the style of the text, it needs to remake the Text canvas, and if on WebGL, re-upload the\r\n * new texture to the GPU. This can be an expensive operation if used often, or with large quantities of\r\n * Text objects in your game. If you run into performance issues you would be better off using Bitmap Text\r\n * instead, as it benefits from batching and avoids expensive Canvas API calls.\r\n *\r\n * @class Text\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.GameObjects.Components.Alpha\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.ComputedSize\r\n * @extends Phaser.GameObjects.Components.Crop\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Flip\r\n * @extends Phaser.GameObjects.Components.GetBounds\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Tint\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {(string|string[])} text - The text this Text object will display.\r\n * @param {Phaser.Types.GameObjects.Text.TextStyle} style - The text style configuration object.\r\n *\r\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-family#Valid_family_names\r\n */", "meta": { "filename": "Text.js", "lineno": 20, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "classdesc": "A Text Game Object.\r\rText objects work by creating their own internal hidden Canvas and then renders text to it using\rthe standard Canvas `fillText` API. It then creates a texture from this canvas which is rendered\rto your game during the render pass.\r\rBecause it uses the Canvas API you can take advantage of all the features this offers, such as\rapplying gradient fills to the text, or strokes, shadows and more. You can also use custom fonts\rloaded externally, such as Google or TypeKit Web fonts.\r\r**Important:** The font name must be quoted if it contains certain combinations of digits or\rspecial characters, either when creating the Text object, or when setting the font via `setFont`\ror `setFontFamily`, e.g.:\r\r```javascript\rthis.add.text(0, 0, 'Hello World', { fontFamily: 'Georgia, \"Goudy Bookletter 1911\", Times, serif' });\r```\r\r```javascript\rthis.add.text(0, 0, 'Hello World', { font: '\"Press Start 2P\"' });\r```\r\rYou can only display fonts that are currently loaded and available to the browser: therefore fonts must\rbe pre-loaded. Phaser does not do this for you, so you will require the use of a 3rd party font loader,\ror have the fonts readily available in the CSS on the page in which your Phaser game resides.\r\rSee {@link http://www.jordanm.co.uk/tinytype this compatibility table} for the available default fonts\racross mobile browsers.\r\rA note on performance: Every time the contents of a Text object changes, i.e. changing the text being\rdisplayed, or the style of the text, it needs to remake the Text canvas, and if on WebGL, re-upload the\rnew texture to the GPU. This can be an expensive operation if used often, or with large quantities of\rText objects in your game. If you run into performance issues you would be better off using Bitmap Text\rinstead, 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.RenderNodes", "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "description": "The text this Text object will display.", "name": "text" }, { "type": { "names": [ "Phaser.Types.GameObjects.Text.TextStyle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextStyle" } }, "description": "The text style configuration object.", "name": "style" } ], "see": [ "https://developer.mozilla.org/en-US/docs/Web/CSS/font-family#Valid_family_names" ], "scope": "static", "longname": "Phaser.GameObjects.Text", "___id": "T000002R017767", "___s": true }, { "comment": "/**\r\n * The renderer in use by this Text object.\r\n *\r\n * @name Phaser.GameObjects.Text#renderer\r\n * @type {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "Text.js", "lineno": 118, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The renderer in use by this Text object.", "name": "renderer", "type": { "names": [ "Phaser.Renderer.Canvas.CanvasRenderer", "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.Canvas.CanvasRenderer" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } ] } }, "since": "3.12.0", "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#renderer", "scope": "instance", "kind": "member", "___id": "T000002R017774", "___s": true }, { "comment": "/**\r\n * The canvas element that the text is rendered to.\r\n *\r\n * @name Phaser.GameObjects.Text#canvas\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Text.js", "lineno": 131, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The canvas element that the text is rendered to.", "name": "canvas", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#canvas", "scope": "instance", "kind": "member", "___id": "T000002R017776", "___s": true }, { "comment": "/**\r\n * The context of the canvas element that the text is rendered to.\r\n *\r\n * @name Phaser.GameObjects.Text#context\r\n * @type {CanvasRenderingContext2D}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Text.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The context of the canvas element that the text is rendered to.", "name": "context", "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#context", "scope": "instance", "kind": "member", "___id": "T000002R017778", "___s": true }, { "comment": "/**\r\n * The Text Style object.\r\n *\r\n * Manages the style of this Text object.\r\n *\r\n * @name Phaser.GameObjects.Text#style\r\n * @type {Phaser.GameObjects.TextStyle}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Text.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The Text Style object.\r\rManages the style of this Text object.", "name": "style", "type": { "names": [ "Phaser.GameObjects.TextStyle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.TextStyle" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#style", "scope": "instance", "kind": "member", "___id": "T000002R017780", "___s": true }, { "comment": "/**\r\n * Whether to automatically round line positions.\r\n *\r\n * @name Phaser.GameObjects.Text#autoRound\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Text.js", "lineno": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Whether to automatically round line positions.", "name": "autoRound", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#autoRound", "scope": "instance", "kind": "member", "___id": "T000002R017782", "___s": true }, { "comment": "/**\r\n * The Regular Expression that is used to split the text up into lines, in\r\n * multi-line text. By default this is `/(?:\\r\\n|\\r|\\n)/`.\r\n * You can change this RegExp to be anything else that you may need.\r\n *\r\n * @name Phaser.GameObjects.Text#splitRegExp\r\n * @type {object}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Text.js", "lineno": 170, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The Regular Expression that is used to split the text up into lines, in\rmulti-line text. By default this is `/(?:\\r\\n|\\r|\\n)/`.\rYou can change this RegExp to be anything else that you may need.", "name": "splitRegExp", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#splitRegExp", "scope": "instance", "kind": "member", "___id": "T000002R017784", "___s": true }, { "comment": "/**\r\n * Specify a padding value which is added to the line width and height when calculating the Text size.\r\n * Allows you to add extra spacing if the browser is unable to accurately determine the true font dimensions.\r\n *\r\n * @name Phaser.GameObjects.Text#padding\r\n * @type {Phaser.Types.GameObjects.Text.TextPadding}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Text.js", "lineno": 191, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Specify a padding value which is added to the line width and height when calculating the Text size.\rAllows you to add extra spacing if the browser is unable to accurately determine the true font dimensions.", "name": "padding", "type": { "names": [ "Phaser.Types.GameObjects.Text.TextPadding" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextPadding" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#padding", "scope": "instance", "kind": "member", "___id": "T000002R017788", "___s": true }, { "comment": "/**\r\n * The width of this Text object.\r\n *\r\n * @name Phaser.GameObjects.Text#width\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Text.js", "lineno": 201, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The width of this Text object.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R017794", "___s": true }, { "comment": "/**\r\n * The height of this Text object.\r\n *\r\n * @name Phaser.GameObjects.Text#height\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Text.js", "lineno": 211, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The height of this Text object.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R017796", "___s": true }, { "comment": "/**\r\n * The line spacing value.\r\n * This value is added to the font height to calculate the overall line height.\r\n * Only has an effect if this Text object contains multiple lines of text.\r\n *\r\n * If you update this property directly, instead of using the `setLineSpacing` method, then\r\n * be sure to call `updateText` after, or you won't see the change reflected in the Text object.\r\n *\r\n * @name Phaser.GameObjects.Text#lineSpacing\r\n * @type {number}\r\n * @since 3.13.0\r\n */", "meta": { "filename": "Text.js", "lineno": 221, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The line spacing value.\rThis value is added to the font height to calculate the overall line height.\rOnly has an effect if this Text object contains multiple lines of text.\r\rIf you update this property directly, instead of using the `setLineSpacing` method, then\rbe sure to call `updateText` after, or you won't see the change reflected in the Text object.", "name": "lineSpacing", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.13.0", "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#lineSpacing", "scope": "instance", "kind": "member", "___id": "T000002R017798", "___s": true }, { "comment": "/**\r\n * Adds / Removes spacing between characters.\r\n * Can be a negative or positive number.\r\n *\r\n * If you update this property directly, instead of using the `setLetterSpacing` method, then\r\n * be sure to call `updateText` after, or you won't see the change reflected in the Text object.\r\n *\r\n * @name Phaser.GameObjects.Text#letterSpacing\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Text.js", "lineno": 235, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Adds / Removes spacing between characters.\rCan be a negative or positive number.\r\rIf you update this property directly, instead of using the `setLetterSpacing` method, then\rbe sure to call `updateText` after, or you won't see the change reflected in the Text object.", "name": "letterSpacing", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#letterSpacing", "scope": "instance", "kind": "member", "___id": "T000002R017800", "___s": true }, { "comment": "/**\r\n * Initialize right to left text.\r\n *\r\n * @method Phaser.GameObjects.Text#initRTL\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Text.js", "lineno": 331, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "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", "___id": "T000002R017815", "___s": true }, { "comment": "/**\r\n * Applies word wrapping to the given text and returns the result. If a custom word wrap\r\n * callback has been set, it will be invoked. Otherwise, the advanced or basic word wrap\r\n * algorithm will be used, depending on the style configuration. If no word wrap settings\r\n * are active, the original text is returned unchanged.\r\n *\r\n * @method Phaser.GameObjects.Text#runWordWrap\r\n * @since 3.0.0\r\n *\r\n * @param {string} text - The text to perform word wrap detection against.\r\n *\r\n * @return {string} The text after wrapping has been applied.\r\n */", "meta": { "filename": "Text.js", "lineno": 365, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Applies word wrapping to the given text and returns the result. If a custom word wrap\rcallback has been set, it will be invoked. Otherwise, the advanced or basic word wrap\ralgorithm will be used, depending on the style configuration. If no word wrap settings\rare active, the original text is returned unchanged.", "kind": "function", "name": "runWordWrap", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The text to perform word wrap detection against.", "name": "text" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The text after wrapping has been applied." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#runWordWrap", "scope": "instance", "___id": "T000002R017823", "___s": true }, { "comment": "/**\r\n * Advanced wrapping algorithm that will wrap words as the line grows longer than its horizontal\r\n * bounds. Consecutive spaces will be collapsed and replaced with a single space. Lines will be\r\n * trimmed of white space before processing. Throws an error if wordWrapWidth is less than a\r\n * single character.\r\n *\r\n * @method Phaser.GameObjects.Text#advancedWordWrap\r\n * @since 3.0.0\r\n *\r\n * @param {string} text - The text to perform word wrap detection against.\r\n * @param {CanvasRenderingContext2D} context - The Canvas Rendering Context.\r\n * @param {number} wordWrapWidth - The word wrap width.\r\n *\r\n * @return {string} The wrapped text.\r\n */", "meta": { "filename": "Text.js", "lineno": 410, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Advanced wrapping algorithm that will wrap words as the line grows longer than its horizontal\rbounds. Consecutive spaces will be collapsed and replaced with a single space. Lines will be\rtrimmed of white space before processing. Throws an error if wordWrapWidth is less than a\rsingle character.", "kind": "function", "name": "advancedWordWrap", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The text to perform word wrap detection against.", "name": "text" }, { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "description": "The Canvas Rendering Context.", "name": "context" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The word wrap width.", "name": "wordWrapWidth" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The wrapped text." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#advancedWordWrap", "scope": "instance", "___id": "T000002R017828", "___s": true }, { "comment": "/**\r\n * Greedy wrapping algorithm that will wrap words as the line grows longer than its horizontal\r\n * bounds. Spaces are not collapsed and whitespace is not trimmed.\r\n *\r\n * @method Phaser.GameObjects.Text#basicWordWrap\r\n * @since 3.0.0\r\n *\r\n * @param {string} text - The text to perform word wrap detection against.\r\n * @param {CanvasRenderingContext2D} context - The Canvas Rendering Context.\r\n * @param {number} wordWrapWidth - The word wrap width.\r\n *\r\n * @return {string} The wrapped text.\r\n */", "meta": { "filename": "Text.js", "lineno": 534, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Greedy wrapping algorithm that will wrap words as the line grows longer than its horizontal\rbounds. Spaces are not collapsed and whitespace is not trimmed.", "kind": "function", "name": "basicWordWrap", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The text to perform word wrap detection against.", "name": "text" }, { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "description": "The Canvas Rendering Context.", "name": "context" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The word wrap width.", "name": "wordWrapWidth" } ], "returns": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The wrapped text." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#basicWordWrap", "scope": "instance", "___id": "T000002R017861", "___s": true }, { "comment": "/**\r\n * Runs the given text through this Text objects word wrapping and returns the results as an\r\n * array, where each element of the array corresponds to a wrapped line of text.\r\n *\r\n * @method Phaser.GameObjects.Text#getWrappedText\r\n * @since 3.0.0\r\n *\r\n * @param {string} [text] - The text for which the wrapping will be calculated. If unspecified, the Text objects current text will be used.\r\n *\r\n * @return {string[]} An array of strings with the pieces of wrapped text.\r\n */", "meta": { "filename": "Text.js", "lineno": 605, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Runs the given text through this Text objects word wrapping and returns the results as an\rarray, 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } }, "description": "An array of strings with the pieces of wrapped text." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#getWrappedText", "scope": "instance", "___id": "T000002R017884", "___s": true }, { "comment": "/**\r\n * Set the text to display.\r\n *\r\n * An array of strings will be joined with `\\n` line breaks.\r\n *\r\n * @method Phaser.GameObjects.Text#setText\r\n * @since 3.0.0\r\n *\r\n * @param {(string|string[])} value - The string, or array of strings, to be set as the content of this Text object.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 627, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the text to display.\r\rAn array of strings will be joined with `\\n` line breaks.", "kind": "function", "name": "setText", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "description": "The string, or array of strings, to be set as the content of this Text object.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setText", "scope": "instance", "___id": "T000002R017888", "___s": true }, { "comment": "/**\r\n * Appends the given text to the content already being displayed by this Text object.\r\n *\r\n * An array of strings will be joined with `\\n` line breaks.\r\n *\r\n * @method Phaser.GameObjects.Text#appendText\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[])} value - The string, or array of strings, to be appended to the existing content of this Text object.\r\n * @param {boolean} [addCR=true] - Insert a carriage-return before the string value.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 661, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Appends the given text to the content already being displayed by this Text object.\r\rAn array of strings will be joined with `\\n` line breaks.", "kind": "function", "name": "appendText", "since": "3.60.0", "params": [ { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "description": "The string, or array of strings, to be appended to the existing content of this Text object.", "name": "value" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Insert a carriage-return before the string value.", "name": "addCR" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#appendText", "scope": "instance", "___id": "T000002R017893", "___s": true }, { "comment": "/**\r\n * Set the text style.\r\n *\r\n * @example\r\n * text.setStyle({\r\n * fontSize: '64px',\r\n * fontFamily: 'Arial',\r\n * color: '#ffffff',\r\n * align: 'center',\r\n * backgroundColor: '#ff00ff'\r\n * });\r\n *\r\n * @method Phaser.GameObjects.Text#setStyle\r\n * @since 3.0.0\r\n *\r\n * @param {object} style - The style settings to set.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 702, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the text style.", "examples": [ "text.setStyle({\r fontSize: '64px',\r fontFamily: 'Arial',\r color: '#ffffff',\r align: 'center',\r backgroundColor: '#ff00ff'\r});" ], "kind": "function", "name": "setStyle", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The style settings to set.", "name": "style" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setStyle", "scope": "instance", "___id": "T000002R017901", "___s": true }, { "comment": "/**\r\n * Set the font.\r\n *\r\n * If a string is given, the font family is set.\r\n *\r\n * If an object is given, the `fontFamily`, `fontSize` and `fontStyle`\r\n * properties of that object are set.\r\n *\r\n * **Important:** The font name must be quoted if it contains certain combinations of digits or\r\n * special characters:\r\n *\r\n * ```javascript\r\n * Text.setFont('\"Press Start 2P\"');\r\n * ```\r\n *\r\n * Equally, if you wish to provide a list of fallback fonts, then you should ensure they are all\r\n * quoted properly, too:\r\n *\r\n * ```javascript\r\n * Text.setFont('Georgia, \"Goudy Bookletter 1911\", Times, serif');\r\n * ```\r\n *\r\n * @method Phaser.GameObjects.Text#setFont\r\n * @since 3.0.0\r\n *\r\n * @param {string} font - The font family or font settings to set.\r\n *\r\n * @return {this} This Text object.\r\n *\r\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-family#Valid_family_names\r\n */", "meta": { "filename": "Text.js", "lineno": 726, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the font.\r\rIf a string is given, the font family is set.\r\rIf an object is given, the `fontFamily`, `fontSize` and `fontStyle`\rproperties of that object are set.\r\r**Important:** The font name must be quoted if it contains certain combinations of digits or\rspecial characters:\r\r```javascript\rText.setFont('\"Press Start 2P\"');\r```\r\rEqually, if you wish to provide a list of fallback fonts, then you should ensure they are all\rquoted properly, too:\r\r```javascript\rText.setFont('Georgia, \"Goudy Bookletter 1911\", Times, serif');\r```", "kind": "function", "name": "setFont", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The font family or font settings to set.", "name": "font" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "see": [ "https://developer.mozilla.org/en-US/docs/Web/CSS/font-family#Valid_family_names" ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setFont", "scope": "instance", "___id": "T000002R017903", "___s": true }, { "comment": "/**\r\n * Set the font family.\r\n *\r\n * **Important:** The font name must be quoted if it contains certain combinations of digits or\r\n * special characters:\r\n *\r\n * ```javascript\r\n * Text.setFontFamily('\"Press Start 2P\"');\r\n * ```\r\n *\r\n * Equally, if you wish to provide a list of fallback fonts, then you should ensure they are all\r\n * quoted properly, too:\r\n *\r\n * ```javascript\r\n * Text.setFontFamily('Georgia, \"Goudy Bookletter 1911\", Times, serif');\r\n * ```\r\n *\r\n * @method Phaser.GameObjects.Text#setFontFamily\r\n * @since 3.0.0\r\n *\r\n * @param {string} family - The font family.\r\n *\r\n * @return {this} This Text object.\r\n *\r\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-family#Valid_family_names\r\n */", "meta": { "filename": "Text.js", "lineno": 762, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the font family.\r\r**Important:** The font name must be quoted if it contains certain combinations of digits or\rspecial characters:\r\r```javascript\rText.setFontFamily('\"Press Start 2P\"');\r```\r\rEqually, if you wish to provide a list of fallback fonts, then you should ensure they are all\rquoted properly, too:\r\r```javascript\rText.setFontFamily('Georgia, \"Goudy Bookletter 1911\", Times, serif');\r```", "kind": "function", "name": "setFontFamily", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The font family.", "name": "family" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "see": [ "https://developer.mozilla.org/en-US/docs/Web/CSS/font-family#Valid_family_names" ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setFontFamily", "scope": "instance", "___id": "T000002R017905", "___s": true }, { "comment": "/**\r\n * Set the font size. Can be a string with a valid CSS unit, i.e. `16px`, or a number.\r\n *\r\n * @method Phaser.GameObjects.Text#setFontSize\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number)} size - The font size.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 793, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the font size. Can be a string with a valid CSS unit, i.e. `16px`, or a number.", "kind": "function", "name": "setFontSize", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The font size.", "name": "size" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setFontSize", "scope": "instance", "___id": "T000002R017907", "___s": true }, { "comment": "/**\r\n * Set the font style.\r\n *\r\n * @method Phaser.GameObjects.Text#setFontStyle\r\n * @since 3.0.0\r\n *\r\n * @param {string} style - The font style.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 808, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the font style.", "kind": "function", "name": "setFontStyle", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The font style.", "name": "style" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setFontStyle", "scope": "instance", "___id": "T000002R017909", "___s": true }, { "comment": "/**\r\n * Set a fixed width and height for the text.\r\n *\r\n * Pass in `0` for either of these parameters to disable fixed width or height respectively.\r\n *\r\n * @method Phaser.GameObjects.Text#setFixedSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The fixed width to set. `0` disables fixed width.\r\n * @param {number} height - The fixed height to set. `0` disables fixed height.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 823, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set a fixed width and height for the text.\r\rPass 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The fixed width to set. `0` disables fixed width.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The fixed height to set. `0` disables fixed height.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setFixedSize", "scope": "instance", "___id": "T000002R017911", "___s": true }, { "comment": "/**\r\n * Set the background color.\r\n *\r\n * @method Phaser.GameObjects.Text#setBackgroundColor\r\n * @since 3.0.0\r\n *\r\n * @param {string} color - The background color.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 841, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the background color.", "kind": "function", "name": "setBackgroundColor", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The background color.", "name": "color" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setBackgroundColor", "scope": "instance", "___id": "T000002R017913", "___s": true }, { "comment": "/**\r\n * Set the fill style to be used by the Text object.\r\n *\r\n * This can be any valid CanvasRenderingContext2D fillStyle value, such as\r\n * a color (in hex, rgb, rgba, hsl or named values), a gradient or a pattern.\r\n *\r\n * See the [MDN fillStyle docs](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/fillStyle) for more details.\r\n *\r\n * @method Phaser.GameObjects.Text#setFill\r\n * @since 3.0.0\r\n *\r\n * @param {(string|CanvasGradient|CanvasPattern)} color - The text fill style. Can be any valid CanvasRenderingContext `fillStyle` value.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 856, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the fill style to be used by the Text object.\r\rThis can be any valid CanvasRenderingContext2D fillStyle value, such as\ra color (in hex, rgb, rgba, hsl or named values), a gradient or a pattern.\r\rSee 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", "CanvasGradient", "CanvasPattern" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "CanvasGradient" }, { "type": "NameExpression", "name": "CanvasPattern" } ] } }, "description": "The text fill style. Can be any valid CanvasRenderingContext `fillStyle` value.", "name": "color" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setFill", "scope": "instance", "___id": "T000002R017915", "___s": true }, { "comment": "/**\r\n * Set the text fill color.\r\n *\r\n * @method Phaser.GameObjects.Text#setColor\r\n * @since 3.0.0\r\n *\r\n * @param {(string|CanvasGradient|CanvasPattern)} color - The text fill color.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 876, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the text fill color.", "kind": "function", "name": "setColor", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "CanvasGradient", "CanvasPattern" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "CanvasGradient" }, { "type": "NameExpression", "name": "CanvasPattern" } ] } }, "description": "The text fill color.", "name": "color" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setColor", "scope": "instance", "___id": "T000002R017917", "___s": true }, { "comment": "/**\r\n * Set the stroke settings.\r\n *\r\n * @method Phaser.GameObjects.Text#setStroke\r\n * @since 3.0.0\r\n *\r\n * @param {(string|CanvasGradient|CanvasPattern)} color - The stroke color.\r\n * @param {number} thickness - The stroke thickness.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 891, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the stroke settings.", "kind": "function", "name": "setStroke", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "CanvasGradient", "CanvasPattern" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "CanvasGradient" }, { "type": "NameExpression", "name": "CanvasPattern" } ] } }, "description": "The stroke color.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The stroke thickness.", "name": "thickness" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setStroke", "scope": "instance", "___id": "T000002R017919", "___s": true }, { "comment": "/**\r\n * Set the shadow settings.\r\n *\r\n * @method Phaser.GameObjects.Text#setShadow\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The horizontal shadow offset.\r\n * @param {number} [y=0] - The vertical shadow offset.\r\n * @param {string} [color='#000'] - The shadow color.\r\n * @param {number} [blur=0] - The shadow blur radius.\r\n * @param {boolean} [shadowStroke=false] - Whether to stroke the shadow.\r\n * @param {boolean} [shadowFill=true] - Whether to fill the shadow.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 907, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the shadow settings.", "kind": "function", "name": "setShadow", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal shadow offset.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical shadow offset.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'#000'", "description": "The shadow color.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The shadow blur radius.", "name": "blur" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to stroke the shadow.", "name": "shadowStroke" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether to fill the shadow.", "name": "shadowFill" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setShadow", "scope": "instance", "___id": "T000002R017921", "___s": true }, { "comment": "/**\r\n * Set the shadow offset.\r\n *\r\n * @method Phaser.GameObjects.Text#setShadowOffset\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal shadow offset.\r\n * @param {number} y - The vertical shadow offset.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 927, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the shadow offset.", "kind": "function", "name": "setShadowOffset", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal shadow offset.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical shadow offset.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setShadowOffset", "scope": "instance", "___id": "T000002R017923", "___s": true }, { "comment": "/**\r\n * Set the shadow color.\r\n *\r\n * @method Phaser.GameObjects.Text#setShadowColor\r\n * @since 3.0.0\r\n *\r\n * @param {string} color - The shadow color.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 943, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the shadow color.", "kind": "function", "name": "setShadowColor", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The shadow color.", "name": "color" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setShadowColor", "scope": "instance", "___id": "T000002R017925", "___s": true }, { "comment": "/**\r\n * Set the shadow blur radius.\r\n *\r\n * @method Phaser.GameObjects.Text#setShadowBlur\r\n * @since 3.0.0\r\n *\r\n * @param {number} blur - The shadow blur radius.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 958, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the shadow blur radius.", "kind": "function", "name": "setShadowBlur", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The shadow blur radius.", "name": "blur" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setShadowBlur", "scope": "instance", "___id": "T000002R017927", "___s": true }, { "comment": "/**\r\n * Enable or disable shadow stroke.\r\n *\r\n * @method Phaser.GameObjects.Text#setShadowStroke\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} enabled - Whether shadow stroke is enabled or not.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 973, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Enable or disable shadow stroke.", "kind": "function", "name": "setShadowStroke", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether shadow stroke is enabled or not.", "name": "enabled" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setShadowStroke", "scope": "instance", "___id": "T000002R017929", "___s": true }, { "comment": "/**\r\n * Enable or disable shadow fill.\r\n *\r\n * @method Phaser.GameObjects.Text#setShadowFill\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} enabled - Whether shadow fill is enabled or not.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 988, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Enable or disable shadow fill.", "kind": "function", "name": "setShadowFill", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether shadow fill is enabled or not.", "name": "enabled" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setShadowFill", "scope": "instance", "___id": "T000002R017931", "___s": true }, { "comment": "/**\r\n * Set the width (in pixels) to use for wrapping lines. Pass in null to remove wrapping by width.\r\n *\r\n * @method Phaser.GameObjects.Text#setWordWrapWidth\r\n * @since 3.0.0\r\n *\r\n * @param {number | null} width - The maximum width of a line in pixels. Set to null to remove wrapping.\r\n * @param {boolean} [useAdvancedWrap=false] - Whether or not to use the advanced wrapping\r\n * algorithm. If true, spaces are collapsed and whitespace is trimmed from lines. If false,\r\n * spaces and whitespace are left as is.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 1003, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "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", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NullLiteral" } ] } }, "description": "The maximum width of a line in pixels. Set to null to remove wrapping.", "name": "width" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether or not to use the advanced wrapping\ralgorithm. If true, spaces are collapsed and whitespace is trimmed from lines. If false,\rspaces and whitespace are left as is.", "name": "useAdvancedWrap" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setWordWrapWidth", "scope": "instance", "___id": "T000002R017933", "___s": true }, { "comment": "/**\r\n * Set a custom callback for wrapping lines. Pass in null to remove wrapping by callback.\r\n *\r\n * @method Phaser.GameObjects.Text#setWordWrapCallback\r\n * @since 3.0.0\r\n *\r\n * @param {TextStyleWordWrapCallback} callback - A custom function that will be responsible for wrapping the\r\n * text. It will receive two arguments: text (the string to wrap), textObject (this Text\r\n * instance). It should return the wrapped lines either as an array of lines or as a string with\r\n * newline characters in place to indicate where breaks should happen.\r\n * @param {object} [scope=null] - The scope that will be applied when the callback is invoked.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 1021, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "TextStyleWordWrapCallback" } }, "description": "A custom function that will be responsible for wrapping the\rtext. It will receive two arguments: text (the string to wrap), textObject (this Text\rinstance). It should return the wrapped lines either as an array of lines or as a string with\rnewline characters in place to indicate where breaks should happen.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "defaultvalue": null, "description": "The scope that will be applied when the callback is invoked.", "name": "scope" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setWordWrapCallback", "scope": "instance", "___id": "T000002R017935", "___s": true }, { "comment": "/**\r\n * Set the alignment of the text in this Text object.\r\n *\r\n * The argument can be one of: `left`, `right`, `center` or `justify`.\r\n *\r\n * Alignment only works if the Text object has more than one line of text.\r\n *\r\n * @method Phaser.GameObjects.Text#setAlign\r\n * @since 3.0.0\r\n *\r\n * @param {string} [align='left'] - The text alignment for multi-line text.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 1040, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the alignment of the text in this Text object.\r\rThe argument can be one of: `left`, `right`, `center` or `justify`.\r\rAlignment 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'left'", "description": "The text alignment for multi-line text.", "name": "align" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setAlign", "scope": "instance", "___id": "T000002R017937", "___s": true }, { "comment": "/**\r\n * Set the resolution of the Texture used by this Text object.\r\n *\r\n * Setting resolution above 1 is useful only if you're scaling up this Text object (or an ancestor) or zooming a Camera on it.\r\n * Otherwise, any extra detail in the Texture would just be lost during rendering.\r\n *\r\n * Please use with caution, as the more high-resolution Text you have, the more memory it uses.\r\n *\r\n * @method Phaser.GameObjects.Text#setResolution\r\n * @since 3.12.0\r\n *\r\n * @param {number} value - The resolution for this Text object to use, relative to 1.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 1059, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the resolution of the Texture used by this Text object.\r\rSetting resolution above 1 is useful only if you're scaling up this Text object (or an ancestor) or zooming a Camera on it.\rOtherwise, any extra detail in the Texture would just be lost during rendering.\r\rPlease use with caution, as the more high-resolution Text you have, the more memory it uses.", "kind": "function", "name": "setResolution", "since": "3.12.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resolution for this Text object to use, relative to 1.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setResolution", "scope": "instance", "___id": "T000002R017939", "___s": true }, { "comment": "/**\r\n * Sets the line spacing value.\r\n *\r\n * This value is _added_ to the height of the font when calculating the overall line height.\r\n * This only has an effect if this Text object consists of multiple lines of text.\r\n *\r\n * @method Phaser.GameObjects.Text#setLineSpacing\r\n * @since 3.13.0\r\n *\r\n * @param {number} value - The amount to add to the font height to achieve the overall line height.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 1079, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Sets the line spacing value.\r\rThis value is _added_ to the height of the font when calculating the overall line height.\rThis 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to add to the font height to achieve the overall line height.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setLineSpacing", "scope": "instance", "___id": "T000002R017941", "___s": true }, { "comment": "/**\r\n * Sets the letter spacing value.\r\n *\r\n * This will add, or remove spacing between each character of this Text Game Object. The value can be\r\n * either positive or negative. Positive values increase the space between each character, whilst negative\r\n * values decrease it. Note that some fonts are spaced naturally closer together than others.\r\n *\r\n * Please understand that enabling this feature will cause Phaser to render each character in this Text object\r\n * one by one, rather than use a draw for the whole string. This makes it extremely expensive when used with\r\n * either long strings, or lots of strings in total. You will be better off creating bitmap font text if you\r\n * need to display large quantities of characters with fine control over the letter spacing.\r\n *\r\n * @method Phaser.GameObjects.Text#setLetterSpacing\r\n * @since 3.70.0\r\n *\r\n * @param {number} value - The amount to add to the letter width. Set to zero to disable.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 1099, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Sets the letter spacing value.\r\rThis will add, or remove spacing between each character of this Text Game Object. The value can be\reither positive or negative. Positive values increase the space between each character, whilst negative\rvalues decrease it. Note that some fonts are spaced naturally closer together than others.\r\rPlease understand that enabling this feature will cause Phaser to render each character in this Text object\rone by one, rather than use a draw for the whole string. This makes it extremely expensive when used with\reither long strings, or lots of strings in total. You will be better off creating bitmap font text if you\rneed to display large quantities of characters with fine control over the letter spacing.", "kind": "function", "name": "setLetterSpacing", "since": "3.70.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to add to the letter width. Set to zero to disable.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setLetterSpacing", "scope": "instance", "___id": "T000002R017944", "___s": true }, { "comment": "/**\r\n * Sets the padding applied around the text content when calculating the canvas size.\r\n *\r\n * The first argument can be either a number or a padding configuration object. When a number\r\n * is given, it is applied to all four sides unless the other arguments override them. When an\r\n * object is given, you can specify `left`, `right`, `top`, and `bottom` individually, or use\r\n * `x` to set both left and right simultaneously, and `y` to set both top and bottom.\r\n *\r\n * @method Phaser.GameObjects.Text#setPadding\r\n * @since 3.0.0\r\n *\r\n * @param {(number|Phaser.Types.GameObjects.Text.TextPadding)} left - The left padding value, or a padding config object.\r\n * @param {number} [top] - The top padding value.\r\n * @param {number} [right] - The right padding value.\r\n * @param {number} [bottom] - The bottom padding value.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 1125, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Sets the padding applied around the text content when calculating the canvas size.\r\rThe first argument can be either a number or a padding configuration object. When a number\ris given, it is applied to all four sides unless the other arguments override them. When an\robject is given, you can specify `left`, `right`, `top`, and `bottom` individually, or use\r`x` to set both left and right simultaneously, and `y` to set both top and bottom.", "kind": "function", "name": "setPadding", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "Phaser.Types.GameObjects.Text.TextPadding" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextPadding" } ] } }, "description": "The left padding value, or a padding config object.", "name": "left" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The top padding value.", "name": "top" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The right padding value.", "name": "right" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The bottom padding value.", "name": "bottom" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setPadding", "scope": "instance", "___id": "T000002R017947", "___s": true }, { "comment": "/**\r\n * Set the maximum number of lines to draw.\r\n *\r\n * @method Phaser.GameObjects.Text#setMaxLines\r\n * @since 3.0.0\r\n *\r\n * @param {number} [max=0] - The maximum number of lines to draw.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 1192, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the maximum number of lines to draw.", "kind": "function", "name": "setMaxLines", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The maximum number of lines to draw.", "name": "max" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setMaxLines", "scope": "instance", "___id": "T000002R017968", "___s": true }, { "comment": "/**\r\n * Render text from right-to-left or left-to-right.\r\n *\r\n * @method Phaser.GameObjects.Text#setRTL\r\n * @since 3.70.0\r\n *\r\n * @param {boolean} [rtl=true] - Set to `true` to render from right-to-left.\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 1207, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Render text from right-to-left or left-to-right.", "kind": "function", "name": "setRTL", "since": "3.70.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Set to `true` to render from right-to-left.", "name": "rtl" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#setRTL", "scope": "instance", "___id": "T000002R017970", "___s": true }, { "comment": "/**\r\n * Recalculates and re-renders the text content onto the internal canvas. This is called\r\n * automatically whenever the text string or any style property changes. It handles word\r\n * wrapping, text sizing, multi-line layout, alignment, shadows, stroke, and letter spacing.\r\n * If the renderer is WebGL, the updated canvas is re-uploaded to the GPU as a new texture.\r\n * You should call this manually only if you have updated `lineSpacing` or `letterSpacing`\r\n * directly without using their corresponding setter methods.\r\n *\r\n * @method Phaser.GameObjects.Text#updateText\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 1256, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Recalculates and re-renders the text content onto the internal canvas. This is called\rautomatically whenever the text string or any style property changes. It handles word\rwrapping, text sizing, multi-line layout, alignment, shadows, stroke, and letter spacing.\rIf the renderer is WebGL, the updated canvas is re-uploaded to the GPU as a new texture.\rYou should call this manually only if you have updated `lineSpacing` or `letterSpacing`\rdirectly without using their corresponding setter methods.", "kind": "function", "name": "updateText", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Text object." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#updateText", "scope": "instance", "___id": "T000002R017982", "___s": true }, { "comment": "/**\r\n * Get the current text metrics.\r\n *\r\n * @method Phaser.GameObjects.Text#getTextMetrics\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.GameObjects.Text.TextMetrics} The text metrics.\r\n */", "meta": { "filename": "Text.js", "lineno": 1505, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Get the current text metrics.", "kind": "function", "name": "getTextMetrics", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.Text.TextMetrics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextMetrics" } }, "description": "The text metrics." } ], "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#getTextMetrics", "scope": "instance", "___id": "T000002R018046", "___s": true }, { "comment": "/**\r\n * The text string being rendered by this Text Game Object.\r\n *\r\n * @name Phaser.GameObjects.Text#text\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Text.js", "lineno": 1518, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The text string being rendered by this Text Game Object.", "name": "text", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#text", "scope": "instance", "kind": "member", "___id": "T000002R018048", "___s": true }, { "comment": "/**\r\n * Build a JSON representation of the Text object.\r\n *\r\n * @method Phaser.GameObjects.Text#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.GameObjects.JSONGameObject} A JSON representation of the Text object.\r\n */", "meta": { "filename": "Text.js", "lineno": 1539, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Build a JSON representation of the Text object.", "kind": "function", "name": "toJSON", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.JSONGameObject" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R018052", "___s": true }, { "comment": "/**\r\n * Internal destroy handler, called as part of the destroy process.\r\n *\r\n * @method Phaser.GameObjects.Text#preDestroy\r\n * @protected\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Text.js", "lineno": 1570, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Internal destroy handler, called as part of the destroy process.", "kind": "function", "name": "preDestroy", "access": "protected", "since": "3.0.0", "memberof": "Phaser.GameObjects.Text", "longname": "Phaser.GameObjects.Text#preDestroy", "scope": "instance", "___id": "T000002R018065", "___s": true }, { "comment": "/**\r\n * Creates a new Text Game Object and returns it.\r\n *\r\n * A Text Game Object renders a string of text to an internal Canvas texture, which is then\r\n * used as the source for rendering to the game canvas. It supports a wide range of styling\r\n * options including font family, size, weight, fill color, stroke, drop shadow, text alignment,\r\n * word wrapping, padding, fixed dimensions, and right-to-left rendering. The text content and\r\n * style can be updated at any time after creation.\r\n *\r\n * Unlike the factory method (`scene.add.text`), this creator method returns the Text Game Object\r\n * without automatically adding it to the Scene's display list. Use the `add` property in the\r\n * config object, or pass `true` as the `addToScene` argument, to add it to the Scene.\r\n *\r\n * Note: This method will only be available if the Text Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#text\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Text.TextConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Text} The Game Object that was created.\r\n */", "meta": { "filename": "TextCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Creates a new Text Game Object and returns it.\r\rA Text Game Object renders a string of text to an internal Canvas texture, which is then\rused as the source for rendering to the game canvas. It supports a wide range of styling\roptions including font family, size, weight, fill color, stroke, drop shadow, text alignment,\rword wrapping, padding, fixed dimensions, and right-to-left rendering. The text content and\rstyle can be updated at any time after creation.\r\rUnlike the factory method (`scene.add.text`), this creator method returns the Text Game Object\rwithout automatically adding it to the Scene's display list. Use the `add` property in the\rconfig object, or pass `true` as the `addToScene` argument, to add it to the Scene.\r\rNote: 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": [ "Phaser.Types.GameObjects.Text.TextConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#text", "scope": "instance", "___id": "T000002R018076", "___s": true }, { "comment": "/**\r\n * Creates a new Text Game Object and adds it to the Scene.\r\n *\r\n * The Text object renders one or more lines of styled text to an internal hidden Canvas, which is\r\n * then uploaded as a texture and displayed within the Scene.\r\n *\r\n * Text objects work by creating their own internal hidden Canvas and then renders text to it using\r\n * the standard Canvas `fillText` API. It then creates a texture from this canvas which is rendered\r\n * to your game during the render pass.\r\n *\r\n * Because it uses the Canvas API you can take advantage of all the features this offers, such as\r\n * applying gradient fills to the text, or strokes, shadows and more. You can also use custom fonts\r\n * loaded externally, such as Google or TypeKit Web fonts.\r\n *\r\n * You can only display fonts that are currently loaded and available to the browser: therefore fonts must\r\n * be pre-loaded. Phaser does not do this for you, so you will require the use of a 3rd party font loader,\r\n * or have the fonts already available in the CSS on the page in which your Phaser game resides.\r\n *\r\n * See {@link http://www.jordanm.co.uk/tinytype this compatibility table} for the available default fonts\r\n * across mobile browsers.\r\n *\r\n * A note on performance: Every time the contents of a Text object changes, i.e. changing the text being\r\n * displayed, or the style of the text, it needs to remake the Text canvas, and if on WebGL, re-upload the\r\n * new texture to the GPU. This can be an expensive operation if used often, or with large quantities of\r\n * Text objects in your game. If you run into performance issues you would be better off using Bitmap Text\r\n * instead, as it benefits from batching and avoids expensive Canvas API calls.\r\n *\r\n * Note: This method will only be available if the Text Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#text\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {(string|string[])} text - The text this Text object will display.\r\n * @param {Phaser.Types.GameObjects.Text.TextStyle} [style] - The Text style configuration object.\r\n *\r\n * @return {Phaser.GameObjects.Text} The Game Object that was created.\r\n */", "meta": { "filename": "TextFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Creates a new Text Game Object and adds it to the Scene.\r\rThe Text object renders one or more lines of styled text to an internal hidden Canvas, which is\rthen uploaded as a texture and displayed within the Scene.\r\rText objects work by creating their own internal hidden Canvas and then renders text to it using\rthe standard Canvas `fillText` API. It then creates a texture from this canvas which is rendered\rto your game during the render pass.\r\rBecause it uses the Canvas API you can take advantage of all the features this offers, such as\rapplying gradient fills to the text, or strokes, shadows and more. You can also use custom fonts\rloaded externally, such as Google or TypeKit Web fonts.\r\rYou can only display fonts that are currently loaded and available to the browser: therefore fonts must\rbe pre-loaded. Phaser does not do this for you, so you will require the use of a 3rd party font loader,\ror have the fonts already available in the CSS on the page in which your Phaser game resides.\r\rSee {@link http://www.jordanm.co.uk/tinytype this compatibility table} for the available default fonts\racross mobile browsers.\r\rA note on performance: Every time the contents of a Text object changes, i.e. changing the text being\rdisplayed, or the style of the text, it needs to remake the Text canvas, and if on WebGL, re-upload the\rnew texture to the GPU. This can be an expensive operation if used often, or with large quantities of\rText objects in your game. If you run into performance issues you would be better off using Bitmap Text\rinstead, as it benefits from batching and avoids expensive Canvas API calls.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "description": "The text this Text object will display.", "name": "text" }, { "type": { "names": [ "Phaser.Types.GameObjects.Text.TextStyle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextStyle" } }, "optional": true, "description": "The Text style configuration object.", "name": "style" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#text", "scope": "instance", "___id": "T000002R018088", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A TextStyle class manages all of the style settings for a Text object.\r\n *\r\n * Text Game Objects create a TextStyle instance automatically, which is\r\n * accessed via the `Text.style` property. You do not normally need to\r\n * instantiate one yourself.\r\n *\r\n * @class TextStyle\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.Text} text - The Text object that this TextStyle is styling.\r\n * @param {Phaser.Types.GameObjects.Text.TextStyle} style - The style settings to set.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 43, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "classdesc": "A TextStyle class manages all of the style settings for a Text object.\r\rText Game Objects create a TextStyle instance automatically, which is\raccessed via the `Text.style` property. You do not normally need to\rinstantiate one yourself.", "kind": "class", "name": "TextStyle", "memberof": "Phaser.GameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The Text object that this TextStyle is styling.", "name": "text" }, { "type": { "names": [ "Phaser.Types.GameObjects.Text.TextStyle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextStyle" } }, "description": "The style settings to set.", "name": "style" } ], "scope": "static", "longname": "Phaser.GameObjects.TextStyle", "___id": "T000002R018128", "___s": true }, { "comment": "/**\r\n * The Text object that this TextStyle is styling.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#parent\r\n * @type {Phaser.GameObjects.Text}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The Text object that this TextStyle is styling.", "name": "parent", "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#parent", "scope": "instance", "kind": "member", "___id": "T000002R018131", "___s": true }, { "comment": "/**\r\n * The font family.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#fontFamily\r\n * @type {string}\r\n * @default 'Courier'\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The font family.", "name": "fontFamily", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "'Courier'", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#fontFamily", "scope": "instance", "kind": "member", "___id": "T000002R018133", "___s": true }, { "comment": "/**\r\n * The font size.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#fontSize\r\n * @type {(string|number)}\r\n * @default '16px'\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The font size.", "name": "fontSize", "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "defaultvalue": "'16px'", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#fontSize", "scope": "instance", "kind": "member", "___id": "T000002R018135", "___s": true }, { "comment": "/**\r\n * The font style.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#fontStyle\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 94, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The font style.", "name": "fontStyle", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#fontStyle", "scope": "instance", "kind": "member", "___id": "T000002R018137", "___s": true }, { "comment": "/**\r\n * The background color.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#backgroundColor\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 103, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The background color.", "name": "backgroundColor", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#backgroundColor", "scope": "instance", "kind": "member", "___id": "T000002R018139", "___s": true }, { "comment": "/**\r\n * The text fill color.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#color\r\n * @type {(string|CanvasGradient|CanvasPattern)}\r\n * @default '#fff'\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 112, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The text fill color.", "name": "color", "type": { "names": [ "string", "CanvasGradient", "CanvasPattern" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "CanvasGradient" }, { "type": "NameExpression", "name": "CanvasPattern" } ] } }, "defaultvalue": "'#fff'", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#color", "scope": "instance", "kind": "member", "___id": "T000002R018141", "___s": true }, { "comment": "/**\r\n * The text stroke color.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#stroke\r\n * @type {(string|CanvasGradient|CanvasPattern)}\r\n * @default '#fff'\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The text stroke color.", "name": "stroke", "type": { "names": [ "string", "CanvasGradient", "CanvasPattern" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "CanvasGradient" }, { "type": "NameExpression", "name": "CanvasPattern" } ] } }, "defaultvalue": "'#fff'", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#stroke", "scope": "instance", "kind": "member", "___id": "T000002R018143", "___s": true }, { "comment": "/**\r\n * The text stroke thickness.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#strokeThickness\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The text stroke thickness.", "name": "strokeThickness", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#strokeThickness", "scope": "instance", "kind": "member", "___id": "T000002R018145", "___s": true }, { "comment": "/**\r\n * The horizontal shadow offset.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#shadowOffsetX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The horizontal shadow offset.", "name": "shadowOffsetX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#shadowOffsetX", "scope": "instance", "kind": "member", "___id": "T000002R018147", "___s": true }, { "comment": "/**\r\n * The vertical shadow offset.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#shadowOffsetY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The vertical shadow offset.", "name": "shadowOffsetY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#shadowOffsetY", "scope": "instance", "kind": "member", "___id": "T000002R018149", "___s": true }, { "comment": "/**\r\n * The shadow color.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#shadowColor\r\n * @type {string}\r\n * @default '#000'\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The shadow color.", "name": "shadowColor", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "'#000'", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#shadowColor", "scope": "instance", "kind": "member", "___id": "T000002R018151", "___s": true }, { "comment": "/**\r\n * The shadow blur radius.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#shadowBlur\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 172, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The shadow blur radius.", "name": "shadowBlur", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#shadowBlur", "scope": "instance", "kind": "member", "___id": "T000002R018153", "___s": true }, { "comment": "/**\r\n * Whether shadow stroke is enabled or not.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#shadowStroke\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Whether shadow stroke is enabled or not.", "name": "shadowStroke", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#shadowStroke", "scope": "instance", "kind": "member", "___id": "T000002R018155", "___s": true }, { "comment": "/**\r\n * Whether shadow fill is enabled or not.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#shadowFill\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 192, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Whether shadow fill is enabled or not.", "name": "shadowFill", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#shadowFill", "scope": "instance", "kind": "member", "___id": "T000002R018157", "___s": true }, { "comment": "/**\r\n * The text alignment.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#align\r\n * @type {string}\r\n * @default 'left'\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 202, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The text alignment.", "name": "align", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "'left'", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#align", "scope": "instance", "kind": "member", "___id": "T000002R018159", "___s": true }, { "comment": "/**\r\n * The maximum number of lines to draw.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#maxLines\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 212, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The maximum number of lines to draw.", "name": "maxLines", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#maxLines", "scope": "instance", "kind": "member", "___id": "T000002R018161", "___s": true }, { "comment": "/**\r\n * The fixed width of the text.\r\n *\r\n * `0` means no fixed width.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#fixedWidth\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 222, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The fixed width of the text.\r\r`0` means no fixed width.", "name": "fixedWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#fixedWidth", "scope": "instance", "kind": "member", "___id": "T000002R018163", "___s": true }, { "comment": "/**\r\n * The fixed height of the text.\r\n *\r\n * `0` means no fixed height.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#fixedHeight\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The fixed height of the text.\r\r`0` means no fixed height.", "name": "fixedHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#fixedHeight", "scope": "instance", "kind": "member", "___id": "T000002R018165", "___s": true }, { "comment": "/**\r\n * The resolution the text is rendered to its internal canvas at.\r\n * The default is 0, which means it will use the resolution set in the Game Config.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#resolution\r\n * @type {number}\r\n * @default 0\r\n * @since 3.12.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 246, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The resolution the text is rendered to its internal canvas at.\rThe default is 0, which means it will use the resolution set in the Game Config.", "name": "resolution", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.12.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#resolution", "scope": "instance", "kind": "member", "___id": "T000002R018167", "___s": true }, { "comment": "/**\r\n * Whether the text should render right to left.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#rtl\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 257, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Whether the text should render right to left.", "name": "rtl", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#rtl", "scope": "instance", "kind": "member", "___id": "T000002R018169", "___s": true }, { "comment": "/**\r\n * The test string to use when measuring the font.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#testString\r\n * @type {string}\r\n * @default '|MÉqgy'\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 267, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The test string to use when measuring the font.", "name": "testString", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "defaultvalue": "'|MÉqgy'", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#testString", "scope": "instance", "kind": "member", "___id": "T000002R018171", "___s": true }, { "comment": "/**\r\n * The amount of horizontal padding added to the width of the text when calculating the font metrics.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#baselineX\r\n * @type {number}\r\n * @default 1.2\r\n * @since 3.3.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 277, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The amount of horizontal padding added to the width of the text when calculating the font metrics.", "name": "baselineX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1.2", "since": "3.3.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#baselineX", "scope": "instance", "kind": "member", "___id": "T000002R018173", "___s": true }, { "comment": "/**\r\n * The amount of vertical padding added to the height of the text when calculating the font metrics.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#baselineY\r\n * @type {number}\r\n * @default 1.4\r\n * @since 3.3.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 287, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The amount of vertical padding added to the height of the text when calculating the font metrics.", "name": "baselineY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1.4", "since": "3.3.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#baselineY", "scope": "instance", "kind": "member", "___id": "T000002R018175", "___s": true }, { "comment": "/**\r\n * The maximum width of a line of text in pixels. Null means no line wrapping. Setting this\r\n * property directly will not re-run the word wrapping algorithm. To change the width and\r\n * re-wrap, use {@link Phaser.GameObjects.TextStyle#setWordWrapWidth}.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#wordWrapWidth\r\n * @type {number | null}\r\n * @default null\r\n * @since 3.24.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 297, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The maximum width of a line of text in pixels. Null means no line wrapping. Setting this\rproperty directly will not re-run the word wrapping algorithm. To change the width and\rre-wrap, use {@link Phaser.GameObjects.TextStyle#setWordWrapWidth}.", "name": "wordWrapWidth", "type": { "names": [ "number", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NullLiteral" } ] } }, "defaultvalue": "null", "since": "3.24.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#wordWrapWidth", "scope": "instance", "kind": "member", "___id": "T000002R018177", "___s": true }, { "comment": "/**\r\n * A custom function that will be responsible for wrapping the text. It will receive two\r\n * arguments: text (the string to wrap), textObject (this Text instance). It should return\r\n * the wrapped lines either as an array of lines or as a string with newline characters in\r\n * place to indicate where breaks should happen. Setting this directly will not re-run the\r\n * word wrapping algorithm. To change the callback and re-wrap, use\r\n * {@link Phaser.GameObjects.TextStyle#setWordWrapCallback}.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#wordWrapCallback\r\n * @type {TextStyleWordWrapCallback | null}\r\n * @default null\r\n * @since 3.24.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 309, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "A custom function that will be responsible for wrapping the text. It will receive two\rarguments: text (the string to wrap), textObject (this Text instance). It should return\rthe wrapped lines either as an array of lines or as a string with newline characters in\rplace to indicate where breaks should happen. Setting this directly will not re-run the\rword wrapping algorithm. To change the callback and re-wrap, use\r{@link Phaser.GameObjects.TextStyle#setWordWrapCallback}.", "name": "wordWrapCallback", "type": { "names": [ "TextStyleWordWrapCallback", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "TextStyleWordWrapCallback" }, { "type": "NullLiteral" } ] } }, "defaultvalue": "null", "since": "3.24.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#wordWrapCallback", "scope": "instance", "kind": "member", "___id": "T000002R018179", "___s": true }, { "comment": "/**\r\n * The scope that will be applied when the wordWrapCallback is invoked. Setting this directly will not re-run the\r\n * word wrapping algorithm. To change the callback and re-wrap, use\r\n * {@link Phaser.GameObjects.TextStyle#setWordWrapCallback}.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#wordWrapCallbackScope\r\n * @type {object | null}\r\n * @default null\r\n * @since 3.24.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 324, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "The scope that will be applied when the wordWrapCallback is invoked. Setting this directly will not re-run the\rword wrapping algorithm. To change the callback and re-wrap, use\r{@link Phaser.GameObjects.TextStyle#setWordWrapCallback}.", "name": "wordWrapCallbackScope", "type": { "names": [ "object", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NullLiteral" } ] } }, "defaultvalue": "null", "since": "3.24.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#wordWrapCallbackScope", "scope": "instance", "kind": "member", "___id": "T000002R018181", "___s": true }, { "comment": "/**\r\n * Whether or not to use the advanced wrapping algorithm. If true, spaces are collapsed and\r\n * whitespace is trimmed from lines. If false, spaces and whitespace are left as is. Setting\r\n * this property directly will not re-run the word wrapping algorithm. To change the\r\n * advanced setting and re-wrap, use {@link Phaser.GameObjects.TextStyle#setWordWrapWidth}.\r\n *\r\n * @name Phaser.GameObjects.TextStyle#wordWrapUseAdvanced\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.24.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 336, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Whether or not to use the advanced wrapping algorithm. If true, spaces are collapsed and\rwhitespace is trimmed from lines. If false, spaces and whitespace are left as is. Setting\rthis property directly will not re-run the word wrapping algorithm. To change the\radvanced setting and re-wrap, use {@link Phaser.GameObjects.TextStyle#setWordWrapWidth}.", "name": "wordWrapUseAdvanced", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.24.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#wordWrapUseAdvanced", "scope": "instance", "kind": "member", "___id": "T000002R018183", "___s": true }, { "comment": "/**\r\n * Set the text style.\r\n *\r\n * @example\r\n * text.setStyle({\r\n * fontSize: '64px',\r\n * fontFamily: 'Arial',\r\n * color: '#ffffff',\r\n * align: 'center',\r\n * backgroundColor: '#ff00ff'\r\n * });\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setStyle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Text.TextStyle} style - The style settings to set.\r\n * @param {boolean} [updateText=true] - Whether to update the text immediately.\r\n * @param {boolean} [setDefaults=false] - Use the default values if not set, or the local values.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 363, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the text style.", "examples": [ "text.setStyle({\r fontSize: '64px',\r fontFamily: 'Arial',\r color: '#ffffff',\r align: 'center',\r backgroundColor: '#ff00ff'\r});" ], "kind": "function", "name": "setStyle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Types.GameObjects.Text.TextStyle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextStyle" } }, "description": "The style settings to set.", "name": "style" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether to update the text immediately.", "name": "updateText" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Use the default values if not set, or the local values.", "name": "setDefaults" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setStyle", "scope": "instance", "___id": "T000002R018187", "___s": true }, { "comment": "/**\r\n * Synchronize the font settings to the given Canvas Rendering Context.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#syncFont\r\n * @since 3.0.0\r\n *\r\n * @param {HTMLCanvasElement} canvas - The Canvas Element.\r\n * @param {CanvasRenderingContext2D} context - The Canvas Rendering Context.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 453, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Synchronize the font settings to the given Canvas Rendering Context.", "kind": "function", "name": "syncFont", "since": "3.0.0", "params": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The Canvas Element.", "name": "canvas" }, { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "description": "The Canvas Rendering Context.", "name": "context" } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#syncFont", "scope": "instance", "___id": "T000002R018206", "___s": true }, { "comment": "/**\r\n * Synchronize the text style settings to the given Canvas Rendering Context.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#syncStyle\r\n * @since 3.0.0\r\n *\r\n * @param {HTMLCanvasElement} canvas - The Canvas Element.\r\n * @param {CanvasRenderingContext2D} context - The Canvas Rendering Context.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 467, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Synchronize the text style settings to the given Canvas Rendering Context.", "kind": "function", "name": "syncStyle", "since": "3.0.0", "params": [ { "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "description": "The Canvas Element.", "name": "canvas" }, { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "description": "The Canvas Rendering Context.", "name": "context" } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#syncStyle", "scope": "instance", "___id": "T000002R018209", "___s": true }, { "comment": "/**\r\n * Synchronize the shadow settings to the given Canvas Rendering Context.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#syncShadow\r\n * @since 3.0.0\r\n *\r\n * @param {CanvasRenderingContext2D} context - The Canvas Rendering Context.\r\n * @param {boolean} enabled - Whether shadows are enabled or not.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 488, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Synchronize the shadow settings to the given Canvas Rendering Context.", "kind": "function", "name": "syncShadow", "since": "3.0.0", "params": [ { "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "description": "The Canvas Rendering Context.", "name": "context" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether shadows are enabled or not.", "name": "enabled" } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#syncShadow", "scope": "instance", "___id": "T000002R018217", "___s": true }, { "comment": "/**\r\n * Update the style settings for the parent Text object.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#update\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} recalculateMetrics - Whether to recalculate font and text metrics.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 515, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Update the style settings for the parent Text object.", "kind": "function", "name": "update", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether to recalculate font and text metrics.", "name": "recalculateMetrics" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#update", "scope": "instance", "___id": "T000002R018227", "___s": true }, { "comment": "/**\r\n * Set the font.\r\n *\r\n * If a string is given, the font family is set.\r\n *\r\n * If an object is given, the `fontFamily`, `fontSize` and `fontStyle`\r\n * properties of that object are set.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setFont\r\n * @since 3.0.0\r\n *\r\n * @param {(string|object)} font - The font family or font settings to set.\r\n * @param {boolean} [updateText=true] - Whether to update the text immediately.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 537, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the font.\r\rIf a string is given, the font family is set.\r\rIf an object is given, the `fontFamily`, `fontSize` and `fontStyle`\rproperties of that object are set.", "kind": "function", "name": "setFont", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The font family or font settings to set.", "name": "font" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether to update the text immediately.", "name": "updateText" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setFont", "scope": "instance", "___id": "T000002R018231", "___s": true }, { "comment": "/**\r\n * Set the font family. This should be a valid CSS font-family value, such as `'Arial'`, `'verdana'`, or `'Courier'`. Font names with spaces should be wrapped in single quotes, e.g. `'Comic Sans MS'`.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setFontFamily\r\n * @since 3.0.0\r\n *\r\n * @param {string} family - The font family.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 593, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the font family. This should be a valid CSS font-family value, such as `'Arial'`, `'verdana'`, or `'Courier'`. Font names with spaces should be wrapped in single quotes, e.g. `'Comic Sans MS'`.", "kind": "function", "name": "setFontFamily", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The font family.", "name": "family" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setFontFamily", "scope": "instance", "___id": "T000002R018248", "___s": true }, { "comment": "/**\r\n * Set the font style, such as `'bold'`, `'italic'`, or `'bold italic'`. Use an empty string to clear the style.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setFontStyle\r\n * @since 3.0.0\r\n *\r\n * @param {string} style - The font style.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 615, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the font style, such as `'bold'`, `'italic'`, or `'bold italic'`. Use an empty string to clear the style.", "kind": "function", "name": "setFontStyle", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The font style.", "name": "style" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setFontStyle", "scope": "instance", "___id": "T000002R018251", "___s": true }, { "comment": "/**\r\n * Set the font size. Can be a string with a valid CSS unit, i.e. `16px`, or a number.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setFontSize\r\n * @since 3.0.0\r\n *\r\n * @param {(number|string)} size - The font size.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 637, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the font size. Can be a string with a valid CSS unit, i.e. `16px`, or a number.", "kind": "function", "name": "setFontSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "The font size.", "name": "size" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setFontSize", "scope": "instance", "___id": "T000002R018254", "___s": true }, { "comment": "/**\r\n * Set the test string to use when measuring the font.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setTestString\r\n * @since 3.0.0\r\n *\r\n * @param {string} string - The test string to use when measuring the font.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 664, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the test string to use when measuring the font.", "kind": "function", "name": "setTestString", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The test string to use when measuring the font.", "name": "string" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setTestString", "scope": "instance", "___id": "T000002R018258", "___s": true }, { "comment": "/**\r\n * Set a fixed width and height for the text.\r\n *\r\n * Pass in `0` for either of these parameters to disable fixed width or height respectively.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setFixedSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The fixed width to set.\r\n * @param {number} height - The fixed height to set.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 681, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set a fixed width and height for the text.\r\rPass 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The fixed width to set.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The fixed height to set.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setFixedSize", "scope": "instance", "___id": "T000002R018261", "___s": true }, { "comment": "/**\r\n * Set the background color displayed behind the text. This should be a CSS color string, such as `'#ff0000'` or `'rgba(0,0,0,0.5)'`. Set to `null` to disable.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setBackgroundColor\r\n * @since 3.0.0\r\n *\r\n * @param {string} color - The background color.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 712, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the background color displayed behind the text. This should be a CSS color string, such as `'#ff0000'` or `'rgba(0,0,0,0.5)'`. Set to `null` to disable.", "kind": "function", "name": "setBackgroundColor", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The background color.", "name": "color" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setBackgroundColor", "scope": "instance", "___id": "T000002R018267", "___s": true }, { "comment": "/**\r\n * Set the text fill color. This can be any valid CSS color string such as a hex value `'#ff0000'`, an rgba string, or a named color. It can also be a CanvasGradient or CanvasPattern for more complex fill styles.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setFill\r\n * @since 3.0.0\r\n *\r\n * @param {(string|CanvasGradient|CanvasPattern)} color - The text fill color.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 729, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the text fill color. This can be any valid CSS color string such as a hex value `'#ff0000'`, an rgba string, or a named color. It can also be a CanvasGradient or CanvasPattern for more complex fill styles.", "kind": "function", "name": "setFill", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "CanvasGradient", "CanvasPattern" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "CanvasGradient" }, { "type": "NameExpression", "name": "CanvasPattern" } ] } }, "description": "The text fill color.", "name": "color" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setFill", "scope": "instance", "___id": "T000002R018270", "___s": true }, { "comment": "/**\r\n * Set the text fill color. This can be any valid CSS color string, CanvasGradient, or CanvasPattern.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setColor\r\n * @since 3.0.0\r\n *\r\n * @param {(string|CanvasGradient|CanvasPattern)} color - The text fill color.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 746, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the text fill color. This can be any valid CSS color string, CanvasGradient, or CanvasPattern.", "kind": "function", "name": "setColor", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "CanvasGradient", "CanvasPattern" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "CanvasGradient" }, { "type": "NameExpression", "name": "CanvasPattern" } ] } }, "description": "The text fill color.", "name": "color" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setColor", "scope": "instance", "___id": "T000002R018273", "___s": true }, { "comment": "/**\r\n * Set the resolution used by the Text object.\r\n *\r\n * It allows for much clearer text on High DPI devices, at the cost of memory because\r\n * it uses larger internal Canvas textures for the Text.\r\n *\r\n * Please use with caution, as the more high res Text you have, the more memory it uses up.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setResolution\r\n * @since 3.12.0\r\n *\r\n * @param {number} value - The resolution for this Text object to use.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 763, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the resolution used by the Text object.\r\rIt allows for much clearer text on High DPI devices, at the cost of memory because\rit uses larger internal Canvas textures for the Text.\r\rPlease 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The resolution for this Text object to use.", "name": "value" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setResolution", "scope": "instance", "___id": "T000002R018276", "___s": true }, { "comment": "/**\r\n * Set the stroke settings.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setStroke\r\n * @since 3.0.0\r\n *\r\n * @param {(string|CanvasGradient|CanvasPattern)} color - The stroke color.\r\n * @param {number} thickness - The stroke thickness.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 785, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the stroke settings.", "kind": "function", "name": "setStroke", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "CanvasGradient", "CanvasPattern" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "CanvasGradient" }, { "type": "NameExpression", "name": "CanvasPattern" } ] } }, "description": "The stroke color.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The stroke thickness.", "name": "thickness" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setStroke", "scope": "instance", "___id": "T000002R018279", "___s": true }, { "comment": "/**\r\n * Set the shadow settings.\r\n *\r\n * Calling this method always re-renders the parent Text object,\r\n * so only call it when you actually change the shadow settings.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setShadow\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The horizontal shadow offset.\r\n * @param {number} [y=0] - The vertical shadow offset.\r\n * @param {string} [color='#000'] - The shadow color.\r\n * @param {number} [blur=0] - The shadow blur radius.\r\n * @param {boolean} [shadowStroke=false] - Whether to stroke the shadow.\r\n * @param {boolean} [shadowFill=true] - Whether to fill the shadow.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 818, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the shadow settings.\r\rCalling this method always re-renders the parent Text object,\rso only call it when you actually change the shadow settings.", "kind": "function", "name": "setShadow", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal shadow offset.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical shadow offset.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'#000'", "description": "The shadow color.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The shadow blur radius.", "name": "blur" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether to stroke the shadow.", "name": "shadowStroke" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Whether to fill the shadow.", "name": "shadowFill" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setShadow", "scope": "instance", "___id": "T000002R018285", "___s": true }, { "comment": "/**\r\n * Set the shadow offset.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setShadowOffset\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The horizontal shadow offset.\r\n * @param {number} [y=0] - The vertical shadow offset.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 855, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the shadow offset.", "kind": "function", "name": "setShadowOffset", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal shadow offset.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical shadow offset.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setShadowOffset", "scope": "instance", "___id": "T000002R018299", "___s": true }, { "comment": "/**\r\n * Set the shadow color.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setShadowColor\r\n * @since 3.0.0\r\n *\r\n * @param {string} [color='#000'] - The shadow color.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 877, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the shadow color.", "kind": "function", "name": "setShadowColor", "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'#000'", "description": "The shadow color.", "name": "color" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setShadowColor", "scope": "instance", "___id": "T000002R018305", "___s": true }, { "comment": "/**\r\n * Set the shadow blur radius.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setShadowBlur\r\n * @since 3.0.0\r\n *\r\n * @param {number} [blur=0] - The shadow blur radius.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 896, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the shadow blur radius.", "kind": "function", "name": "setShadowBlur", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The shadow blur radius.", "name": "blur" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setShadowBlur", "scope": "instance", "___id": "T000002R018309", "___s": true }, { "comment": "/**\r\n * Enable or disable shadow stroke.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setShadowStroke\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} enabled - Whether shadow stroke is enabled or not.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 915, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Enable or disable shadow stroke.", "kind": "function", "name": "setShadowStroke", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether shadow stroke is enabled or not.", "name": "enabled" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setShadowStroke", "scope": "instance", "___id": "T000002R018313", "___s": true }, { "comment": "/**\r\n * Enable or disable shadow fill.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setShadowFill\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} enabled - Whether shadow fill is enabled or not.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 932, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Enable or disable shadow fill.", "kind": "function", "name": "setShadowFill", "since": "3.0.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether shadow fill is enabled or not.", "name": "enabled" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setShadowFill", "scope": "instance", "___id": "T000002R018316", "___s": true }, { "comment": "/**\r\n * Set the width (in pixels) to use for wrapping lines.\r\n *\r\n * Pass in null to remove wrapping by width.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setWordWrapWidth\r\n * @since 3.0.0\r\n *\r\n * @param {number | null} width - The maximum width of a line in pixels. Set to null to remove wrapping.\r\n * @param {boolean} [useAdvancedWrap=false] - Whether or not to use the advanced wrapping\r\n * algorithm. If true, spaces are collapsed and whitespace is trimmed from lines. If false,\r\n * spaces and whitespace are left as is.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 949, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the width (in pixels) to use for wrapping lines.\r\rPass in null to remove wrapping by width.", "kind": "function", "name": "setWordWrapWidth", "since": "3.0.0", "params": [ { "type": { "names": [ "number", "null" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NullLiteral" } ] } }, "description": "The maximum width of a line in pixels. Set to null to remove wrapping.", "name": "width" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether or not to use the advanced wrapping\ralgorithm. If true, spaces are collapsed and whitespace is trimmed from lines. If false,\rspaces and whitespace are left as is.", "name": "useAdvancedWrap" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setWordWrapWidth", "scope": "instance", "___id": "T000002R018319", "___s": true }, { "comment": "/**\r\n * Set a custom callback for wrapping lines.\r\n *\r\n * Pass in null to remove wrapping by callback.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setWordWrapCallback\r\n * @since 3.0.0\r\n *\r\n * @param {TextStyleWordWrapCallback} callback - A custom function that will be responsible for wrapping the\r\n * text. It will receive two arguments: text (the string to wrap), textObject (this Text\r\n * instance). It should return the wrapped lines either as an array of lines or as a string with\r\n * newline characters in place to indicate where breaks should happen.\r\n * @param {object} [scope=null] - The scope that will be applied when the callback is invoked.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 974, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set a custom callback for wrapping lines.\r\rPass in null to remove wrapping by callback.", "kind": "function", "name": "setWordWrapCallback", "since": "3.0.0", "params": [ { "type": { "names": [ "TextStyleWordWrapCallback" ], "parsedType": { "type": "NameExpression", "name": "TextStyleWordWrapCallback" } }, "description": "A custom function that will be responsible for wrapping the\rtext. It will receive two arguments: text (the string to wrap), textObject (this Text\rinstance). It should return the wrapped lines either as an array of lines or as a string with\rnewline characters in place to indicate where breaks should happen.", "name": "callback" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setWordWrapCallback", "scope": "instance", "___id": "T000002R018324", "___s": true }, { "comment": "/**\r\n * Set the alignment of the text in this Text object.\r\n *\r\n * The argument can be one of: `left`, `right`, `center` or `justify`.\r\n *\r\n * Alignment only works if the Text object has more than one line of text.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setAlign\r\n * @since 3.0.0\r\n *\r\n * @param {string} [align='left'] - The text alignment for multi-line text.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 1000, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the alignment of the text in this Text object.\r\rThe argument can be one of: `left`, `right`, `center` or `justify`.\r\rAlignment 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'left'", "description": "The text alignment for multi-line text.", "name": "align" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setAlign", "scope": "instance", "___id": "T000002R018329", "___s": true }, { "comment": "/**\r\n * Set the maximum number of lines to draw.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#setMaxLines\r\n * @since 3.0.0\r\n *\r\n * @param {number} [max=0] - The maximum number of lines to draw.\r\n *\r\n * @return {Phaser.GameObjects.Text} The parent Text object.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 1023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Set the maximum number of lines to draw.", "kind": "function", "name": "setMaxLines", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The maximum number of lines to draw.", "name": "max" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The parent Text object." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#setMaxLines", "scope": "instance", "___id": "T000002R018333", "___s": true }, { "comment": "/**\r\n * Get the current text metrics.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#getTextMetrics\r\n * @since 3.0.0\r\n *\r\n * @return {Phaser.Types.GameObjects.Text.TextMetrics} The text metrics.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 1042, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Get the current text metrics.", "kind": "function", "name": "getTextMetrics", "since": "3.0.0", "returns": [ { "type": { "names": [ "Phaser.Types.GameObjects.Text.TextMetrics" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextMetrics" } }, "description": "The text metrics." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#getTextMetrics", "scope": "instance", "___id": "T000002R018337", "___s": true }, { "comment": "/**\r\n * Build a JSON representation of this Text Style.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#toJSON\r\n * @since 3.0.0\r\n *\r\n * @return {object} A JSON representation of this Text Style.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 1061, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Build a JSON representation of this Text Style.", "kind": "function", "name": "toJSON", "since": "3.0.0", "returns": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "A JSON representation of this Text Style." } ], "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#toJSON", "scope": "instance", "___id": "T000002R018343", "___s": true }, { "comment": "/**\r\n * Destroy this Text Style.\r\n *\r\n * @method Phaser.GameObjects.TextStyle#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 1083, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text", "code": {} }, "description": "Destroy this Text Style.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.GameObjects.TextStyle", "longname": "Phaser.GameObjects.TextStyle#destroy", "scope": "instance", "___id": "T000002R018349", "___s": true }, { "comment": "/**\r\n * Results object from a call to GetTextSize.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.Text.GetTextSizeObject\r\n * @since 3.0.0\r\n *\r\n * @property {number} width - The width of the longest line in the Text object.\r\n * @property {number} height - The height of the Text object.\r\n * @property {number} lines - The number of lines in the Text object.\r\n * @property {number[]} lineWidths - An array of the lines for each line in the Text object.\r\n * @property {number} lineSpacing - The line spacing of the Text object.\r\n * @property {number} lineHeight - The height of a line factoring in font and stroke.\r\n */", "meta": { "filename": "GetTextSizeObject.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text\\typedefs", "code": {} }, "description": "Results object from a call to GetTextSize.", "kind": "typedef", "name": "GetTextSizeObject", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the longest line in the Text object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the Text object.", "name": "height" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of lines in the Text object.", "name": "lines" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array of the lines for each line in the Text object.", "name": "lineWidths" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The line spacing of the Text object.", "name": "lineSpacing" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of a line factoring in font and stroke.", "name": "lineHeight" } ], "memberof": "Phaser.Types.GameObjects.Text", "longname": "Phaser.Types.GameObjects.Text.GetTextSizeObject", "scope": "static", "___id": "T000002R018358", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Text\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text\\typedefs", "code": {} }, "kind": "namespace", "name": "Text", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Text", "scope": "static", "___id": "T000002R018359", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Text.TextConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 3.0.0\r\n *\r\n * @property {(string|string[])} [text] - The text this Text object will display.\r\n * @property {Phaser.Types.GameObjects.Text.TextStyle} [style] - The Text style configuration object.\r\n * @property {Phaser.Types.GameObjects.Text.TextPadding} [padding] - A Text Padding object.\r\n */", "meta": { "filename": "TextConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text\\typedefs", "code": {} }, "kind": "typedef", "name": "TextConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "3.0.0", "properties": [ { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The text this Text object will display.", "name": "text" }, { "type": { "names": [ "Phaser.Types.GameObjects.Text.TextStyle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextStyle" } }, "optional": true, "description": "The Text style configuration object.", "name": "style" }, { "type": { "names": [ "Phaser.Types.GameObjects.Text.TextPadding" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextPadding" } }, "optional": true, "description": "A Text Padding object.", "name": "padding" } ], "memberof": "Phaser.Types.GameObjects.Text", "longname": "Phaser.Types.GameObjects.Text.TextConfig", "scope": "static", "___id": "T000002R018360", "___s": true }, { "comment": "/**\r\n * Font metrics for a Text Style object.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.Text.TextMetrics\r\n * @since 3.0.0\r\n *\r\n * @property {number} ascent - The ascent of the font.\r\n * @property {number} descent - The descent of the font.\r\n * @property {number} fontSize - The size of the font.\r\n */", "meta": { "filename": "TextMetrics.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text\\typedefs", "code": {} }, "description": "Font metrics for a Text Style object.", "kind": "typedef", "name": "TextMetrics", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The ascent of the font.", "name": "ascent" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The descent of the font.", "name": "descent" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The size of the font.", "name": "fontSize" } ], "memberof": "Phaser.Types.GameObjects.Text", "longname": "Phaser.Types.GameObjects.Text.TextMetrics", "scope": "static", "___id": "T000002R018361", "___s": true }, { "comment": "/**\r\n * A Text Padding configuration object as used by the Text Style.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.Text.TextPadding\r\n * @since 3.18.0\r\n *\r\n * @property {number} [x] - If set this value is used for both the left and right padding.\r\n * @property {number} [y] - If set this value is used for both the top and bottom padding.\r\n * @property {number} [left] - The amount of padding added to the left of the Text object.\r\n * @property {number} [right] - The amount of padding added to the right of the Text object.\r\n * @property {number} [top] - The amount of padding added to the top of the Text object.\r\n * @property {number} [bottom] - The amount of padding added to the bottom of the Text object.\r\n */", "meta": { "filename": "TextPadding.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text\\typedefs", "code": {} }, "description": "A Text Padding configuration object as used by the Text Style.", "kind": "typedef", "name": "TextPadding", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.18.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If set this value is used for both the left and right padding.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If set this value is used for both the top and bottom padding.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount of padding added to the left of the Text object.", "name": "left" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount of padding added to the right of the Text object.", "name": "right" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount of padding added to the top of the Text object.", "name": "top" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R018362", "___s": true }, { "comment": "/**\r\n * A Text Shadow configuration object as used by the Text Style.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.Text.TextShadow\r\n * @since 3.0.0\r\n *\r\n * @property {number} [offsetX=0] - The horizontal offset of the shadow.\r\n * @property {number} [offsetY=0] - The vertical offset of the shadow.\r\n * @property {string} [color='#000'] - The color of the shadow, given as a CSS string value.\r\n * @property {number} [blur=0] - The amount of blur applied to the shadow. Leave as zero for a hard shadow.\r\n * @property {boolean} [stroke=false] - Apply the shadow to the stroke effect on the Text object?\r\n * @property {boolean} [fill=false] - Apply the shadow to the fill effect on the Text object?\r\n */", "meta": { "filename": "TextShadow.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text\\typedefs", "code": {} }, "description": "A Text Shadow configuration object as used by the Text Style.", "kind": "typedef", "name": "TextShadow", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal offset of the shadow.", "name": "offsetX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical offset of the shadow.", "name": "offsetY" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "defaultvalue": "'#000'", "description": "The color of the shadow, given as a CSS string value.", "name": "color" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Apply the shadow to the stroke effect on the Text object?", "name": "stroke" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R018363", "___s": true }, { "comment": "/**\r\n * A Text Style configuration object as used by the Text Game Object.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.Text.TextStyle\r\n * @since 3.0.0\r\n *\r\n * @property {string} [fontFamily='Courier'] - The font the Text object will render with. This is a Canvas style font string.\r\n * @property {(number|string)} [fontSize='16px'] - The font size, as a CSS size string.\r\n * @property {string} [fontStyle] - Any addition font styles, such as 'bold'.\r\n * @property {string} [font] - The font family or font settings to set. Overrides the other font settings.\r\n * @property {string} [backgroundColor] - A solid fill color that is rendered behind the Text object. Given as a CSS string color such as `#ff0`.\r\n * @property {(string|CanvasGradient|CanvasPattern)} [color='#fff'] - The color the Text is drawn in. Given as a CSS string color such as `#fff` or `rgb()`.\r\n * @property {(string|CanvasGradient|CanvasPattern)} [stroke='#fff'] - The color used to stroke the Text if the `strokeThickness` property is greater than zero.\r\n * @property {number} [strokeThickness=0] - The thickness of the stroke around the Text. Set to zero for no stroke.\r\n * @property {Phaser.Types.GameObjects.Text.TextShadow} [shadow] - The Text shadow configuration object.\r\n * @property {Phaser.Types.GameObjects.Text.TextPadding} [padding] - A Text Padding object.\r\n * @property {string} [align='left'] - The alignment of the Text. This only impacts multi-line text. Either `left`, `right`, `center` or `justify`.\r\n * @property {number} [maxLines=0] - The maximum number of lines to display within the Text object.\r\n * @property {number} [fixedWidth=0] - Force the Text object to have the exact width specified in this property. Leave as zero for it to change accordingly to content.\r\n * @property {number} [fixedHeight=0] - Force the Text object to have the exact height specified in this property. Leave as zero for it to change accordingly to content.\r\n * @property {number} [resolution=0] - Sets the resolution (DPI setting) of the Text object. Leave at zero for it to use the game resolution.\r\n * @property {boolean} [rtl=false] - Set to `true` if this Text object should render from right-to-left.\r\n * @property {string} [testString='|MÉqgy'] - This is the string used to aid Canvas in calculating the height of the font.\r\n * @property {number} [baselineX=1.2] - The amount of horizontal padding added to the width of the text when calculating the font metrics.\r\n * @property {number} [baselineY=1.4] - The amount of vertical padding added to the height of the text when calculating the font metrics.\r\n * @property {Phaser.Types.GameObjects.Text.TextWordWrap} [wordWrap] - The Text Word wrap configuration object.\r\n * @property {Phaser.Types.GameObjects.Text.TextMetrics} [metrics] - A Text Metrics object. Use this to avoid expensive font size calculations in text heavy games.\r\n * @property {number} [lineSpacing] - The amount to add to the font height to achieve the overall line height.\r\n * @property {number} [letterSpacing] - The amount to add to the spacing between characters. Can be a negative or positive number.\r\n */", "meta": { "filename": "TextStyle.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text\\typedefs", "code": {} }, "description": "A Text Style configuration object as used by the Text Game Object.", "kind": "typedef", "name": "TextStyle", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "optional": true, "defaultvalue": "'16px'", "description": "The font size, as a CSS size string.", "name": "fontSize" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Any addition font styles, such as 'bold'.", "name": "fontStyle" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The font family or font settings to set. Overrides the other font settings.", "name": "font" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "CanvasGradient", "CanvasPattern" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "CanvasGradient" }, { "type": "NameExpression", "name": "CanvasPattern" } ] } }, "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", "CanvasGradient", "CanvasPattern" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "CanvasGradient" }, { "type": "NameExpression", "name": "CanvasPattern" } ] } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextShadow" } }, "optional": true, "description": "The Text shadow configuration object.", "name": "shadow" }, { "type": { "names": [ "Phaser.Types.GameObjects.Text.TextPadding" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextPadding" } }, "optional": true, "description": "A Text Padding object.", "name": "padding" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The maximum number of lines to display within the Text object.", "name": "maxLines" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Set to `true` if this Text object should render from right-to-left.", "name": "rtl" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Text.TextWordWrap" } }, "optional": true, "description": "The Text Word wrap configuration object.", "name": "wordWrap" }, { "type": { "names": [ "Phaser.Types.GameObjects.Text.TextMetrics" ], "parsedType": { "type": "NameExpression", "name": "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" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount to add to the font height to achieve the overall line height.", "name": "lineSpacing" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The amount to add to the spacing between characters. Can be a negative or positive number.", "name": "letterSpacing" } ], "memberof": "Phaser.Types.GameObjects.Text", "longname": "Phaser.Types.GameObjects.Text.TextStyle", "scope": "static", "___id": "T000002R018364", "___s": true }, { "comment": "/**\r\n * A Text Word Wrap configuration object as used by the Text Style configuration.\r\n *\r\n * @typedef {object} Phaser.Types.GameObjects.Text.TextWordWrap\r\n * @since 3.0.0\r\n *\r\n * @property {number} [width] - The width at which text should be considered for word-wrapping.\r\n * @property {TextStyleWordWrapCallback} [callback] - Provide a custom callback when word wrapping is enabled.\r\n * @property {any} [callbackScope] - The context in which the word wrap callback is invoked.\r\n * @property {boolean} [useAdvancedWrap=false] - Use basic or advanced word wrapping?\r\n */", "meta": { "filename": "TextWordWrap.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text\\typedefs", "code": {} }, "description": "A Text Word Wrap configuration object as used by the Text Style configuration.", "kind": "typedef", "name": "TextWordWrap", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width at which text should be considered for word-wrapping.", "name": "width" }, { "type": { "names": [ "TextStyleWordWrapCallback" ], "parsedType": { "type": "NameExpression", "name": "TextStyleWordWrapCallback" } }, "optional": true, "description": "Provide a custom callback when word wrapping is enabled.", "name": "callback" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The context in which the word wrap callback is invoked.", "name": "callbackScope" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R018365", "___s": true }, { "comment": "/**\r\n * A custom function that will be responsible for wrapping the text.\r\n * @callback TextStyleWordWrapCallback\r\n *\r\n * @param {string} text - The string to wrap.\r\n * @param {Phaser.GameObjects.Text} textObject - The Text instance.\r\n *\r\n * @return {(string|string[])} Should return the wrapped lines either as an array of lines or as a string with\r\n * newline characters in place to indicate where breaks should happen.\r\n */", "meta": { "filename": "TextWordWrap.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\text\\typedefs", "code": {} }, "description": "A custom function that will be responsible for wrapping the text.", "kind": "typedef", "name": "TextStyleWordWrapCallback", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The string to wrap.", "name": "text" }, { "type": { "names": [ "Phaser.GameObjects.Text" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Text" } }, "description": "The Text instance.", "name": "textObject" } ], "returns": [ { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "description": "Should return the wrapped lines either as an array of lines or as a string with\rnewline characters in place to indicate where breaks should happen." } ], "longname": "TextStyleWordWrapCallback", "scope": "global", "___id": "T000002R018366", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A TileSprite is a Sprite that has a repeating texture.\r\n *\r\n * The texture can be scrolled and scaled independently of the TileSprite itself. Textures will automatically wrap and\r\n * are designed so that you can create game backdrops using seamless textures as a source.\r\n *\r\n * You shouldn't ever create a TileSprite any larger than your actual canvas size. If you want to create a large repeating background\r\n * that scrolls across the whole map of your game, then you create a TileSprite that fits the canvas size and then use the `tilePosition`\r\n * property to scroll the texture as the player moves. If you create a TileSprite that is thousands of pixels in size then it will\r\n * consume huge amounts of memory and cause performance issues. Remember: use `tilePosition` to scroll your texture and `tileScale` to\r\n * adjust the scale of the texture - don't resize the sprite itself or make it larger than it needs.\r\n *\r\n * Prior to Phaser 4, TileSprite did not support rotation.\r\n * In WebGL, it required the texture to be a power of two in size,\r\n * and did not support compressed textures or DynamicTextures.\r\n * It could introduce aliasing artifacts for textures that were not\r\n * a power of two in size.\r\n * These restrictions have been lifted in v4.\r\n *\r\n * @class TileSprite\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.GameObjects.Components.Alpha\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.ComputedSize\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Flip\r\n * @extends Phaser.GameObjects.Components.GetBounds\r\n * @extends Phaser.GameObjects.Components.Lighting\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Texture\r\n * @extends Phaser.GameObjects.Components.Tint\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {number} width - The width of the Game Object. If zero it will use the size of the texture frame.\r\n * @param {number} height - The height of the Game Object. If zero it will use the size of the texture frame.\r\n * @param {string} textureKey - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager. Cannot be a DynamicTexture.\r\n * @param {(string|number)} [frameKey] - An optional frame from the Texture this Game Object is rendering with.\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 21, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "classdesc": "A TileSprite is a Sprite that has a repeating texture.\r\rThe texture can be scrolled and scaled independently of the TileSprite itself. Textures will automatically wrap and\rare designed so that you can create game backdrops using seamless textures as a source.\r\rYou shouldn't ever create a TileSprite any larger than your actual canvas size. If you want to create a large repeating background\rthat scrolls across the whole map of your game, then you create a TileSprite that fits the canvas size and then use the `tilePosition`\rproperty to scroll the texture as the player moves. If you create a TileSprite that is thousands of pixels in size then it will\rconsume huge amounts of memory and cause performance issues. Remember: use `tilePosition` to scroll your texture and `tileScale` to\radjust the scale of the texture - don't resize the sprite itself or make it larger than it needs.\r\rPrior to Phaser 4, TileSprite did not support rotation.\rIn WebGL, it required the texture to be a power of two in size,\rand did not support compressed textures or DynamicTextures.\rIt could introduce aliasing artifacts for textures that were not\ra power of two in size.\rThese restrictions have been lifted in v4.", "kind": "class", "name": "TileSprite", "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.Lighting", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.RenderNodes", "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the Game Object. If zero it will use the size of the texture frame.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the Game Object. If zero it will use the size of the texture frame.", "name": "height" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Texture this Game Object will use to render with, as stored in the Texture Manager. Cannot be a DynamicTexture.", "name": "textureKey" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frameKey" } ], "scope": "static", "longname": "Phaser.GameObjects.TileSprite", "___id": "T000002R018378", "___s": true }, { "comment": "/**\r\n * Whether the Tile Sprite has changed in some way, requiring a re-render of its tile texture.\r\n *\r\n * Such changes include the texture frame and scroll position of the Tile Sprite.\r\n *\r\n * This is irrelevant in WebGL mode.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#dirty\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Whether the Tile Sprite has changed in some way, requiring a re-render of its tile texture.\r\rSuch changes include the texture frame and scroll position of the Tile Sprite.\r\rThis is irrelevant in WebGL mode.", "name": "dirty", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#dirty", "scope": "instance", "kind": "member", "___id": "T000002R018395", "___s": true }, { "comment": "/**\r\n * The renderer in use by this Tile Sprite.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#renderer\r\n * @type {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The renderer in use by this Tile Sprite.", "name": "renderer", "type": { "names": [ "Phaser.Renderer.Canvas.CanvasRenderer", "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.Canvas.CanvasRenderer" }, { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } ] } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#renderer", "scope": "instance", "kind": "member", "___id": "T000002R018397", "___s": true }, { "comment": "/**\r\n * The Canvas element that the TileSprite renders its fill pattern in to.\r\n * Only used in Canvas mode.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#canvas\r\n * @type {?HTMLCanvasElement}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The Canvas element that the TileSprite renders its fill pattern in to.\rOnly used in Canvas mode.", "name": "canvas", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement", "nullable": true } }, "nullable": true, "since": "3.12.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#canvas", "scope": "instance", "kind": "member", "___id": "T000002R018399", "___s": true }, { "comment": "/**\r\n * The Context of the Canvas element that the TileSprite renders its fill pattern in to.\r\n * Only used in Canvas mode.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#context\r\n * @type {?CanvasRenderingContext2D}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 173, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The Context of the Canvas element that the TileSprite renders its fill pattern in to.\rOnly used in Canvas mode.", "name": "context", "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D", "nullable": true } }, "nullable": true, "since": "3.12.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#context", "scope": "instance", "kind": "member", "___id": "T000002R018401", "___s": true }, { "comment": "/**\r\n * The Canvas that the TileSprite's texture is rendered to.\r\n * This is used to create a WebGL texture from.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#fillCanvas\r\n * @type {HTMLCanvasElement}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 224, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The Canvas that the TileSprite's texture is rendered to.\rThis is used to create a WebGL texture from.", "name": "fillCanvas", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.12.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#fillCanvas", "scope": "instance", "kind": "member", "___id": "T000002R018412", "___s": true }, { "comment": "/**\r\n * The Canvas Context used to render the TileSprite's texture.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#fillContext\r\n * @type {CanvasRenderingContext2D}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 234, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The Canvas Context used to render the TileSprite's texture.", "name": "fillContext", "type": { "names": [ "CanvasRenderingContext2D" ], "parsedType": { "type": "NameExpression", "name": "CanvasRenderingContext2D" } }, "since": "3.12.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#fillContext", "scope": "instance", "kind": "member", "___id": "T000002R018414", "___s": true }, { "comment": "/**\r\n * The texture that the Tile Sprite is rendered to, which is then rendered to a Scene.\r\n * In WebGL this is a WebGLTextureWrapper. In Canvas it's a Canvas Fill Pattern.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#fillPattern\r\n * @type {?(Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper|CanvasPattern)}\r\n * @since 3.12.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 243, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The texture that the Tile Sprite is rendered to, which is then rendered to a Scene.\rIn WebGL this is a WebGLTextureWrapper. In Canvas it's a Canvas Fill Pattern.", "name": "fillPattern", "type": { "names": [ "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper", "CanvasPattern" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper" }, { "type": "NameExpression", "name": "CanvasPattern" } ], "nullable": true } }, "nullable": true, "since": "3.12.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#fillPattern", "scope": "instance", "kind": "member", "___id": "T000002R018417", "___s": true }, { "comment": "/**\r\n * The Animation State component of this TileSprite.\r\n *\r\n * This component provides features to apply animations to this TileSprite.\r\n * It is responsible for playing, loading, queuing animations for later playback,\r\n * mixing between animations and setting the current animation frame to this TileSprite.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#anims\r\n * @type {Phaser.Animations.AnimationState}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 253, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The Animation State component of this TileSprite.\r\rThis component provides features to apply animations to this TileSprite.\rIt is responsible for playing, loading, queuing animations for later playback,\rmixing between animations and setting the current animation frame to this TileSprite.", "name": "anims", "type": { "names": [ "Phaser.Animations.AnimationState" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Animations.AnimationState" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#anims", "scope": "instance", "kind": "member", "___id": "T000002R018419", "___s": true }, { "comment": "/**\r\n * Adds this TileSprite to the Scene's update list, so that its `preUpdate` method\r\n * is called each game step to advance its animations. Called automatically when\r\n * this Game Object is added to a Scene.\r\n *\r\n * @method Phaser.GameObjects.TileSprite#addedToScene\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 290, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Adds this TileSprite to the Scene's update list, so that its `preUpdate` method\ris called each game step to advance its animations. Called automatically when\rthis Game Object is added to a Scene.", "kind": "function", "name": "addedToScene", "since": "3.50.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#addedToScene", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#addedToScene", "___id": "T000002R018424", "___s": true }, { "comment": "/**\r\n * Removes this TileSprite from the Scene's update list, stopping its `preUpdate`\r\n * method from being called. Called automatically when this Game Object is removed\r\n * from a Scene.\r\n *\r\n * @method Phaser.GameObjects.TileSprite#removedFromScene\r\n * @since 3.50.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 303, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Removes this TileSprite from the Scene's update list, stopping its `preUpdate`\rmethod from being called. Called automatically when this Game Object is removed\rfrom a Scene.", "kind": "function", "name": "removedFromScene", "since": "3.50.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#removedFromScene", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#removedFromScene", "___id": "T000002R018426", "___s": true }, { "comment": "/**\r\n * Update this TileSprite's animations.\r\n *\r\n * @method Phaser.GameObjects.TileSprite#preUpdate\r\n * @protected\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current timestamp.\r\n * @param {number} delta - The delta time, in ms, elapsed since the last frame.\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 316, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Update this TileSprite's animations.", "kind": "function", "name": "preUpdate", "access": "protected", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time, in ms, elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#preUpdate", "scope": "instance", "___id": "T000002R018428", "___s": true }, { "comment": "/**\r\n * Sets the frame this Game Object will use to render with.\r\n *\r\n * The Frame has to belong to the current Texture being used.\r\n *\r\n * It can be either a string or an index.\r\n *\r\n * @method Phaser.GameObjects.TileSprite#setFrame\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number)} frame - The name or index of the frame within the Texture.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 331, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Sets the frame this Game Object will use to render with.\r\rThe Frame has to belong to the current Texture being used.\r\rIt can be either a string or an index.", "kind": "function", "name": "setFrame", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The name or index of the frame within the Texture.", "name": "frame" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#setFrame", "scope": "instance", "overrides": "Phaser.GameObjects.Components.Texture#setFrame", "___id": "T000002R018430", "___s": true }, { "comment": "/**\r\n * No-op method for compatibility with Animation.\r\n *\r\n * @method Phaser.GameObjects.TileSprite#setSizeToFrame\r\n * @since 4.0.0\r\n * @return {this} This Tile Sprite instance.\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 365, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "No-op method for compatibility with Animation.", "kind": "function", "name": "setSizeToFrame", "since": "4.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tile Sprite instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#setSizeToFrame", "scope": "instance", "___id": "T000002R018437", "___s": true }, { "comment": "/**\r\n * Sets the horizontal and vertical scroll position of the tiling texture, updating\r\n * {@link Phaser.GameObjects.TileSprite#tilePositionX} and {@link Phaser.GameObjects.TileSprite#tilePositionY}.\r\n * Either value may be omitted to leave it unchanged.\r\n *\r\n * @method Phaser.GameObjects.TileSprite#setTilePosition\r\n * @since 3.3.0\r\n *\r\n * @param {number} [x] - The x position of this sprite's tiling texture.\r\n * @param {number} [y] - The y position of this sprite's tiling texture.\r\n *\r\n * @return {this} This Tile Sprite instance.\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 377, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Sets the horizontal and vertical scroll position of the tiling texture, updating\r{@link Phaser.GameObjects.TileSprite#tilePositionX} and {@link Phaser.GameObjects.TileSprite#tilePositionY}.\rEither value may be omitted to leave it unchanged.", "kind": "function", "name": "setTilePosition", "since": "3.3.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The x position of this sprite's tiling texture.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The y position of this sprite's tiling texture.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tile Sprite instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#setTilePosition", "scope": "instance", "___id": "T000002R018439", "___s": true }, { "comment": "/**\r\n * Sets the rotation of the tiling texture, in radians, updating\r\n * {@link Phaser.GameObjects.TileSprite#tileRotation}.\r\n * The texture rotates around its own origin, independently of the TileSprite's world rotation.\r\n *\r\n * @method Phaser.GameObjects.TileSprite#setTileRotation\r\n * @since 4.0.0\r\n *\r\n * @param {number} [radians=0] - The rotation of the tiling texture, in radians.\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 405, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Sets the rotation of the tiling texture, in radians, updating\r{@link Phaser.GameObjects.TileSprite#tileRotation}.\rThe texture rotates around its own origin, independently of the TileSprite's world rotation.", "kind": "function", "name": "setTileRotation", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The rotation of the tiling texture, in radians.", "name": "radians" } ], "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#setTileRotation", "scope": "instance", "___id": "T000002R018443", "___s": true }, { "comment": "/**\r\n * Sets the horizontal and vertical scale of the tiling texture, updating\r\n * {@link Phaser.GameObjects.TileSprite#tileScaleX} and {@link Phaser.GameObjects.TileSprite#tileScaleY}.\r\n * The scale is independent of the TileSprite's own scale. If only `x` is provided,\r\n * both axes are set to the same value.\r\n *\r\n * @method Phaser.GameObjects.TileSprite#setTileScale\r\n * @since 3.12.0\r\n *\r\n * @param {number} [x] - The horizontal scale of the tiling texture. If not given it will use the current `tileScaleX` value.\r\n * @param {number} [y=x] - The vertical scale of the tiling texture. If not given it will use the `x` value.\r\n *\r\n * @return {this} This Tile Sprite instance.\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 424, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Sets the horizontal and vertical scale of the tiling texture, updating\r{@link Phaser.GameObjects.TileSprite#tileScaleX} and {@link Phaser.GameObjects.TileSprite#tileScaleY}.\rThe scale is independent of the TileSprite's own scale. If only `x` is provided,\rboth axes are set to the same value.", "kind": "function", "name": "setTileScale", "since": "3.12.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Tile Sprite instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#setTileScale", "scope": "instance", "___id": "T000002R018447", "___s": true }, { "comment": "/**\r\n * Sets the size of this TileSprite's output region.\r\n *\r\n * This does not change the scale.\r\n *\r\n * If you have enabled this Game Object for input, changing the size will also change the\r\n * size of the hit area, unless you have defined a custom hit area.\r\n *\r\n * @method Phaser.GameObjects.TileSprite#setSize\r\n * @since 4.0.0\r\n *\r\n * @param {number} width - The width of this Game Object.\r\n * @param {number} height - The height of this Game Object.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 575, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Sets the size of this TileSprite's output region.\r\rThis does not change the scale.\r\rIf you have enabled this Game Object for input, changing the size will also change the\rsize of the hit area, unless you have defined a custom hit area.", "kind": "function", "name": "setSize", "since": "4.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#setSize", "scope": "instance", "overrides": "Phaser.GameObjects.Components.ComputedSize#setSize", "___id": "T000002R018484", "___s": true }, { "comment": "/**\r\n * Internal destroy handler, called as part of the destroy process.\r\n *\r\n * @method Phaser.GameObjects.TileSprite#preDestroy\r\n * @protected\r\n * @since 3.9.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 609, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Internal destroy handler, called as part of the destroy process.", "kind": "function", "name": "preDestroy", "access": "protected", "since": "3.9.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#preDestroy", "scope": "instance", "___id": "T000002R018491", "___s": true }, { "comment": "/**\r\n * The horizontal scroll position of the Tile Sprite.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#tilePositionX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 641, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The horizontal scroll position of the Tile Sprite.", "name": "tilePositionX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#tilePositionX", "scope": "instance", "kind": "member", "___id": "T000002R018500", "___s": true }, { "comment": "/**\r\n * The vertical scroll position of the Tile Sprite.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#tilePositionY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 664, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The vertical scroll position of the Tile Sprite.", "name": "tilePositionY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#tilePositionY", "scope": "instance", "kind": "member", "___id": "T000002R018506", "___s": true }, { "comment": "/**\r\n * The rotation of the Tile Sprite texture, in radians.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#tileRotation\r\n * @type {number}\r\n * @default 0\r\n * @since 4.0.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 687, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The rotation of the Tile Sprite texture, in radians.", "name": "tileRotation", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "4.0.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#tileRotation", "scope": "instance", "kind": "member", "___id": "T000002R018512", "___s": true }, { "comment": "/**\r\n * The horizontal scale of the Tile Sprite texture.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#tileScaleX\r\n * @type {number}\r\n * @default 1\r\n * @since 3.11.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 708, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The horizontal scale of the Tile Sprite texture.", "name": "tileScaleX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.11.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#tileScaleX", "scope": "instance", "kind": "member", "___id": "T000002R018518", "___s": true }, { "comment": "/**\r\n * The vertical scale of the Tile Sprite texture.\r\n *\r\n * @name Phaser.GameObjects.TileSprite#tileScaleY\r\n * @type {number}\r\n * @default 1\r\n * @since 3.11.0\r\n */", "meta": { "filename": "TileSprite.js", "lineno": 731, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "The vertical scale of the Tile Sprite texture.", "name": "tileScaleY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.11.0", "memberof": "Phaser.GameObjects.TileSprite", "longname": "Phaser.GameObjects.TileSprite#tileScaleY", "scope": "instance", "kind": "member", "___id": "T000002R018524", "___s": true }, { "comment": "/**\r\n * Creates a new TileSprite Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the TileSprite Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#tileSprite\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.TileSprite.TileSpriteConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.TileSprite} The Game Object that was created.\r\n */", "meta": { "filename": "TileSpriteCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Creates a new TileSprite Game Object and returns it.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.TileSprite.TileSpriteConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.TileSprite" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#tileSprite", "scope": "instance", "___id": "T000002R018538", "___s": true }, { "comment": "/**\r\n * Creates a new TileSprite Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the TileSprite Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#tileSprite\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {number} width - The width of the Game Object. If zero it will use the size of the texture frame.\r\n * @param {number} height - The height of the Game Object. If zero it will use the size of the texture frame.\r\n * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager. Cannot be a DynamicTexture.\r\n * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.\r\n *\r\n * @return {Phaser.GameObjects.TileSprite} The Game Object that was created.\r\n */", "meta": { "filename": "TileSpriteFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite", "code": {} }, "description": "Creates a new TileSprite Game Object and adds it to the Scene.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the Game Object. If zero it will use the size of the texture frame.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the Game Object. If zero it will use the size of the texture frame.", "name": "height" }, { "type": { "names": [ "string", "Phaser.Textures.Texture" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Texture" } ] } }, "description": "The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager. Cannot be a DynamicTexture.", "name": "texture" }, { "type": { "names": [ "string", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "optional": true, "description": "An optional frame from the Texture this Game Object is rendering with.", "name": "frame" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.TileSprite" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.TileSprite" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#tileSprite", "scope": "instance", "___id": "T000002R018550", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.TileSprite\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite\\typedefs", "code": {} }, "kind": "namespace", "name": "TileSprite", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.TileSprite", "scope": "static", "___id": "T000002R018567", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.TileSprite.TileSpriteConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 3.0.0\r\n *\r\n * @property {number} [x=0] - The x coordinate of the Tile Sprite.\r\n * @property {number} [y=0] - The y coordinate of the Tile Sprite.\r\n * @property {number} [width=512] - The width of the Tile Sprite. If zero it will use the size of the texture frame.\r\n * @property {number} [height=512] - The height of the Tile Sprite. If zero it will use the size of the texture frame.\r\n * @property {string} [key=''] - The key of the Texture this Tile Sprite will use to render with, as stored in the Texture Manager.\r\n * @property {(number|string|Phaser.Textures.Frame)} [frame=''] - An optional frame from the Texture this Tile Sprite is rendering with.\r\n */", "meta": { "filename": "TileSpriteConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\tilesprite\\typedefs", "code": {} }, "kind": "typedef", "name": "TileSpriteConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "3.0.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the Tile Sprite.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the Tile Sprite.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number", "string", "Phaser.Textures.Frame" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Textures.Frame" } ] } }, "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", "___id": "T000002R018568", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.DecomposeMatrixResults\r\n * @since 3.60.0\r\n *\r\n * @property {number} translateX - The translated x value.\r\n * @property {number} translateY - The translated y value.\r\n * @property {number} rotation - The rotation value.\r\n * @property {number} scaleX - The scale x value.\r\n * @property {number} scaleY - The scale y value.\r\n */", "meta": { "filename": "DecomposeMatrixResults.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\typedefs", "code": {} }, "kind": "typedef", "name": "DecomposeMatrixResults", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.60.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The translated x value.", "name": "translateX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The translated y value.", "name": "translateY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The rotation value.", "name": "rotation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The scale x value.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The scale y value.", "name": "scaleY" } ], "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.DecomposeMatrixResults", "scope": "static", "___id": "T000002R018569", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.FiltersInternalExternal\r\n * @since 4.0.0\r\n *\r\n * @property {Phaser.GameObjects.Components.FilterList} internal - The internal filter list of the Game Object. These filters are applied first, in the local space of the Game Object.\r\n * @property {Phaser.GameObjects.Components.FilterList} external - The external filter list of the Game Object. These filters are applied last, in the parent space of the Game Object.\r\n */", "meta": { "filename": "FiltersInternalExternal.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\typedefs", "code": {} }, "kind": "typedef", "name": "FiltersInternalExternal", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "4.0.0", "properties": [ { "type": { "names": [ "Phaser.GameObjects.Components.FilterList" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FilterList" } }, "description": "The internal filter list of the Game Object. These filters are applied first, in the local space of the Game Object.", "name": "internal" }, { "type": { "names": [ "Phaser.GameObjects.Components.FilterList" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.FilterList" } }, "description": "The external filter list of the Game Object. These filters are applied last, in the parent space of the Game Object.", "name": "external" } ], "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.FiltersInternalExternal", "scope": "static", "___id": "T000002R018570", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 3.0.0\r\n *\r\n * @property {(number|object)} [x=0] - The x position of the Game Object.\r\n * @property {(number|object)} [y=0] - The y position of the Game Object.\r\n * @property {number} [depth=0] - The depth of the GameObject.\r\n * @property {boolean} [flipX=false] - The horizontally flipped state of the Game Object.\r\n * @property {boolean} [flipY=false] - The vertically flipped state of the Game Object.\r\n * @property {?(number|object)} [scale=null] - The scale of the GameObject.\r\n * @property {?(number|object)} [scrollFactor=null] - The scroll factor of the GameObject.\r\n * @property {(number|object)} [rotation=0] - The rotation angle of the Game Object, in radians.\r\n * @property {?(number|object)} [angle=null] - The rotation angle of the Game Object, in degrees.\r\n * @property {(number|object)} [alpha=1] - The alpha (opacity) of the Game Object.\r\n * @property {?(number|object)} [origin=null] - The origin of the Game Object.\r\n * @property {number} [scaleMode=ScaleModes.DEFAULT] - The scale mode of the GameObject.\r\n * @property {number} [blendMode=BlendModes.DEFAULT] - The blend mode of the GameObject.\r\n * @property {boolean} [visible=true] - The visible state of the Game Object.\r\n * @property {boolean} [add=true] - Add the GameObject to the scene.\r\n */", "meta": { "filename": "GameObjectConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\typedefs", "code": {} }, "kind": "typedef", "name": "GameObjectConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "number", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "defaultvalue": 0, "description": "The x position of the Game Object.", "name": "x" }, { "type": { "names": [ "number", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "defaultvalue": 0, "description": "The y position of the Game Object.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The depth of the GameObject.", "name": "depth" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "The horizontally flipped state of the Game Object.", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "The vertically flipped state of the Game Object.", "name": "flipY" }, { "type": { "names": [ "number", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "object" } ], "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": null, "description": "The scale of the GameObject.", "name": "scale" }, { "type": { "names": [ "number", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "object" } ], "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": null, "description": "The scroll factor of the GameObject.", "name": "scrollFactor" }, { "type": { "names": [ "number", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "defaultvalue": 0, "description": "The rotation angle of the Game Object, in radians.", "name": "rotation" }, { "type": { "names": [ "number", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "object" } ], "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": null, "description": "The rotation angle of the Game Object, in degrees.", "name": "angle" }, { "type": { "names": [ "number", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "defaultvalue": 1, "description": "The alpha (opacity) of the Game Object.", "name": "alpha" }, { "type": { "names": [ "number", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "object" } ], "nullable": true } }, "optional": true, "nullable": true, "defaultvalue": null, "description": "The origin of the Game Object.", "name": "origin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "ScaleModes.DEFAULT", "description": "The scale mode of the GameObject.", "name": "scaleMode" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "BlendModes.DEFAULT", "description": "The blend mode of the GameObject.", "name": "blendMode" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "The visible state of the Game Object.", "name": "visible" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R018571", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.GetCalcMatrixResults\r\n * @since 3.50.0\r\n *\r\n * @property {Phaser.GameObjects.Components.TransformMatrix} cameraExternal - The calculated Camera external matrix (where the camera is on the screen).\r\n * @property {Phaser.GameObjects.Components.TransformMatrix} camera - The calculated Camera view matrix, including scroll modified by scroll factor.\r\n * @property {Phaser.GameObjects.Components.TransformMatrix} sprite - The calculated Sprite (Game Object) matrix (world position).\r\n * @property {Phaser.GameObjects.Components.TransformMatrix} calc - The calculated results matrix, factoring all others in.\r\n */", "meta": { "filename": "GetCalcMatrixResults.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\typedefs", "code": {} }, "kind": "typedef", "name": "GetCalcMatrixResults", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.50.0", "properties": [ { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The calculated Camera external matrix (where the camera is on the screen).", "name": "cameraExternal" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The calculated Camera view matrix, including scroll modified by scroll factor.", "name": "camera" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The calculated Sprite (Game Object) matrix (world position).", "name": "sprite" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "description": "The calculated results matrix, factoring all others in.", "name": "calc" } ], "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.GetCalcMatrixResults", "scope": "static", "___id": "T000002R018572", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\typedefs", "code": {} }, "kind": "namespace", "name": "GameObjects", "memberof": "Phaser.Types", "longname": "Phaser.Types.GameObjects", "scope": "static", "___id": "T000002R018573", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.JSONGameObject\r\n * @since 3.0.0\r\n *\r\n * @property {string} name - The name of this Game Object.\r\n * @property {string} type - A textual representation of this Game Object, i.e. `sprite`.\r\n * @property {number} x - The x position of this Game Object.\r\n * @property {number} y - The y position of this Game Object.\r\n * @property {object} scale - The scale of this Game Object\r\n * @property {number} scale.x - The horizontal scale of this Game Object.\r\n * @property {number} scale.y - The vertical scale of this Game Object.\r\n * @property {object} origin - The origin of this Game Object.\r\n * @property {number} origin.x - The horizontal origin of this Game Object.\r\n * @property {number} origin.y - The vertical origin of this Game Object.\r\n * @property {boolean} flipX - The horizontally flipped state of the Game Object.\r\n * @property {boolean} flipY - The vertically flipped state of the Game Object.\r\n * @property {number} rotation - The angle of this Game Object in radians.\r\n * @property {number} alpha - The alpha value of the Game Object.\r\n * @property {boolean} visible - The visible state of the Game Object.\r\n * @property {number} scaleMode - The Scale Mode being used by this Game Object.\r\n * @property {(number|string)} blendMode - Sets the Blend Mode being used by this Game Object.\r\n * @property {string} textureKey - The texture key of this Game Object.\r\n * @property {string} frameKey - The frame key of this Game Object.\r\n * @property {object} data - The data of this Game Object.\r\n */", "meta": { "filename": "JSONGameObject.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\typedefs", "code": {} }, "kind": "typedef", "name": "JSONGameObject", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of this Game Object.", "name": "name" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A textual representation of this Game Object, i.e. `sprite`.", "name": "type" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of this Game Object.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of this Game Object.", "name": "y" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The scale of this Game Object", "name": "scale" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal scale of this Game Object.", "name": "scale.x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical scale of this Game Object.", "name": "scale.y" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The origin of this Game Object.", "name": "origin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal origin of this Game Object.", "name": "origin.x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical origin of this Game Object.", "name": "origin.y" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The horizontally flipped state of the Game Object.", "name": "flipX" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The vertically flipped state of the Game Object.", "name": "flipY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of this Game Object in radians.", "name": "rotation" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha value of the Game Object.", "name": "alpha" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The visible state of the Game Object.", "name": "visible" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Scale Mode being used by this Game Object.", "name": "scaleMode" }, { "type": { "names": [ "number", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "number" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "Sets the Blend Mode being used by this Game Object.", "name": "blendMode" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The texture key of this Game Object.", "name": "textureKey" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The frame key of this Game Object.", "name": "frameKey" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The data of this Game Object.", "name": "data" } ], "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.JSONGameObject", "scope": "static", "___id": "T000002R018574", "___s": true }, { "comment": "/**\r\n * A function which performs a rendering operation on the given Game Object.\r\n * This is usually the `renderWebGL` method of the Game Object itself,\r\n * but `Phaser.GameObjects.Components.RenderSteps` allows you to define\r\n * a series of steps that are run in sequence.\r\n * The function is not expected to run in any particular scope,\r\n * so it should not use `this`. Instead, all required properties should be\r\n * accessed via `gameObject`.\r\n *\r\n * @callback Phaser.Types.GameObjects.RenderWebGLStep\r\n * @since 4.0.0\r\n *\r\n * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - A reference to the current active WebGL renderer.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object being rendered in this call.\r\n * @param {Phaser.Renderer.WebGL.DrawingContext} drawingContext - The current drawing context.\r\n * @param {Phaser.GameObjects.Components.TransformMatrix} [parentMatrix] - This transform matrix is defined if the game object is nested\r\n * @param {number} [renderStep=0] - The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions.\r\n * @param {Phaser.GameObjects.GameObject[]} [displayList] - The display list which is currently being rendered.\r\n * @param {number} [displayListIndex] - The index of the Game Object within the display list.\r\n *\r\n * @return {void}\r\n */", "meta": { "filename": "RenderWebGLStep.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\typedefs", "code": {} }, "description": "A function which performs a rendering operation on the given Game Object.\rThis is usually the `renderWebGL` method of the Game Object itself,\rbut `Phaser.GameObjects.Components.RenderSteps` allows you to define\ra series of steps that are run in sequence.\rThe function is not expected to run in any particular scope,\rso it should not use `this`. Instead, all required properties should be\raccessed via `gameObject`.", "kind": "typedef", "name": "RenderWebGLStep", "type": { "names": [ "function" ] }, "since": "4.0.0", "params": [ { "type": { "names": [ "Phaser.Renderer.WebGL.WebGLRenderer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.WebGLRenderer" } }, "description": "A reference to the current active WebGL renderer.", "name": "renderer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object being rendered in this call.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Renderer.WebGL.DrawingContext" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Renderer.WebGL.DrawingContext" } }, "description": "The current drawing context.", "name": "drawingContext" }, { "type": { "names": [ "Phaser.GameObjects.Components.TransformMatrix" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Components.TransformMatrix" } }, "optional": true, "description": "This transform matrix is defined if the game object is nested", "name": "parentMatrix" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The index of this function in the Game Object's list of render processes. Used to support multiple rendering functions.", "name": "renderStep" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "optional": true, "description": "The display list which is currently being rendered.", "name": "displayList" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The index of the Game Object within the display list.", "name": "displayListIndex" } ], "returns": [ { "type": { "names": [ "void" ], "parsedType": { "type": "NameExpression", "name": "void", "reservedWord": true } } } ], "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.RenderWebGLStep", "scope": "static", "___id": "T000002R018575", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Update List is a Scene plugin that maintains the list of Game Objects whose\r\n * `preUpdate` method should be called every frame. Game Objects like Sprites add\r\n * themselves to the Update List automatically so their animations are processed.\r\n * You do not normally interact with the Update List directly; instead use\r\n * `addToUpdateList` and `removeFromUpdateList` on individual Game Objects.\r\n *\r\n * @class UpdateList\r\n * @extends Phaser.Structs.ProcessQueue.\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - The Scene that the Update List belongs to.\r\n */", "meta": { "filename": "UpdateList.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "classdesc": "The Update List is a Scene plugin that maintains the list of Game Objects whose\r`preUpdate` method should be called every frame. Game Objects like Sprites add\rthemselves to the Update List automatically so their animations are processed.\rYou do not normally interact with the Update List directly; instead use\r`addToUpdateList` and `removeFromUpdateList` on individual Game Objects.", "kind": "class", "name": "UpdateList", "augments": [ "Phaser.Structs.ProcessQueue." ], "memberof": "Phaser.GameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene that the Update List belongs to.", "name": "scene" } ], "scope": "static", "longname": "Phaser.GameObjects.UpdateList", "___id": "T000002R018580", "___s": true }, { "comment": "/**\r\n * The Scene that the Update List belongs to.\r\n *\r\n * @name Phaser.GameObjects.UpdateList#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "UpdateList.js", "lineno": 41, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The Scene that the Update List belongs to.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.UpdateList", "longname": "Phaser.GameObjects.UpdateList#scene", "scope": "instance", "kind": "member", "___id": "T000002R018585", "___s": true }, { "comment": "/**\r\n * The Scene's Systems.\r\n *\r\n * @name Phaser.GameObjects.UpdateList#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "UpdateList.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The Scene's Systems.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.UpdateList", "longname": "Phaser.GameObjects.UpdateList#systems", "scope": "instance", "kind": "member", "___id": "T000002R018587", "___s": true }, { "comment": "/**\r\n * The update step.\r\n *\r\n * Pre-updates every active Game Object in the list.\r\n *\r\n * @method Phaser.GameObjects.UpdateList#sceneUpdate\r\n * @since 3.20.0\r\n *\r\n * @param {number} time - The current timestamp.\r\n * @param {number} delta - The delta time elapsed since the last frame.\r\n */", "meta": { "filename": "UpdateList.js", "lineno": 134, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The update step.\r\rPre-updates every active Game Object in the list.", "kind": "function", "name": "sceneUpdate", "since": "3.20.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current timestamp.", "name": "time" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The delta time elapsed since the last frame.", "name": "delta" } ], "memberof": "Phaser.GameObjects.UpdateList", "longname": "Phaser.GameObjects.UpdateList#sceneUpdate", "scope": "instance", "___id": "T000002R018598", "___s": true }, { "comment": "/**\r\n * The Scene that owns this plugin is shutting down.\r\n *\r\n * We need to destroy all active, pending, and queued Game Objects, reset all internal properties, and stop listening to Scene events.\r\n *\r\n * @method Phaser.GameObjects.UpdateList#shutdown\r\n * @since 3.0.0\r\n */", "meta": { "filename": "UpdateList.js", "lineno": 161, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The Scene that owns this plugin is shutting down.\r\rWe need to destroy all active, pending, and queued Game Objects, reset all internal properties, and stop listening to Scene events.", "kind": "function", "name": "shutdown", "since": "3.0.0", "memberof": "Phaser.GameObjects.UpdateList", "longname": "Phaser.GameObjects.UpdateList#shutdown", "scope": "instance", "___id": "T000002R018604", "___s": true }, { "comment": "/**\r\n * The Scene that owns this plugin is being destroyed.\r\n *\r\n * We need to shut down and then clear all external references.\r\n *\r\n * @method Phaser.GameObjects.UpdateList#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "UpdateList.js", "lineno": 207, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects", "code": {} }, "description": "The Scene that owns this plugin is being destroyed.\r\rWe need to shut down and then clear all external references.", "kind": "function", "name": "destroy", "since": "3.0.0", "memberof": "Phaser.GameObjects.UpdateList", "longname": "Phaser.GameObjects.UpdateList#destroy", "scope": "instance", "___id": "T000002R018614", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Video\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video\\typedefs", "code": {} }, "kind": "namespace", "name": "Video", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Video", "scope": "static", "___id": "T000002R018619", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Video.VideoConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 3.50.0\r\n *\r\n * @property {string} [key] - Optional key of the Video this Game Object will play, as stored in the Video Cache.\r\n */", "meta": { "filename": "VideoConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video\\typedefs", "code": {} }, "kind": "typedef", "name": "VideoConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "3.50.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional key of the Video this Game Object will play, as stored in the Video Cache.", "name": "key" } ], "memberof": "Phaser.Types.GameObjects.Video", "longname": "Phaser.Types.GameObjects.Video.VideoConfig", "scope": "static", "___id": "T000002R018620", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Video Game Object.\r\n *\r\n * This Game Object is capable of handling playback of a video file, video stream or media stream.\r\n *\r\n * You can optionally 'preload' the video into the Phaser Video Cache:\r\n *\r\n * ```javascript\r\n * preload () {\r\n * this.load.video('ripley', 'assets/aliens.mp4');\r\n * }\r\n *\r\n * create () {\r\n * this.add.video(400, 300, 'ripley');\r\n * }\r\n * ```\r\n *\r\n * You don't have to 'preload' the video. You can also play it directly from a URL:\r\n *\r\n * ```javascript\r\n * create () {\r\n * this.add.video(400, 300).loadURL('assets/aliens.mp4');\r\n * }\r\n * ```\r\n *\r\n * To all intents and purposes, a video is a standard Game Object, just like a Sprite. And as such, you can do\r\n * all the usual things to it, such as scaling, rotating, cropping, tinting, making interactive, giving a\r\n * physics body, etc.\r\n *\r\n * Transparent videos are also possible via the WebM file format. Providing the video file has was encoded with\r\n * an alpha channel, and providing the browser supports WebM playback (not all of them do), then it will render\r\n * in-game with full transparency.\r\n *\r\n * Transparent videos are supported by the HEVC (H.265) codec,\r\n * but only on some devices and browsers, and sometimes the alpha channel is ignored,\r\n * which can be a problem if you're aiming for a consistent experience.\r\n * We advise against relying on HEVC.\r\n *\r\n * Playback is handled entirely via the Request Video Frame API, which is supported by most modern browsers.\r\n * A polyfill is provided for older browsers.\r\n *\r\n * ### Autoplaying Videos\r\n *\r\n * Videos can only autoplay if the browser has been unlocked with an interaction, or satisfies the MEI settings.\r\n * The policies that control autoplaying are vast and vary between browser. You can, and should, read more about\r\n * it here: https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide\r\n *\r\n * If your video doesn't contain any audio, then set the `noAudio` parameter to `true` when the video is _loaded_,\r\n * and it will often allow the video to play immediately:\r\n *\r\n * ```javascript\r\n * preload () {\r\n * this.load.video('pixar', 'nemo.mp4', true);\r\n * }\r\n * ```\r\n *\r\n * The 3rd parameter in the load call tells Phaser that the video doesn't contain any audio tracks. Video without\r\n * audio can autoplay without requiring a user interaction. Video with audio cannot do this unless it satisfies\r\n * the browsers MEI settings. See the MDN Autoplay Guide for further details.\r\n *\r\n * Or:\r\n *\r\n * ```javascript\r\n * create () {\r\n * this.add.video(400, 300).loadURL('assets/aliens.mp4', true);\r\n * }\r\n * ```\r\n *\r\n * You can set the `noAudio` parameter to `true` even if the video does contain audio. It will still allow the video\r\n * to play immediately, but the audio will not start.\r\n *\r\n * More details about video playback and the supported media formats can be found on MDN:\r\n *\r\n * https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement\r\n * https://developer.mozilla.org/en-US/docs/Web/Media/Formats\r\n *\r\n * @class Video\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.20.0\r\n *\r\n * @extends Phaser.GameObjects.Components.Alpha\r\n * @extends Phaser.GameObjects.Components.BlendMode\r\n * @extends Phaser.GameObjects.Components.ComputedSize\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.Flip\r\n * @extends Phaser.GameObjects.Components.GetBounds\r\n * @extends Phaser.GameObjects.Components.Lighting\r\n * @extends Phaser.GameObjects.Components.Mask\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.RenderNodes\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.TextureCrop\r\n * @extends Phaser.GameObjects.Components.Tint\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {string} [key] - Optional key of the Video this Game Object will play, as stored in the Video Cache.\r\n */", "meta": { "filename": "Video.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "classdesc": "A Video Game Object.\r\rThis Game Object is capable of handling playback of a video file, video stream or media stream.\r\rYou can optionally 'preload' the video into the Phaser Video Cache:\r\r```javascript\rpreload () {\r this.load.video('ripley', 'assets/aliens.mp4');\r}\r\rcreate () {\r this.add.video(400, 300, 'ripley');\r}\r```\r\rYou don't have to 'preload' the video. You can also play it directly from a URL:\r\r```javascript\rcreate () {\r this.add.video(400, 300).loadURL('assets/aliens.mp4');\r}\r```\r\rTo all intents and purposes, a video is a standard Game Object, just like a Sprite. And as such, you can do\rall the usual things to it, such as scaling, rotating, cropping, tinting, making interactive, giving a\rphysics body, etc.\r\rTransparent videos are also possible via the WebM file format. Providing the video file has was encoded with\ran alpha channel, and providing the browser supports WebM playback (not all of them do), then it will render\rin-game with full transparency.\r\rTransparent videos are supported by the HEVC (H.265) codec,\rbut only on some devices and browsers, and sometimes the alpha channel is ignored,\rwhich can be a problem if you're aiming for a consistent experience.\rWe advise against relying on HEVC.\r\rPlayback is handled entirely via the Request Video Frame API, which is supported by most modern browsers.\rA polyfill is provided for older browsers.\r\r### Autoplaying Videos\r\rVideos can only autoplay if the browser has been unlocked with an interaction, or satisfies the MEI settings.\rThe policies that control autoplaying are vast and vary between browser. You can, and should, read more about\rit here: https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide\r\rIf your video doesn't contain any audio, then set the `noAudio` parameter to `true` when the video is _loaded_,\rand it will often allow the video to play immediately:\r\r```javascript\rpreload () {\r this.load.video('pixar', 'nemo.mp4', true);\r}\r```\r\rThe 3rd parameter in the load call tells Phaser that the video doesn't contain any audio tracks. Video without\raudio can autoplay without requiring a user interaction. Video with audio cannot do this unless it satisfies\rthe browsers MEI settings. See the MDN Autoplay Guide for further details.\r\rOr:\r\r```javascript\rcreate () {\r this.add.video(400, 300).loadURL('assets/aliens.mp4', true);\r}\r```\r\rYou can set the `noAudio` parameter to `true` even if the video does contain audio. It will still allow the video\rto play immediately, but the audio will not start.\r\rMore details about video playback and the supported media formats can be found on MDN:\r\rhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement\rhttps://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.ComputedSize", "Phaser.GameObjects.Components.Depth", "Phaser.GameObjects.Components.Flip", "Phaser.GameObjects.Components.GetBounds", "Phaser.GameObjects.Components.Lighting", "Phaser.GameObjects.Components.Mask", "Phaser.GameObjects.Components.Origin", "Phaser.GameObjects.Components.RenderNodes", "Phaser.GameObjects.Components.ScrollFactor", "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R018632", "___s": true }, { "comment": "/**\r\n * A reference to the HTML Video Element this Video Game Object is playing.\r\n *\r\n * Will be `undefined` until a video is loaded for playback.\r\n *\r\n * @name Phaser.GameObjects.Video#video\r\n * @type {?HTMLVideoElement}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Video.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "A reference to the HTML Video Element this Video Game Object is playing.\r\rWill be `undefined` until a video is loaded for playback.", "name": "video", "type": { "names": [ "HTMLVideoElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLVideoElement", "nullable": true } }, "nullable": true, "since": "3.20.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#video", "scope": "instance", "kind": "member", "___id": "T000002R018637", "___s": true }, { "comment": "/**\r\n * The Phaser Texture this Game Object is using to render the video to.\r\n *\r\n * Will be `undefined` until a video is loaded for playback.\r\n *\r\n * @name Phaser.GameObjects.Video#videoTexture\r\n * @type {?Phaser.Textures.Texture}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Video.js", "lineno": 163, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "The Phaser Texture this Game Object is using to render the video to.\r\rWill be `undefined` until a video is loaded for playback.", "name": "videoTexture", "type": { "names": [ "Phaser.Textures.Texture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.Texture", "nullable": true } }, "nullable": true, "since": "3.20.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#videoTexture", "scope": "instance", "kind": "member", "___id": "T000002R018639", "___s": true }, { "comment": "/**\r\n * A reference to the TextureSource backing the `videoTexture` Texture object.\r\n *\r\n * Will be `undefined` until a video is loaded for playback.\r\n *\r\n * @name Phaser.GameObjects.Video#videoTextureSource\r\n * @type {?Phaser.Textures.TextureSource}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Video.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "A reference to the TextureSource backing the `videoTexture` Texture object.\r\rWill be `undefined` until a video is loaded for playback.", "name": "videoTextureSource", "type": { "names": [ "Phaser.Textures.TextureSource" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureSource", "nullable": true } }, "nullable": true, "since": "3.20.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#videoTextureSource", "scope": "instance", "kind": "member", "___id": "T000002R018641", "___s": true }, { "comment": "/**\r\n * A Phaser `CanvasTexture` instance that holds the most recent snapshot taken from the video.\r\n *\r\n * This will only be set if the `snapshot` or `snapshotArea` methods have been called.\r\n *\r\n * Until those methods are called, this property will be `undefined`.\r\n *\r\n * @name Phaser.GameObjects.Video#snapshotTexture\r\n * @type {?Phaser.Textures.CanvasTexture}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Video.js", "lineno": 185, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "A Phaser `CanvasTexture` instance that holds the most recent snapshot taken from the video.\r\rThis will only be set if the `snapshot` or `snapshotArea` methods have been called.\r\rUntil those methods are called, this property will be `undefined`.", "name": "snapshotTexture", "type": { "names": [ "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture", "nullable": true } }, "nullable": true, "since": "3.20.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#snapshotTexture", "scope": "instance", "kind": "member", "___id": "T000002R018643", "___s": true }, { "comment": "/**\r\n * If you have saved this video to a texture via the `saveTexture` method, this controls if the video\r\n * is rendered with `flipY` in WebGL or not.\r\n * If you find your video is appearing upside down within a shader or\r\n * custom renderer, flip this property.\r\n *\r\n * @name Phaser.GameObjects.Video#glFlipY\r\n * @type {boolean}\r\n * @since 4.0.0\r\n */", "meta": { "filename": "Video.js", "lineno": 198, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "If you have saved this video to a texture via the `saveTexture` method, this controls if the video\ris rendered with `flipY` in WebGL or not.\rIf you find your video is appearing upside down within a shader or\rcustom renderer, flip this property.", "name": "glFlipY", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "4.0.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#glFlipY", "scope": "instance", "kind": "member", "___id": "T000002R018645", "___s": true }, { "comment": "/**\r\n * An internal flag holding the current state of the video lock, should document interaction be required\r\n * before playback can begin.\r\n *\r\n * @name Phaser.GameObjects.Video#touchLocked\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Video.js", "lineno": 220, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "An internal flag holding the current state of the video lock, should document interaction be required\rbefore playback can begin.", "name": "touchLocked", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.20.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#touchLocked", "scope": "instance", "kind": "member", "___id": "T000002R018649", "___s": true }, { "comment": "/**\r\n * Should the video auto play when document interaction is required and happens?\r\n *\r\n * @name Phaser.GameObjects.Video#playWhenUnlocked\r\n * @type {boolean}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Video.js", "lineno": 231, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Should the video auto play when document interaction is required and happens?", "name": "playWhenUnlocked", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.20.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#playWhenUnlocked", "scope": "instance", "kind": "member", "___id": "T000002R018651", "___s": true }, { "comment": "/**\r\n * Has the video created its texture and populated it with the first frame of video?\r\n *\r\n * @name Phaser.GameObjects.Video#frameReady\r\n * @type {boolean}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Video.js", "lineno": 240, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Has the video created its texture and populated it with the first frame of video?", "name": "frameReady", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#frameReady", "scope": "instance", "kind": "member", "___id": "T000002R018653", "___s": true }, { "comment": "/**\r\n * This read-only property returns `true` if the video is currently stalled, i.e. it has stopped\r\n * playing due to a lack of data, or too much data, but hasn't yet reached the end of the video.\r\n *\r\n * This is set if the Video DOM element emits any of the following events:\r\n *\r\n * `stalled`\r\n * `suspend`\r\n * `waiting`\r\n *\r\n * And is cleared if the Video DOM element emits the `playing` event, or handles\r\n * a requestVideoFrame call.\r\n *\r\n * Listen for the Phaser Event `VIDEO_STALLED` to be notified and inspect the event\r\n * to see which DOM event caused it.\r\n *\r\n * Note that being stalled isn't always a negative thing. A video can be stalled if it\r\n * has downloaded enough data in to its buffer to not need to download any more until\r\n * the current batch of frames have rendered.\r\n *\r\n * @name Phaser.GameObjects.Video#isStalled\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Video.js", "lineno": 249, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "This read-only property returns `true` if the video is currently stalled, i.e. it has stopped\rplaying due to a lack of data, or too much data, but hasn't yet reached the end of the video.\r\rThis is set if the Video DOM element emits any of the following events:\r\r`stalled`\r`suspend`\r`waiting`\r\rAnd is cleared if the Video DOM element emits the `playing` event, or handles\ra requestVideoFrame call.\r\rListen for the Phaser Event `VIDEO_STALLED` to be notified and inspect the event\rto see which DOM event caused it.\r\rNote that being stalled isn't always a negative thing. A video can be stalled if it\rhas downloaded enough data in to its buffer to not need to download any more until\rthe current batch of frames have rendered.", "name": "isStalled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#isStalled", "scope": "instance", "kind": "member", "___id": "T000002R018655", "___s": true }, { "comment": "/**\r\n * Records the number of times the video has failed to play,\r\n * typically because the user hasn't interacted with the page yet.\r\n *\r\n * @name Phaser.GameObjects.Video#failedPlayAttempts\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Video.js", "lineno": 276, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Records the number of times the video has failed to play,\rtypically because the user hasn't interacted with the page yet.", "name": "failedPlayAttempts", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#failedPlayAttempts", "scope": "instance", "kind": "member", "___id": "T000002R018657", "___s": true }, { "comment": "/**\r\n * If the browser supports the Request Video Frame API then this\r\n * property will hold the metadata that is returned from\r\n * the callback each time it is invoked.\r\n *\r\n * See https://wicg.github.io/video-rvfc/#video-frame-metadata-callback\r\n * for a complete list of all properties that will be in this object.\r\n * Likely of most interest is the `mediaTime` property:\r\n *\r\n * The media presentation timestamp (PTS) in seconds of the frame presented\r\n * (e.g. its timestamp on the video.currentTime timeline). MAY have a zero\r\n * value for live-streams or WebRTC applications.\r\n *\r\n * If the browser doesn't support the API then this property will be undefined.\r\n *\r\n * @name Phaser.GameObjects.Video#metadata\r\n * @type {VideoFrameCallbackMetadata}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Video.js", "lineno": 286, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "If the browser supports the Request Video Frame API then this\rproperty will hold the metadata that is returned from\rthe callback each time it is invoked.\r\rSee https://wicg.github.io/video-rvfc/#video-frame-metadata-callback\rfor a complete list of all properties that will be in this object.\rLikely of most interest is the `mediaTime` property:\r\rThe media presentation timestamp (PTS) in seconds of the frame presented\r(e.g. its timestamp on the video.currentTime timeline). MAY have a zero\rvalue for live-streams or WebRTC applications.\r\rIf the browser doesn't support the API then this property will be undefined.", "name": "metadata", "type": { "names": [ "VideoFrameCallbackMetadata" ], "parsedType": { "type": "NameExpression", "name": "VideoFrameCallbackMetadata" } }, "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#metadata", "scope": "instance", "kind": "member", "___id": "T000002R018659", "___s": true }, { "comment": "/**\r\n * The current retry elapsed time.\r\n *\r\n * @name Phaser.GameObjects.Video#retry\r\n * @type {number}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Video.js", "lineno": 307, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "The current retry elapsed time.", "name": "retry", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.20.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#retry", "scope": "instance", "kind": "member", "___id": "T000002R018661", "___s": true }, { "comment": "/**\r\n * If a video fails to play due to a lack of user interaction, this is the\r\n * amount of time, in ms, that the video will wait before trying again to\r\n * play. The default is 500ms.\r\n *\r\n * @name Phaser.GameObjects.Video#retryInterval\r\n * @type {number}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Video.js", "lineno": 316, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "If a video fails to play due to a lack of user interaction, this is the\ramount of time, in ms, that the video will wait before trying again to\rplay. The default is 500ms.", "name": "retryInterval", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.20.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#retryInterval", "scope": "instance", "kind": "member", "___id": "T000002R018663", "___s": true }, { "comment": "/**\r\n * An object containing in and out markers for sequence playback.\r\n *\r\n * @name Phaser.GameObjects.Video#markers\r\n * @type {any}\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Video.js", "lineno": 416, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "An object containing in and out markers for sequence playback.", "name": "markers", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.20.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#markers", "scope": "instance", "kind": "member", "___id": "T000002R018689", "___s": true }, { "comment": "/**\r\n * The key of the current video as stored in the Video cache.\r\n *\r\n * If the video did not come from the cache this will be an empty string.\r\n *\r\n * @name Phaser.GameObjects.Video#cacheKey\r\n * @type {string}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Video.js", "lineno": 465, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "The key of the current video as stored in the Video cache.\r\rIf the video did not come from the cache this will be an empty string.", "name": "cacheKey", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#cacheKey", "scope": "instance", "kind": "member", "___id": "T000002R018699", "___s": true }, { "comment": "/**\r\n * Is the video currently seeking?\r\n *\r\n * This is set to `true` when the `seeking` event is fired,\r\n * and set to `false` when the `seeked` event is fired.\r\n *\r\n * @name Phaser.GameObjects.Video#isSeeking\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Video.js", "lineno": 477, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Is the video currently seeking?\r\rThis is set to `true` when the `seeking` event is fired,\rand set to `false` when the `seeked` event is fired.", "name": "isSeeking", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#isSeeking", "scope": "instance", "kind": "member", "___id": "T000002R018701", "___s": true }, { "comment": "/**\r\n * Adds this Video to the Scene's update list, ensuring it receives\r\n * `preUpdate` calls each game step. This is called automatically by\r\n * the Scene when this Game Object is added to it.\r\n *\r\n * @method Phaser.GameObjects.Video#addedToScene\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Video.js", "lineno": 569, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Adds this Video to the Scene's update list, ensuring it receives\r`preUpdate` calls each game step. This is called automatically by\rthe Scene when this Game Object is added to it.", "kind": "function", "name": "addedToScene", "since": "3.20.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#addedToScene", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#addedToScene", "___id": "T000002R018716", "___s": true }, { "comment": "/**\r\n * Removes this Video from the Scene's update list, stopping it from\r\n * receiving `preUpdate` calls. This is called automatically by the\r\n * Scene when this Game Object is removed from it.\r\n *\r\n * @method Phaser.GameObjects.Video#removedFromScene\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Video.js", "lineno": 582, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Removes this Video from the Scene's update list, stopping it from\rreceiving `preUpdate` calls. This is called automatically by the\rScene when this Game Object is removed from it.", "kind": "function", "name": "removedFromScene", "since": "3.20.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#removedFromScene", "scope": "instance", "overrides": "Phaser.GameObjects.GameObject#removedFromScene", "___id": "T000002R018718", "___s": true }, { "comment": "/**\r\n * Loads a Video from the Video Cache, ready for playback with the `Video.play` method.\r\n *\r\n * If a video is already playing, this method allows you to change the source of the current video element.\r\n * It works by first stopping the current video and then starts playback of the new source through the existing video element.\r\n *\r\n * The reason you may wish to do this is because videos that require interaction to unlock, remain in an unlocked\r\n * state, even if you change the source of the video. By changing the source to a new video you avoid having to\r\n * go through the unlock process again.\r\n *\r\n * @method Phaser.GameObjects.Video#load\r\n * @since 3.60.0\r\n *\r\n * @param {string} key - The key of the Video this Game Object will play, as stored in the Video Cache.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 595, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Loads a Video from the Video Cache, ready for playback with the `Video.play` method.\r\rIf a video is already playing, this method allows you to change the source of the current video element.\rIt works by first stopping the current video and then starts playback of the new source through the existing video element.\r\rThe reason you may wish to do this is because videos that require interaction to unlock, remain in an unlocked\rstate, even if you change the source of the video. By changing the source to a new video you avoid having to\rgo through the unlock process again.", "kind": "function", "name": "load", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the Video this Game Object will play, as stored in the Video Cache.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#load", "scope": "instance", "___id": "T000002R018720", "___s": true }, { "comment": "/**\r\n * This method allows you to change the source of the current video element. It works by first stopping the\r\n * current video, if playing. Then deleting the video texture, if one has been created. Finally, it makes a\r\n * new video texture and starts playback of the new source through the existing video element.\r\n *\r\n * The reason you may wish to do this is because videos that require interaction to unlock, remain in an unlocked\r\n * state, even if you change the source of the video. By changing the source to a new video you avoid having to\r\n * go through the unlock process again.\r\n *\r\n * @method Phaser.GameObjects.Video#changeSource\r\n * @since 3.20.0\r\n *\r\n * @param {string} key - The key of the Video this Game Object will swap to playing, as stored in the Video Cache.\r\n * @param {boolean} [autoplay=true] - Should the video start playing immediately, once the swap is complete?\r\n * @param {boolean} [loop=false] - Should the video loop automatically when it reaches the end? Please note that not all browsers support _seamless_ video looping for all encoding formats.\r\n * @param {number} [markerIn] - Optional in marker time, in seconds, for playback of a sequence of the video.\r\n * @param {number} [markerOut] - Optional out marker time, in seconds, for playback of a sequence of the video.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 630, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "This method allows you to change the source of the current video element. It works by first stopping the\rcurrent video, if playing. Then deleting the video texture, if one has been created. Finally, it makes a\rnew video texture and starts playback of the new source through the existing video element.\r\rThe reason you may wish to do this is because videos that require interaction to unlock, remain in an unlocked\rstate, even if you change the source of the video. By changing the source to a new video you avoid having to\rgo through the unlock process again.", "kind": "function", "name": "changeSource", "since": "3.20.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the video start playing immediately, once the swap is complete?", "name": "autoplay" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional in marker time, in seconds, for playback of a sequence of the video.", "name": "markerIn" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional out marker time, in seconds, for playback of a sequence of the video.", "name": "markerOut" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#changeSource", "scope": "instance", "___id": "T000002R018724", "___s": true }, { "comment": "/**\r\n * Returns the key of the currently played video, as stored in the Video Cache.\r\n *\r\n * If the video did not come from the cache this will return an empty string.\r\n *\r\n * @method Phaser.GameObjects.Video#getVideoKey\r\n * @since 3.20.0\r\n *\r\n * @return {string} The key of the video being played from the Video Cache, if any.\r\n */", "meta": { "filename": "Video.js", "lineno": 666, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Returns the key of the currently played video, as stored in the Video Cache.\r\rIf 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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R018728", "___s": true }, { "comment": "/**\r\n * Loads a Video from the given URL, ready for playback with the `Video.play` method.\r\n *\r\n * If a video is already playing, this method allows you to change the source of the current video element.\r\n * It works by first stopping the current video and then starts playback of the new source through the existing video element.\r\n *\r\n * The reason you may wish to do this is because videos that require interaction to unlock, remain in an unlocked\r\n * state, even if you change the source of the video. By changing the source to a new video you avoid having to\r\n * go through the unlock process again.\r\n *\r\n * @method Phaser.GameObjects.Video#loadURL\r\n * @since 3.60.0\r\n *\r\n * @param {(string|string[]|Phaser.Types.Loader.FileTypes.VideoFileURLConfig|Phaser.Types.Loader.FileTypes.VideoFileURLConfig[])} [urls] - The absolute or relative URL to load the video files from.\r\n * @param {boolean} [noAudio=false] - Does the video have an audio track? If not you can enable auto-playing on it.\r\n * @param {string} [crossOrigin] - The value to use for the `crossOrigin` property in the video load request. Either undefined, `anonymous` or `use-credentials`. If no value is given, `crossorigin` will not be set in the request.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 681, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Loads a Video from the given URL, ready for playback with the `Video.play` method.\r\rIf a video is already playing, this method allows you to change the source of the current video element.\rIt works by first stopping the current video and then starts playback of the new source through the existing video element.\r\rThe reason you may wish to do this is because videos that require interaction to unlock, remain in an unlocked\rstate, even if you change the source of the video. By changing the source to a new video you avoid having to\rgo through the unlock process again.", "kind": "function", "name": "loadURL", "since": "3.60.0", "params": [ { "type": { "names": [ "string", "Array.", "Phaser.Types.Loader.FileTypes.VideoFileURLConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.VideoFileURLConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.VideoFileURLConfig", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The absolute or relative URL to load the video files from.", "name": "urls" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The value to use for the `crossOrigin` property in the video load request. Either undefined, `anonymous` or `use-credentials`. If no value is given, `crossorigin` will not be set in the request.", "name": "crossOrigin" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#loadURL", "scope": "instance", "___id": "T000002R018730", "___s": true }, { "comment": "/**\r\n * Loads a Video from the given MediaStream object, ready for playback with the `Video.play` method.\r\n *\r\n * @method Phaser.GameObjects.Video#loadMediaStream\r\n * @since 3.50.0\r\n *\r\n * @param {MediaStream} stream - The MediaStream object.\r\n * @param {boolean} [noAudio=false] - Does the video have an audio track? If not you can enable auto-playing on it.\r\n * @param {string} [crossOrigin] - The value to use for the `crossOrigin` property in the video load request. Either undefined, `anonymous` or `use-credentials`. If no value is given, `crossorigin` will not be set in the request.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 720, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Loads a Video from the given MediaStream object, ready for playback with the `Video.play` method.", "kind": "function", "name": "loadMediaStream", "since": "3.50.0", "params": [ { "type": { "names": [ "MediaStream" ], "parsedType": { "type": "NameExpression", "name": "MediaStream" } }, "description": "The MediaStream object.", "name": "stream" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The value to use for the `crossOrigin` property in the video load request. Either undefined, `anonymous` or `use-credentials`. If no value is given, `crossorigin` will not be set in the request.", "name": "crossOrigin" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#loadMediaStream", "scope": "instance", "___id": "T000002R018735", "___s": true }, { "comment": "/**\r\n * Internal method that loads a Video from the given URL, ready for playback with the\r\n * `Video.play` method.\r\n *\r\n * Normally you don't call this method directly, but instead use the `Video.loadURL` method,\r\n * or the `Video.load` method if you have preloaded the video.\r\n *\r\n * Calling this method will skip checking if the browser supports the given format in\r\n * the URL, where-as the other two methods enforce these checks.\r\n *\r\n * @method Phaser.GameObjects.Video#loadHandler\r\n * @since 3.60.0\r\n *\r\n * @param {string} [url] - The absolute or relative URL to load the video file from. Set to `null` if passing in a MediaStream object.\r\n * @param {boolean} [noAudio] - Does the video have an audio track? If not you can enable auto-playing on it.\r\n * @param {string} [crossOrigin] - The value to use for the `crossOrigin` property in the video load request. Either undefined, `anonymous` or `use-credentials`. If no value is given, `crossorigin` will not be set in the request.\r\n * @param {string} [stream] - A MediaStream object if this is playing a stream instead of a file.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 737, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Internal method that loads a Video from the given URL, ready for playback with the\r`Video.play` method.\r\rNormally you don't call this method directly, but instead use the `Video.loadURL` method,\ror the `Video.load` method if you have preloaded the video.\r\rCalling this method will skip checking if the browser supports the given format in\rthe URL, where-as the other two methods enforce these checks.", "kind": "function", "name": "loadHandler", "since": "3.60.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The absolute or relative URL to load the video file from. Set to `null` if passing in a MediaStream object.", "name": "url" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "description": "Does the video have an audio track? If not you can enable auto-playing on it.", "name": "noAudio" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The value to use for the `crossOrigin` property in the video load request. Either undefined, `anonymous` or `use-credentials`. If no value is given, `crossorigin` will not be set in the request.", "name": "crossOrigin" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "A MediaStream object if this is playing a stream instead of a file.", "name": "stream" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#loadHandler", "scope": "instance", "___id": "T000002R018737", "___s": true }, { "comment": "/**\r\n * This method handles the Request Video Frame callback.\r\n *\r\n * It is called by the browser when a new video frame is ready to be displayed.\r\n *\r\n * It's also responsible for the creation of the video texture, if it doesn't\r\n * already exist. If it does, it updates the texture as required.\r\n *\r\n * For more details about the Request Video Frame callback, see:\r\n * https://web.dev/requestvideoframecallback-rvfc\r\n *\r\n * @method Phaser.GameObjects.Video#requestVideoFrame\r\n * @fires Phaser.GameObjects.Events#VIDEO_CREATED\r\n * @fires Phaser.GameObjects.Events#VIDEO_LOOP\r\n * @fires Phaser.GameObjects.Events#VIDEO_COMPLETE\r\n * @fires Phaser.GameObjects.Events#VIDEO_PLAY\r\n * @fires Phaser.GameObjects.Events#VIDEO_TEXTURE\r\n * @since 3.60.0\r\n *\r\n * @param {DOMHighResTimeStamp} now - The current time in milliseconds.\r\n * @param {VideoFrameCallbackMetadata} metadata - Useful metadata about the video frame that was most recently presented for composition. See https://wicg.github.io/video-rvfc/#video-frame-metadata-callback\r\n */", "meta": { "filename": "Video.js", "lineno": 850, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "This method handles the Request Video Frame callback.\r\rIt is called by the browser when a new video frame is ready to be displayed.\r\rIt's also responsible for the creation of the video texture, if it doesn't\ralready exist. If it does, it updates the texture as required.\r\rFor more details about the Request Video Frame callback, see:\rhttps://web.dev/requestvideoframecallback-rvfc", "kind": "function", "name": "requestVideoFrame", "fires": [ "Phaser.GameObjects.Events#event:VIDEO_CREATED", "Phaser.GameObjects.Events#event:VIDEO_LOOP", "Phaser.GameObjects.Events#event:VIDEO_COMPLETE", "Phaser.GameObjects.Events#event:VIDEO_PLAY", "Phaser.GameObjects.Events#event:VIDEO_TEXTURE" ], "since": "3.60.0", "params": [ { "type": { "names": [ "DOMHighResTimeStamp" ], "parsedType": { "type": "NameExpression", "name": "DOMHighResTimeStamp" } }, "description": "The current time in milliseconds.", "name": "now" }, { "type": { "names": [ "VideoFrameCallbackMetadata" ], "parsedType": { "type": "NameExpression", "name": "VideoFrameCallbackMetadata" } }, "description": "Useful metadata about the video frame that was most recently presented for composition. See https://wicg.github.io/video-rvfc/#video-frame-metadata-callback", "name": "metadata" } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#requestVideoFrame", "scope": "instance", "___id": "T000002R018755", "___s": true }, { "comment": "/**\r\n * Starts this video playing.\r\n *\r\n * If the video is already playing, or has been queued to play with `changeSource` then this method just returns.\r\n *\r\n * Videos can only autoplay if the browser has been unlocked. This happens if you have interacted with the browser, i.e.\r\n * by clicking on it or pressing a key, or due to server settings. The policies that control autoplaying are vast and\r\n * vary between browser. You can read more here: https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide\r\n *\r\n * If your video doesn't contain any audio, then set the `noAudio` parameter to `true` when the video is loaded,\r\n * and it will often allow the video to play immediately:\r\n *\r\n * ```javascript\r\n * preload () {\r\n * this.load.video('pixar', 'nemo.mp4', true);\r\n * }\r\n * ```\r\n *\r\n * The 3rd parameter in the load call tells Phaser that the video doesn't contain any audio tracks. Video without\r\n * audio can autoplay without requiring a user interaction. Video with audio cannot do this unless it satisfies\r\n * the browsers MEI settings. See the MDN Autoplay Guide for details.\r\n *\r\n * If you need audio in your videos, then you'll have to consider the fact that the video cannot start playing until the\r\n * user has interacted with the browser, into your game flow.\r\n *\r\n * @method Phaser.GameObjects.Video#play\r\n * @since 3.20.0\r\n *\r\n * @param {boolean} [loop=false] - Should the video loop automatically when it reaches the end? Please note that not all browsers support _seamless_ video looping for all encoding formats.\r\n * @param {number} [markerIn] - Optional in marker time, in seconds, for playback of a sequence of the video.\r\n * @param {number} [markerOut] - Optional out marker time, in seconds, for playback of a sequence of the video.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 987, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Starts this video playing.\r\rIf the video is already playing, or has been queued to play with `changeSource` then this method just returns.\r\rVideos can only autoplay if the browser has been unlocked. This happens if you have interacted with the browser, i.e.\rby clicking on it or pressing a key, or due to server settings. The policies that control autoplaying are vast and\rvary between browser. You can read more here: https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide\r\rIf your video doesn't contain any audio, then set the `noAudio` parameter to `true` when the video is loaded,\rand it will often allow the video to play immediately:\r\r```javascript\rpreload () {\r this.load.video('pixar', 'nemo.mp4', true);\r}\r```\r\rThe 3rd parameter in the load call tells Phaser that the video doesn't contain any audio tracks. Video without\raudio can autoplay without requiring a user interaction. Video with audio cannot do this unless it satisfies\rthe browsers MEI settings. See the MDN Autoplay Guide for details.\r\rIf you need audio in your videos, then you'll have to consider the fact that the video cannot start playing until the\ruser has interacted with the browser, into your game flow.", "kind": "function", "name": "play", "since": "3.20.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional in marker time, in seconds, for playback of a sequence of the video.", "name": "markerIn" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Optional out marker time, in seconds, for playback of a sequence of the video.", "name": "markerOut" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#play", "scope": "instance", "___id": "T000002R018780", "___s": true }, { "comment": "/**\r\n * Attempts to get the first frame of the video by running the `requestVideoFrame` callback once,\r\n * then stopping. This is useful if you need to grab the first frame of the video to display behind\r\n * a 'play' button, without actually calling the 'play' method.\r\n *\r\n * If the video is already playing, or has been queued to play with `changeSource` then this method just returns.\r\n *\r\n * @method Phaser.GameObjects.Video#getFirstFrame\r\n * @since 3.85.0\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 1064, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Attempts to get the first frame of the video by running the `requestVideoFrame` callback once,\rthen stopping. This is useful if you need to grab the first frame of the video to display behind\ra 'play' button, without actually calling the 'play' method.\r\rIf the video is already playing, or has been queued to play with `changeSource` then this method just returns.", "kind": "function", "name": "getFirstFrame", "since": "3.85.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#getFirstFrame", "scope": "instance", "___id": "T000002R018793", "___s": true }, { "comment": "/**\r\n * Adds the loading specific event handlers to the video element.\r\n *\r\n * @method Phaser.GameObjects.Video#addLoadEventHandlers\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Video.js", "lineno": 1102, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Adds the loading specific event handlers to the video element.", "kind": "function", "name": "addLoadEventHandlers", "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#addLoadEventHandlers", "scope": "instance", "___id": "T000002R018798", "___s": true }, { "comment": "/**\r\n * Removes the loading specific event handlers from the video element.\r\n *\r\n * @method Phaser.GameObjects.Video#removeLoadEventHandlers\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Video.js", "lineno": 1120, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Removes the loading specific event handlers from the video element.", "kind": "function", "name": "removeLoadEventHandlers", "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#removeLoadEventHandlers", "scope": "instance", "___id": "T000002R018801", "___s": true }, { "comment": "/**\r\n * Adds the playback specific event handlers to the video element.\r\n *\r\n * @method Phaser.GameObjects.Video#addEventHandlers\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Video.js", "lineno": 1137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Adds the playback specific event handlers to the video element.", "kind": "function", "name": "addEventHandlers", "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#addEventHandlers", "scope": "instance", "___id": "T000002R018804", "___s": true }, { "comment": "/**\r\n * Removes the playback specific event handlers from the video element.\r\n *\r\n * @method Phaser.GameObjects.Video#removeEventHandlers\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Video.js", "lineno": 1161, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Removes the playback specific event handlers from the video element.", "kind": "function", "name": "removeEventHandlers", "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#removeEventHandlers", "scope": "instance", "___id": "T000002R018809", "___s": true }, { "comment": "/**\r\n * Creates the video.play promise and adds the success and error handlers to it.\r\n *\r\n * Not all browsers support the video.play promise, so this method will fall back to\r\n * the old-school way of handling the video.play call.\r\n *\r\n * See https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/play#browser_compatibility for details.\r\n *\r\n * @method Phaser.GameObjects.Video#createPlayPromise\r\n * @since 3.60.0\r\n *\r\n * @param {boolean} [catchError=true] - Should the error be caught and the video marked as failed to play?\r\n */", "meta": { "filename": "Video.js", "lineno": 1182, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Creates the video.play promise and adds the success and error handlers to it.\r\rNot all browsers support the video.play promise, so this method will fall back to\rthe old-school way of handling the video.play call.\r\rSee https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/play#browser_compatibility for details.", "kind": "function", "name": "createPlayPromise", "since": "3.60.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the error be caught and the video marked as failed to play?", "name": "catchError" } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#createPlayPromise", "scope": "instance", "___id": "T000002R018814", "___s": true }, { "comment": "/**\r\n * Adds a sequence marker to this video.\r\n *\r\n * Markers allow you to split a video up into sequences, delineated by a start and end time, given in seconds.\r\n *\r\n * You can then play back specific markers via the `playMarker` method.\r\n *\r\n * Note that marker timing is _not_ frame-perfect. You should construct your videos in such a way that you allow for\r\n * plenty of extra padding before and after each sequence to allow for discrepancies in browser seek and currentTime accuracy.\r\n *\r\n * See https://github.com/w3c/media-and-entertainment/issues/4 for more details about this issue.\r\n *\r\n * @method Phaser.GameObjects.Video#addMarker\r\n * @since 3.20.0\r\n *\r\n * @param {string} key - A unique name to give this marker.\r\n * @param {number} markerIn - The time, in seconds, representing the start of this marker.\r\n * @param {number} markerOut - The time, in seconds, representing the end of this marker.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 1232, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Adds a sequence marker to this video.\r\rMarkers allow you to split a video up into sequences, delineated by a start and end time, given in seconds.\r\rYou can then play back specific markers via the `playMarker` method.\r\rNote that marker timing is _not_ frame-perfect. You should construct your videos in such a way that you allow for\rplenty of extra padding before and after each sequence to allow for discrepancies in browser seek and currentTime accuracy.\r\rSee 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A unique name to give this marker.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time, in seconds, representing the start of this marker.", "name": "markerIn" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The time, in seconds, representing the end of this marker.", "name": "markerOut" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#addMarker", "scope": "instance", "___id": "T000002R018823", "___s": true }, { "comment": "/**\r\n * Plays a pre-defined sequence in this video.\r\n *\r\n * Markers allow you to split a video up into sequences, delineated by a start and end time, given in seconds and\r\n * specified via the `addMarker` method.\r\n *\r\n * Note that marker timing is _not_ frame-perfect. You should construct your videos in such a way that you allow for\r\n * plenty of extra padding before and after each sequence to allow for discrepancies in browser seek and currentTime accuracy.\r\n *\r\n * See https://github.com/w3c/media-and-entertainment/issues/4 for more details about this issue.\r\n *\r\n * @method Phaser.GameObjects.Video#playMarker\r\n * @since 3.20.0\r\n *\r\n * @param {string} key - The name of the marker sequence to play.\r\n * @param {boolean} [loop=false] - Should the video loop automatically when it reaches the end? Please note that not all browsers support _seamless_ video looping for all encoding formats.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 1263, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Plays a pre-defined sequence in this video.\r\rMarkers allow you to split a video up into sequences, delineated by a start and end time, given in seconds and\rspecified via the `addMarker` method.\r\rNote that marker timing is _not_ frame-perfect. You should construct your videos in such a way that you allow for\rplenty of extra padding before and after each sequence to allow for discrepancies in browser seek and currentTime accuracy.\r\rSee 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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the marker sequence to play.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#playMarker", "scope": "instance", "___id": "T000002R018826", "___s": true }, { "comment": "/**\r\n * Removes a previously set marker from this video.\r\n *\r\n * If the marker is currently playing it will _not_ stop playback.\r\n *\r\n * @method Phaser.GameObjects.Video#removeMarker\r\n * @since 3.20.0\r\n *\r\n * @param {string} key - The name of the marker to remove.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 1294, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Removes a previously set marker from this video.\r\rIf the marker is currently playing it will _not_ stop playback.", "kind": "function", "name": "removeMarker", "since": "3.20.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The name of the marker to remove.", "name": "key" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#removeMarker", "scope": "instance", "___id": "T000002R018829", "___s": true }, { "comment": "/**\r\n * Takes a snapshot of the current frame of the video and renders it to a CanvasTexture object,\r\n * which is then returned. You can optionally resize the grab by passing a width and height.\r\n *\r\n * This method returns a reference to the `Video.snapshotTexture` object. Calling this method\r\n * multiple times will overwrite the previous snapshot with the most recent one.\r\n *\r\n * @method Phaser.GameObjects.Video#snapshot\r\n * @since 3.20.0\r\n *\r\n * @param {number} [width] - The width of the resulting CanvasTexture.\r\n * @param {number} [height] - The height of the resulting CanvasTexture.\r\n *\r\n * @return {Phaser.Textures.CanvasTexture} The CanvasTexture the snapshot was drawn to.\r\n */", "meta": { "filename": "Video.js", "lineno": 1313, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Takes a snapshot of the current frame of the video and renders it to a CanvasTexture object,\rwhich is then returned. You can optionally resize the grab by passing a width and height.\r\rThis method returns a reference to the `Video.snapshotTexture` object. Calling this method\rmultiple times will overwrite the previous snapshot with the most recent one.", "kind": "function", "name": "snapshot", "since": "3.20.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The width of the resulting CanvasTexture.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The height of the resulting CanvasTexture.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture" } }, "description": "The CanvasTexture the snapshot was drawn to." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#snapshot", "scope": "instance", "___id": "T000002R018831", "___s": true }, { "comment": "/**\r\n * Takes a snapshot of the specified area of the current frame of the video and renders it to a CanvasTexture object,\r\n * which is then returned. You can optionally resize the grab by passing a different `destWidth` and `destHeight`.\r\n *\r\n * This method returns a reference to the `Video.snapshotTexture` object. Calling this method\r\n * multiple times will overwrite the previous snapshot with the most recent one.\r\n *\r\n * @method Phaser.GameObjects.Video#snapshotArea\r\n * @since 3.20.0\r\n *\r\n * @param {number} [x=0] - The horizontal location of the top-left of the area to grab from.\r\n * @param {number} [y=0] - The vertical location of the top-left of the area to grab from.\r\n * @param {number} [srcWidth] - The width of area to grab from the video. If not given it will grab the full video dimensions.\r\n * @param {number} [srcHeight] - The height of area to grab from the video. If not given it will grab the full video dimensions.\r\n * @param {number} [destWidth] - The destination width of the grab, allowing you to resize it.\r\n * @param {number} [destHeight] - The destination height of the grab, allowing you to resize it.\r\n *\r\n * @return {Phaser.Textures.CanvasTexture} The CanvasTexture the snapshot was drawn to.\r\n */", "meta": { "filename": "Video.js", "lineno": 1336, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Takes a snapshot of the specified area of the current frame of the video and renders it to a CanvasTexture object,\rwhich is then returned. You can optionally resize the grab by passing a different `destWidth` and `destHeight`.\r\rThis method returns a reference to the `Video.snapshotTexture` object. Calling this method\rmultiple times will overwrite the previous snapshot with the most recent one.", "kind": "function", "name": "snapshotArea", "since": "3.20.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The horizontal location of the top-left of the area to grab from.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The vertical location of the top-left of the area to grab from.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The destination width of the grab, allowing you to resize it.", "name": "destWidth" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The destination height of the grab, allowing you to resize it.", "name": "destHeight" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture" } }, "description": "The CanvasTexture the snapshot was drawn to." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#snapshotArea", "scope": "instance", "___id": "T000002R018835", "___s": true }, { "comment": "/**\r\n * Stores a copy of this Videos `snapshotTexture` in the Texture Manager using the given key.\r\n *\r\n * This texture is created when the `snapshot` or `snapshotArea` methods are called.\r\n *\r\n * After doing this, any texture based Game Object, such as a Sprite, can use the contents of the\r\n * snapshot by using the texture key:\r\n *\r\n * ```javascript\r\n * var vid = this.add.video(0, 0, 'intro');\r\n *\r\n * vid.snapshot();\r\n *\r\n * vid.saveSnapshotTexture('doodle');\r\n *\r\n * this.add.image(400, 300, 'doodle');\r\n * ```\r\n *\r\n * Updating the contents of the `snapshotTexture`, for example by calling `snapshot` again,\r\n * will automatically update _any_ Game Object that is using it as a texture.\r\n * Calling `saveSnapshotTexture` again will not save another copy of the same texture,\r\n * it will just rename the existing one.\r\n *\r\n * By default it will create a single base texture. You can add frames to the texture\r\n * by using the `Texture.add` method. After doing this, you can then allow Game Objects\r\n * to use a specific frame.\r\n *\r\n * @method Phaser.GameObjects.Video#saveSnapshotTexture\r\n * @since 3.20.0\r\n *\r\n * @param {string} key - The unique key to store the texture as within the global Texture Manager.\r\n *\r\n * @return {Phaser.Textures.CanvasTexture} The Texture that was saved.\r\n */", "meta": { "filename": "Video.js", "lineno": 1391, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Stores a copy of this Videos `snapshotTexture` in the Texture Manager using the given key.\r\rThis texture is created when the `snapshot` or `snapshotArea` methods are called.\r\rAfter doing this, any texture based Game Object, such as a Sprite, can use the contents of the\rsnapshot by using the texture key:\r\r```javascript\rvar vid = this.add.video(0, 0, 'intro');\r\rvid.snapshot();\r\rvid.saveSnapshotTexture('doodle');\r\rthis.add.image(400, 300, 'doodle');\r```\r\rUpdating the contents of the `snapshotTexture`, for example by calling `snapshot` again,\rwill automatically update _any_ Game Object that is using it as a texture.\rCalling `saveSnapshotTexture` again will not save another copy of the same texture,\rit will just rename the existing one.\r\rBy default it will create a single base texture. You can add frames to the texture\rby using the `Texture.add` method. After doing this, you can then allow Game Objects\rto use a specific frame.", "kind": "function", "name": "saveSnapshotTexture", "since": "3.20.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key to store the texture as within the global Texture Manager.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Textures.CanvasTexture" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.CanvasTexture" } }, "description": "The Texture that was saved." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#saveSnapshotTexture", "scope": "instance", "___id": "T000002R018847", "___s": true }, { "comment": "/**\r\n * This internal method is called automatically if the playback Promise resolves successfully.\r\n *\r\n * @method Phaser.GameObjects.Video#playSuccess\r\n * @fires Phaser.GameObjects.Events#VIDEO_UNLOCKED\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Video.js", "lineno": 1439, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "This internal method is called automatically if the playback Promise resolves successfully.", "kind": "function", "name": "playSuccess", "fires": [ "Phaser.GameObjects.Events#event:VIDEO_UNLOCKED" ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#playSuccess", "scope": "instance", "___id": "T000002R018850", "___s": true }, { "comment": "/**\r\n * This internal method is called automatically if the playback Promise fails to resolve.\r\n *\r\n * @method Phaser.GameObjects.Video#playError\r\n * @fires Phaser.GameObjects.Events#VIDEO_ERROR\r\n * @fires Phaser.GameObjects.Events#VIDEO_UNSUPPORTED\r\n * @fires Phaser.GameObjects.Events#VIDEO_LOCKED\r\n * @since 3.60.0\r\n *\r\n * @param {DOMException} error - The Promise DOM Exception error.\r\n */", "meta": { "filename": "Video.js", "lineno": 1480, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "This internal method is called automatically if the playback Promise fails to resolve.", "kind": "function", "name": "playError", "fires": [ "Phaser.GameObjects.Events#event:VIDEO_ERROR", "Phaser.GameObjects.Events#event:VIDEO_UNSUPPORTED", "Phaser.GameObjects.Events#event:VIDEO_LOCKED" ], "since": "3.60.0", "params": [ { "type": { "names": [ "DOMException" ], "parsedType": { "type": "NameExpression", "name": "DOMException" } }, "description": "The Promise DOM Exception error.", "name": "error" } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#playError", "scope": "instance", "___id": "T000002R018856", "___s": true }, { "comment": "/**\r\n * Called when the video emits a `playing` event.\r\n *\r\n * This is the legacy handler for browsers that don't support Promise based playback.\r\n *\r\n * @method Phaser.GameObjects.Video#legacyPlayHandler\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Video.js", "lineno": 1517, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Called when the video emits a `playing` event.\r\rThis is the legacy handler for browsers that don't support Promise based playback.", "kind": "function", "name": "legacyPlayHandler", "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#legacyPlayHandler", "scope": "instance", "___id": "T000002R018862", "___s": true }, { "comment": "/**\r\n * Called when the video emits a `playing` event.\r\n *\r\n * @method Phaser.GameObjects.Video#playingHandler\r\n * @fires Phaser.GameObjects.Events#VIDEO_PLAYING\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Video.js", "lineno": 1537, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Called when the video emits a `playing` event.", "kind": "function", "name": "playingHandler", "fires": [ "Phaser.GameObjects.Events#event:VIDEO_PLAYING" ], "since": "3.60.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#playingHandler", "scope": "instance", "___id": "T000002R018865", "___s": true }, { "comment": "/**\r\n * This internal method is called automatically if the video fails to load.\r\n *\r\n * @method Phaser.GameObjects.Video#loadErrorHandler\r\n * @fires Phaser.GameObjects.Events#VIDEO_ERROR\r\n * @since 3.20.0\r\n *\r\n * @param {Event} event - The error Event.\r\n */", "meta": { "filename": "Video.js", "lineno": 1551, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "This internal method is called automatically if the video fails to load.", "kind": "function", "name": "loadErrorHandler", "fires": [ "Phaser.GameObjects.Events#event:VIDEO_ERROR" ], "since": "3.20.0", "params": [ { "type": { "names": [ "Event" ], "parsedType": { "type": "NameExpression", "name": "Event" } }, "description": "The error Event.", "name": "event" } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#loadErrorHandler", "scope": "instance", "___id": "T000002R018868", "___s": true }, { "comment": "/**\r\n * This internal method is called automatically when the video metadata is available.\r\n *\r\n * @method Phaser.GameObjects.Video#metadataHandler\r\n * @fires Phaser.GameObjects.Events#VIDEO_METADATA\r\n * @since 3.80.0\r\n *\r\n * @param {Event} event - The loadedmetadata Event.\r\n */", "meta": { "filename": "Video.js", "lineno": 1567, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "This internal method is called automatically when the video metadata is available.", "kind": "function", "name": "metadataHandler", "fires": [ "Phaser.GameObjects.Events#event:VIDEO_METADATA" ], "since": "3.80.0", "params": [ { "type": { "names": [ "Event" ], "parsedType": { "type": "NameExpression", "name": "Event" } }, "description": "The loadedmetadata Event.", "name": "event" } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#metadataHandler", "scope": "instance", "___id": "T000002R018870", "___s": true }, { "comment": "/**\r\n * Sets the size of this Game Object to be that of the given Frame.\r\n *\r\n * This will not change the size that the Game Object is rendered in-game.\r\n * For that you need to either set the scale of the Game Object (`setScale`) or call the\r\n * `setDisplaySize` method, which is the same thing as changing the scale but allows you\r\n * to do so by giving pixel values.\r\n *\r\n * If you have enabled this Game Object for input, changing the size will _not_ change the\r\n * size of the hit area. To do this you should adjust the `input.hitArea` object directly.\r\n *\r\n * @method Phaser.GameObjects.Video#setSizeToFrame\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Textures.Frame|boolean} [frame] - The frame to base the size of this Game Object on.\r\n *\r\n * @return {this} This Game Object instance.\r\n */", "meta": { "filename": "Video.js", "lineno": 1581, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Sets the size of this Game Object to be that of the given Frame.\r\rThis will not change the size that the Game Object is rendered in-game.\rFor that you need to either set the scale of the Game Object (`setScale`) or call the\r`setDisplaySize` method, which is the same thing as changing the scale but allows you\rto do so by giving pixel values.\r\rIf you have enabled this Game Object for input, changing the size will _not_ change the\rsize 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", "boolean" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Textures.Frame" }, { "type": "NameExpression", "name": "boolean" } ] } }, "optional": true, "description": "The frame to base the size of this Game Object on.", "name": "frame" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object instance." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#setSizeToFrame", "scope": "instance", "___id": "T000002R018872", "___s": true }, { "comment": "/**\r\n * This internal method is called automatically if the video stalls, for whatever reason.\r\n *\r\n * @method Phaser.GameObjects.Video#stalledHandler\r\n * @fires Phaser.GameObjects.Events#VIDEO_STALLED\r\n * @since 3.60.0\r\n *\r\n * @param {Event} event - The stall Event.\r\n */", "meta": { "filename": "Video.js", "lineno": 1627, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "This internal method is called automatically if the video stalls, for whatever reason.", "kind": "function", "name": "stalledHandler", "fires": [ "Phaser.GameObjects.Events#event:VIDEO_STALLED" ], "since": "3.60.0", "params": [ { "type": { "names": [ "Event" ], "parsedType": { "type": "NameExpression", "name": "Event" } }, "description": "The stall Event.", "name": "event" } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#stalledHandler", "scope": "instance", "___id": "T000002R018882", "___s": true }, { "comment": "/**\r\n * Called when the video completes playback, i.e. reaches an `ended` state.\r\n *\r\n * This will never happen if the video is coming from a live stream, where the duration is `Infinity`.\r\n *\r\n * @method Phaser.GameObjects.Video#completeHandler\r\n * @fires Phaser.GameObjects.Events#VIDEO_COMPLETE\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Video.js", "lineno": 1643, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Called when the video completes playback, i.e. reaches an `ended` state.\r\rThis 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", "___id": "T000002R018885", "___s": true }, { "comment": "/**\r\n * Seeks to a given point in the video. The value is given as a float between 0 and 1,\r\n * where 0 represents the start of the video and 1 represents the end.\r\n *\r\n * Seeking only works if the video has a duration, so will not work for live streams.\r\n *\r\n * When seeking begins, this video will emit a `seeking` event. When the video completes\r\n * seeking (i.e. reaches its designated timestamp) it will emit a `seeked` event.\r\n *\r\n * If you wish to seek based on time instead, use the `Video.setCurrentTime` method.\r\n *\r\n * Unfortunately, the DOM video element does not guarantee frame-accurate seeking.\r\n * This has been an ongoing subject of discussion: https://github.com/w3c/media-and-entertainment/issues/4\r\n *\r\n * @method Phaser.GameObjects.Video#seekTo\r\n * @since 3.20.0\r\n *\r\n * @param {number} value - The point in the video to seek to. A value between 0 and 1.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 1691, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Seeks to a given point in the video. The value is given as a float between 0 and 1,\rwhere 0 represents the start of the video and 1 represents the end.\r\rSeeking only works if the video has a duration, so will not work for live streams.\r\rWhen seeking begins, this video will emit a `seeking` event. When the video completes\rseeking (i.e. reaches its designated timestamp) it will emit a `seeked` event.\r\rIf you wish to seek based on time instead, use the `Video.setCurrentTime` method.\r\rUnfortunately, the DOM video element does not guarantee frame-accurate seeking.\rThis has been an ongoing subject of discussion: https://github.com/w3c/media-and-entertainment/issues/4", "kind": "function", "name": "seekTo", "since": "3.20.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The point in the video to seek to. A value between 0 and 1.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#seekTo", "scope": "instance", "___id": "T000002R018893", "___s": true }, { "comment": "/**\r\n * A double-precision floating-point value indicating the current playback time in seconds.\r\n *\r\n * If the media has not started to play and has not been seeked, this value is the media's initial playback time.\r\n *\r\n * For a more accurate value, use the `Video.metadata.mediaTime` property instead.\r\n *\r\n * @method Phaser.GameObjects.Video#getCurrentTime\r\n * @since 3.20.0\r\n *\r\n * @return {number} A double-precision floating-point value indicating the current playback time in seconds.\r\n */", "meta": { "filename": "Video.js", "lineno": 1731, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "A double-precision floating-point value indicating the current playback time in seconds.\r\rIf the media has not started to play and has not been seeked, this value is the media's initial playback time.\r\rFor a more accurate value, use the `Video.metadata.mediaTime` property instead.", "kind": "function", "name": "getCurrentTime", "since": "3.20.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R018898", "___s": true }, { "comment": "/**\r\n * Seeks to a given playback time in the video. The value is given in _seconds_ or as a string.\r\n *\r\n * Seeking only works if the video has a duration, so will not work for live streams.\r\n *\r\n * When seeking begins, this video will emit a `seeking` event. When the video completes\r\n * seeking (i.e. reaches its designated timestamp) it will emit a `seeked` event.\r\n *\r\n * You can provide a string prefixed with either a `+` or a `-`, such as `+2.5` or `-2.5`.\r\n * In this case it will seek to +/- the value given, relative to the _current time_.\r\n *\r\n * If you wish to seek based on a duration percentage instead, use the `Video.seekTo` method.\r\n *\r\n * @method Phaser.GameObjects.Video#setCurrentTime\r\n * @since 3.20.0\r\n *\r\n * @param {(string|number)} value - 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.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 1748, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Seeks to a given playback time in the video. The value is given in _seconds_ or as a string.\r\rSeeking only works if the video has a duration, so will not work for live streams.\r\rWhen seeking begins, this video will emit a `seeking` event. When the video completes\rseeking (i.e. reaches its designated timestamp) it will emit a `seeked` event.\r\rYou can provide a string prefixed with either a `+` or a `-`, such as `+2.5` or `-2.5`.\rIn this case it will seek to +/- the value given, relative to the _current time_.\r\rIf 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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#setCurrentTime", "scope": "instance", "___id": "T000002R018900", "___s": true }, { "comment": "/**\r\n * Returns the current progress of the video as a float.\r\n *\r\n * Progress is defined as a value between 0 (the start) and 1 (the end).\r\n *\r\n * Progress can only be returned if the video has a duration. Some videos,\r\n * such as those coming from a live stream, do not have a duration. In this\r\n * case the method will return -1.\r\n *\r\n * @method Phaser.GameObjects.Video#getProgress\r\n * @since 3.20.0\r\n *\r\n * @return {number} The current progress of playback. If the video has no duration, will always return -1.\r\n */", "meta": { "filename": "Video.js", "lineno": 1825, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Returns the current progress of the video as a float.\r\rProgress is defined as a value between 0 (the start) and 1 (the end).\r\rProgress can only be returned if the video has a duration. Some videos,\rsuch as those coming from a live stream, do not have a duration. In this\rcase the method will return -1.", "kind": "function", "name": "getProgress", "since": "3.20.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The current progress of playback. If the video has no duration, will always return -1." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#getProgress", "scope": "instance", "___id": "T000002R018914", "___s": true }, { "comment": "/**\r\n * A double-precision floating-point value which indicates the duration (total length) of the media in seconds,\r\n * on the media's timeline. If no media is present on the element, or the media is not valid, the returned value is NaN.\r\n *\r\n * If the media has no known end (such as for live streams of unknown duration, web radio, media incoming from WebRTC,\r\n * and so forth), this value is +Infinity.\r\n *\r\n * If no video has been loaded, this method will return 0.\r\n *\r\n * @method Phaser.GameObjects.Video#getDuration\r\n * @since 3.20.0\r\n *\r\n * @return {number} A double-precision floating-point value indicating the duration of the media in seconds.\r\n */", "meta": { "filename": "Video.js", "lineno": 1856, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "A double-precision floating-point value which indicates the duration (total length) of the media in seconds,\ron the media's timeline. If no media is present on the element, or the media is not valid, the returned value is NaN.\r\rIf the media has no known end (such as for live streams of unknown duration, web radio, media incoming from WebRTC,\rand so forth), this value is +Infinity.\r\rIf no video has been loaded, this method will return 0.", "kind": "function", "name": "getDuration", "since": "3.20.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R018918", "___s": true }, { "comment": "/**\r\n * Sets the muted state of the currently playing video, if one is loaded.\r\n *\r\n * @method Phaser.GameObjects.Video#setMute\r\n * @since 3.20.0\r\n *\r\n * @param {boolean} [value=true] - The mute value. `true` if the video should be muted, otherwise `false`.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 1875, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "The mute value. `true` if the video should be muted, otherwise `false`.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#setMute", "scope": "instance", "___id": "T000002R018920", "___s": true }, { "comment": "/**\r\n * Returns a boolean indicating if this Video is currently muted.\r\n *\r\n * @method Phaser.GameObjects.Video#isMuted\r\n * @since 3.20.0\r\n *\r\n * @return {boolean} A boolean indicating if this Video is currently muted, or not.\r\n */", "meta": { "filename": "Video.js", "lineno": 1901, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Returns a boolean indicating if this Video is currently muted.", "kind": "function", "name": "isMuted", "since": "3.20.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "A boolean indicating if this Video is currently muted, or not." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#isMuted", "scope": "instance", "___id": "T000002R018926", "___s": true }, { "comment": "/**\r\n * Sets the paused state of the currently loaded video.\r\n *\r\n * If the video is playing, calling this method with `true` will pause playback.\r\n * If the video is paused, calling this method with `false` will resume playback.\r\n *\r\n * If no video is loaded, this method does nothing.\r\n *\r\n * If the video has not yet been played, `Video.play` will be called with no parameters.\r\n *\r\n * If the video has ended, this method will do nothing.\r\n *\r\n * @method Phaser.GameObjects.Video#setPaused\r\n * @since 3.20.0\r\n *\r\n * @param {boolean} [value=true] - The paused value. `true` if the video should be paused, `false` to resume it.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 1972, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Sets the paused state of the currently loaded video.\r\rIf the video is playing, calling this method with `true` will pause playback.\rIf the video is paused, calling this method with `false` will resume playback.\r\rIf no video is loaded, this method does nothing.\r\rIf the video has not yet been played, `Video.play` will be called with no parameters.\r\rIf the video has ended, this method will do nothing.", "kind": "function", "name": "setPaused", "since": "3.20.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#setPaused", "scope": "instance", "___id": "T000002R018939", "___s": true }, { "comment": "/**\r\n * Pauses the current Video, if one is playing.\r\n *\r\n * If no video is loaded, this method does nothing.\r\n *\r\n * Call `Video.resume` to resume playback.\r\n *\r\n * @method Phaser.GameObjects.Video#pause\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 2026, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Pauses the current Video, if one is playing.\r\rIf no video is loaded, this method does nothing.\r\rCall `Video.resume` to resume playback.", "kind": "function", "name": "pause", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#pause", "scope": "instance", "___id": "T000002R018944", "___s": true }, { "comment": "/**\r\n * Resumes the current Video, if one was previously playing and has been paused.\r\n *\r\n * If no video is loaded, this method does nothing.\r\n *\r\n * Call `Video.pause` to pause playback.\r\n *\r\n * @method Phaser.GameObjects.Video#resume\r\n * @since 3.60.0\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 2043, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Resumes the current Video, if one was previously playing and has been paused.\r\rIf no video is loaded, this method does nothing.\r\rCall `Video.pause` to pause playback.", "kind": "function", "name": "resume", "since": "3.60.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#resume", "scope": "instance", "___id": "T000002R018946", "___s": true }, { "comment": "/**\r\n * Returns a double indicating the audio volume, from 0.0 (silent) to 1.0 (loudest).\r\n *\r\n * @method Phaser.GameObjects.Video#getVolume\r\n * @since 3.20.0\r\n *\r\n * @return {number} A double indicating the audio volume, from 0.0 (silent) to 1.0 (loudest).\r\n */", "meta": { "filename": "Video.js", "lineno": 2060, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R018948", "___s": true }, { "comment": "/**\r\n * Sets the volume of the currently playing video.\r\n *\r\n * The value given is a double indicating the audio volume, from 0.0 (silent) to 1.0 (loudest).\r\n *\r\n * @method Phaser.GameObjects.Video#setVolume\r\n * @since 3.20.0\r\n *\r\n * @param {number} [value=1] - A double indicating the audio volume, from 0.0 (silent) to 1.0 (loudest).\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 2073, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Sets the volume of the currently playing video.\r\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#setVolume", "scope": "instance", "___id": "T000002R018950", "___s": true }, { "comment": "/**\r\n * Returns a double that indicates the rate at which the media is being played back.\r\n *\r\n * @method Phaser.GameObjects.Video#getPlaybackRate\r\n * @since 3.20.0\r\n *\r\n * @return {number} A double that indicates the rate at which the media is being played back.\r\n */", "meta": { "filename": "Video.js", "lineno": 2097, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R018954", "___s": true }, { "comment": "/**\r\n * Sets the playback rate of the current video.\r\n *\r\n * The value given is a double that indicates the rate at which the media is being played back.\r\n *\r\n * @method Phaser.GameObjects.Video#setPlaybackRate\r\n * @since 3.20.0\r\n *\r\n * @param {number} [rate] - A double that indicates the rate at which the media is being played back.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 2110, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Sets the playback rate of the current video.\r\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "A double that indicates the rate at which the media is being played back.", "name": "rate" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#setPlaybackRate", "scope": "instance", "___id": "T000002R018956", "___s": true }, { "comment": "/**\r\n * Returns a boolean which indicates whether the media element should start over when it reaches the end.\r\n *\r\n * @method Phaser.GameObjects.Video#getLoop\r\n * @since 3.20.0\r\n *\r\n * @return {boolean} A boolean which indicates whether the media element will start over when it reaches the end.\r\n */", "meta": { "filename": "Video.js", "lineno": 2132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R018959", "___s": true }, { "comment": "/**\r\n * Sets the loop state of the current video.\r\n *\r\n * The value given is a boolean which indicates whether the media element will start over when it reaches the end.\r\n *\r\n * Not all videos can loop, for example live streams.\r\n *\r\n * Please note that not all browsers support _seamless_ video looping for all encoding formats.\r\n *\r\n * @method Phaser.GameObjects.Video#setLoop\r\n * @since 3.20.0\r\n *\r\n * @param {boolean} [value=true] - A boolean which indicates whether the media element will start over when it reaches the end.\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 2145, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Sets the loop state of the current video.\r\rThe value given is a boolean which indicates whether the media element will start over when it reaches the end.\r\rNot all videos can loop, for example live streams.\r\rPlease 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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#setLoop", "scope": "instance", "___id": "T000002R018961", "___s": true }, { "comment": "/**\r\n * Returns a boolean which indicates whether the video is currently playing.\r\n *\r\n * @method Phaser.GameObjects.Video#isPlaying\r\n * @since 3.20.0\r\n *\r\n * @return {boolean} A boolean which indicates whether the video is playing, or not.\r\n */", "meta": { "filename": "Video.js", "lineno": 2173, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Returns a boolean which indicates whether the video is currently playing.", "kind": "function", "name": "isPlaying", "since": "3.20.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "A boolean which indicates whether the video is playing, or not." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#isPlaying", "scope": "instance", "___id": "T000002R018965", "___s": true }, { "comment": "/**\r\n * Returns a boolean which indicates whether the video is currently paused.\r\n *\r\n * @method Phaser.GameObjects.Video#isPaused\r\n * @since 3.20.0\r\n *\r\n * @return {boolean} A boolean which indicates whether the video is paused, or not.\r\n */", "meta": { "filename": "Video.js", "lineno": 2186, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Returns a boolean which indicates whether the video is currently paused.", "kind": "function", "name": "isPaused", "since": "3.20.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "A boolean which indicates whether the video is paused, or not." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#isPaused", "scope": "instance", "___id": "T000002R018967", "___s": true }, { "comment": "/**\r\n * Stores this Video in the Texture Manager using the given key as a dynamic texture,\r\n * which any texture-based Game Object, such as a Sprite, can use as its source:\r\n *\r\n * ```javascript\r\n * const vid = this.add.video(0, 0, 'intro');\r\n *\r\n * vid.play();\r\n *\r\n * vid.saveTexture('doodle');\r\n *\r\n * this.add.image(400, 300, 'doodle');\r\n * ```\r\n *\r\n * If the video is not yet playing then you need to listen for the `TEXTURE_READY` event before\r\n * you can use this texture on a Game Object:\r\n *\r\n * ```javascript\r\n * const vid = this.add.video(0, 0, 'intro');\r\n *\r\n * vid.play();\r\n *\r\n * vid.once('textureready', (video, texture, key) => {\r\n *\r\n * this.add.image(400, 300, key);\r\n *\r\n * });\r\n *\r\n * vid.saveTexture('doodle');\r\n * ```\r\n *\r\n * The saved texture is automatically updated as the video plays. If you pause this video,\r\n * or change its source, then the saved texture updates instantly.\r\n *\r\n * Calling `saveTexture` again will not save another copy of the same texture, it will just rename the existing one.\r\n *\r\n * By default it will create a single base texture. You can add frames to the texture\r\n * by using the `Texture.add` method. After doing this, you can then allow Game Objects\r\n * to use a specific frame.\r\n *\r\n * If you intend to save the texture so you can use it as the input for a Shader, you may need to toggle the\r\n * `flipY` parameter if you find the video renders upside down in your shader.\r\n *\r\n * @method Phaser.GameObjects.Video#saveTexture\r\n * @since 3.20.0\r\n *\r\n * @param {string} key - The unique key to store the texture as within the global Texture Manager.\r\n * @param {boolean} [flipY=true] - Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y` during upload?\r\n *\r\n * @return {boolean} Returns `true` if the texture is available immediately, otherwise returns `false` and you should listen for the `TEXTURE_READY` event.\r\n */", "meta": { "filename": "Video.js", "lineno": 2199, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Stores this Video in the Texture Manager using the given key as a dynamic texture,\rwhich any texture-based Game Object, such as a Sprite, can use as its source:\r\r```javascript\rconst vid = this.add.video(0, 0, 'intro');\r\rvid.play();\r\rvid.saveTexture('doodle');\r\rthis.add.image(400, 300, 'doodle');\r```\r\rIf the video is not yet playing then you need to listen for the `TEXTURE_READY` event before\ryou can use this texture on a Game Object:\r\r```javascript\rconst vid = this.add.video(0, 0, 'intro');\r\rvid.play();\r\rvid.once('textureready', (video, texture, key) => {\r\r this.add.image(400, 300, key);\r\r});\r\rvid.saveTexture('doodle');\r```\r\rThe saved texture is automatically updated as the video plays. If you pause this video,\ror change its source, then the saved texture updates instantly.\r\rCalling `saveTexture` again will not save another copy of the same texture, it will just rename the existing one.\r\rBy default it will create a single base texture. You can add frames to the texture\rby using the `Texture.add` method. After doing this, you can then allow Game Objects\rto use a specific frame.\r\rIf you intend to save the texture so you can use it as the input for a Shader, you may need to toggle the\r`flipY` parameter if you find the video renders upside down in your shader.", "kind": "function", "name": "saveTexture", "since": "3.20.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key to store the texture as within the global Texture Manager.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the WebGL Texture set `UNPACK_MULTIPLY_FLIP_Y` during upload?", "name": "flipY" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns `true` if the texture is available immediately, otherwise returns `false` and you should listen for the `TEXTURE_READY` event." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#saveTexture", "scope": "instance", "___id": "T000002R018969", "___s": true }, { "comment": "/**\r\n * Stops the video playing and clears all internal event listeners.\r\n *\r\n * If you only wish to pause playback of the video, and resume it a later time, use the `Video.pause` method instead.\r\n *\r\n * If the video hasn't finished downloading, calling this method will not abort the download. To do that you need to\r\n * call `destroy` instead.\r\n *\r\n * @method Phaser.GameObjects.Video#stop\r\n * @fires Phaser.GameObjects.Events#VIDEO_STOP\r\n * @since 3.20.0\r\n *\r\n * @param {boolean} [emitStopEvent=true] - Should the `VIDEO_STOP` event be emitted?\r\n *\r\n * @return {this} This Video Game Object for method chaining.\r\n */", "meta": { "filename": "Video.js", "lineno": 2266, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Stops the video playing and clears all internal event listeners.\r\rIf you only wish to pause playback of the video, and resume it a later time, use the `Video.pause` method instead.\r\rIf the video hasn't finished downloading, calling this method will not abort the download. To do that you need to\rcall `destroy` instead.", "kind": "function", "name": "stop", "fires": [ "Phaser.GameObjects.Events#event:VIDEO_STOP" ], "since": "3.20.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "Should the `VIDEO_STOP` event be emitted?", "name": "emitStopEvent" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Video Game Object for method chaining." } ], "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#stop", "scope": "instance", "___id": "T000002R018974", "___s": true }, { "comment": "/**\r\n * Removes the Video element from the DOM by calling parentNode.removeChild on itself.\r\n *\r\n * Also removes the autoplay and src attributes and nulls the `Video.video` reference.\r\n *\r\n * If you loaded an external video via `Video.loadURL` then you should call this function\r\n * to clear up once you are done with the instance, but don't want to destroy this\r\n * Video Game Object.\r\n *\r\n * This method is called automatically by `Video.destroy`.\r\n *\r\n * @method Phaser.GameObjects.Video#removeVideoElement\r\n * @since 3.20.0\r\n */", "meta": { "filename": "Video.js", "lineno": 2308, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Removes the Video element from the DOM by calling parentNode.removeChild on itself.\r\rAlso removes the autoplay and src attributes and nulls the `Video.video` reference.\r\rIf you loaded an external video via `Video.loadURL` then you should call this function\rto clear up once you are done with the instance, but don't want to destroy this\rVideo Game Object.\r\rThis method is called automatically by `Video.destroy`.", "kind": "function", "name": "removeVideoElement", "since": "3.20.0", "memberof": "Phaser.GameObjects.Video", "longname": "Phaser.GameObjects.Video#removeVideoElement", "scope": "instance", "___id": "T000002R018980", "___s": true }, { "comment": "/**\r\n * Creates a new Video Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Video Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#video\r\n * @since 3.20.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Video.VideoConfig} config - The configuration object this Game Object will use to create itself.\r\n * @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.\r\n *\r\n * @return {Phaser.GameObjects.Video} The Game Object that was created.\r\n */", "meta": { "filename": "VideoCreator.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Creates a new Video Game Object and returns it.\r\rNote: 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": [ "Phaser.Types.GameObjects.Video.VideoConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Video.VideoConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Video" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#video", "scope": "instance", "___id": "T000002R018996", "___s": true }, { "comment": "/**\r\n * Creates a new Video Game Object and adds it to the Scene.\r\n *\r\n * This Game Object is capable of handling playback of a video file, video stream or media stream.\r\n *\r\n * You can optionally 'preload' the video into the Phaser Video Cache:\r\n *\r\n * ```javascript\r\n * preload () {\r\n * this.load.video('ripley', 'assets/aliens.mp4');\r\n * }\r\n *\r\n * create () {\r\n * this.add.video(400, 300, 'ripley');\r\n * }\r\n * ```\r\n *\r\n * You don't have to 'preload' the video. You can also play it directly from a URL:\r\n *\r\n * ```javascript\r\n * create () {\r\n * this.add.video(400, 300).loadURL('assets/aliens.mp4');\r\n * }\r\n * ```\r\n *\r\n * To all intents and purposes, a video is a standard Game Object, just like a Sprite. And as such, you can do\r\n * all the usual things to it, such as scaling, rotating, cropping, tinting, making interactive, giving a\r\n * physics body, etc.\r\n *\r\n * Transparent videos are also possible via the WebM file format. Providing the video file has been encoded with\r\n * an alpha channel, and providing the browser supports WebM playback (not all of them do), then it will render\r\n * in-game with full transparency.\r\n *\r\n * ### Autoplaying Videos\r\n *\r\n * Videos can only autoplay if the browser has been unlocked with an interaction, or satisfies the MEI settings.\r\n * The policies that control autoplaying are vast and vary between browser. You can, and should, read more about\r\n * it here: https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide\r\n *\r\n * If your video doesn't contain any audio, then set the `noAudio` parameter to `true` when the video is _loaded_,\r\n * and it will often allow the video to play immediately:\r\n *\r\n * ```javascript\r\n * preload () {\r\n * this.load.video('pixar', 'nemo.mp4', true);\r\n * }\r\n * ```\r\n *\r\n * The 3rd parameter in the load call tells Phaser that the video doesn't contain any audio tracks. Video without\r\n * audio can autoplay without requiring a user interaction. Video with audio cannot do this unless it satisfies\r\n * the browsers MEI settings. See the MDN Autoplay Guide for further details.\r\n *\r\n * Or:\r\n *\r\n * ```javascript\r\n * create () {\r\n * this.add.video(400, 300).loadURL('assets/aliens.mp4', true);\r\n * }\r\n * ```\r\n *\r\n * You can set the `noAudio` parameter to `true` even if the video does contain audio. It will still allow the video\r\n * to play immediately, but the audio will not start.\r\n *\r\n * More details about video playback and the supported media formats can be found on MDN:\r\n *\r\n * https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement\r\n * https://developer.mozilla.org/en-US/docs/Web/Media/Formats\r\n *\r\n * Note: This method will only be available if the Video Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#video\r\n * @since 3.20.0\r\n *\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {string} [key] - Optional key of the Video this Game Object will play, as stored in the Video Cache.\r\n *\r\n * @return {Phaser.GameObjects.Video} The Game Object that was created.\r\n */", "meta": { "filename": "VideoFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\video", "code": {} }, "description": "Creates a new Video Game Object and adds it to the Scene.\r\rThis Game Object is capable of handling playback of a video file, video stream or media stream.\r\rYou can optionally 'preload' the video into the Phaser Video Cache:\r\r```javascript\rpreload () {\r this.load.video('ripley', 'assets/aliens.mp4');\r}\r\rcreate () {\r this.add.video(400, 300, 'ripley');\r}\r```\r\rYou don't have to 'preload' the video. You can also play it directly from a URL:\r\r```javascript\rcreate () {\r this.add.video(400, 300).loadURL('assets/aliens.mp4');\r}\r```\r\rTo all intents and purposes, a video is a standard Game Object, just like a Sprite. And as such, you can do\rall the usual things to it, such as scaling, rotating, cropping, tinting, making interactive, giving a\rphysics body, etc.\r\rTransparent videos are also possible via the WebM file format. Providing the video file has been encoded with\ran alpha channel, and providing the browser supports WebM playback (not all of them do), then it will render\rin-game with full transparency.\r\r### Autoplaying Videos\r\rVideos can only autoplay if the browser has been unlocked with an interaction, or satisfies the MEI settings.\rThe policies that control autoplaying are vast and vary between browser. You can, and should, read more about\rit here: https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide\r\rIf your video doesn't contain any audio, then set the `noAudio` parameter to `true` when the video is _loaded_,\rand it will often allow the video to play immediately:\r\r```javascript\rpreload () {\r this.load.video('pixar', 'nemo.mp4', true);\r}\r```\r\rThe 3rd parameter in the load call tells Phaser that the video doesn't contain any audio tracks. Video without\raudio can autoplay without requiring a user interaction. Video with audio cannot do this unless it satisfies\rthe browsers MEI settings. See the MDN Autoplay Guide for further details.\r\rOr:\r\r```javascript\rcreate () {\r this.add.video(400, 300).loadURL('assets/aliens.mp4', true);\r}\r```\r\rYou can set the `noAudio` parameter to `true` even if the video does contain audio. It will still allow the video\rto play immediately, but the audio will not start.\r\rMore details about video playback and the supported media formats can be found on MDN:\r\rhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement\rhttps://developer.mozilla.org/en-US/docs/Web/Media/Formats\r\rNote: 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": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "Optional key of the Video this Game Object will play, as stored in the Video Cache.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Video" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Video" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#video", "scope": "instance", "___id": "T000002R019003", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.GameObjects.Zone\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone\\typedefs", "code": {} }, "kind": "namespace", "name": "Zone", "memberof": "Phaser.Types.GameObjects", "longname": "Phaser.Types.GameObjects.Zone", "scope": "static", "___id": "T000002R019017", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.GameObjects.Zone.ZoneConfig\r\n * @extends Phaser.Types.GameObjects.GameObjectConfig\r\n * @since 3.50.0\r\n *\r\n * @property {number} [width=1] - The width of the Game Object.\r\n * @property {number} [height=1] - The height of the Game Object.\r\n */", "meta": { "filename": "ZoneConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone\\typedefs", "code": {} }, "kind": "typedef", "name": "ZoneConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "augments": [ "Phaser.Types.GameObjects.GameObjectConfig" ], "since": "3.50.0", "properties": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The height of the Game Object.", "name": "height" } ], "memberof": "Phaser.Types.GameObjects.Zone", "longname": "Phaser.Types.GameObjects.Zone.ZoneConfig", "scope": "static", "___id": "T000002R019018", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Zone is a non-rendering rectangular Game Object that has a position and size but no texture.\r\n * It never displays visually, but it does live on the display list and can be moved, scaled,\r\n * and rotated like any other Game Object.\r\n *\r\n * Its primary use is for creating Drop Zones and Input Hit Areas. It provides helper methods for\r\n * both circular and rectangular drop zones, and can also accept custom geometry shapes. Zones are\r\n * also useful for object overlap checks, or as a base class for your own non-displaying Game Objects.\r\n *\r\n * The default origin is 0.5, placing it at the center of the Zone, consistent with other Game Objects.\r\n *\r\n * @class Zone\r\n * @extends Phaser.GameObjects.GameObject\r\n * @memberof Phaser.GameObjects\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @extends Phaser.GameObjects.Components.Depth\r\n * @extends Phaser.GameObjects.Components.GetBounds\r\n * @extends Phaser.GameObjects.Components.Origin\r\n * @extends Phaser.GameObjects.Components.Transform\r\n * @extends Phaser.GameObjects.Components.ScrollFactor\r\n * @extends Phaser.GameObjects.Components.Visible\r\n *\r\n * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {number} [width=1] - The width of the Game Object.\r\n * @param {number} [height=1] - The height of the Game Object.\r\n */", "meta": { "filename": "Zone.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "classdesc": "A Zone is a non-rendering rectangular Game Object that has a position and size but no texture.\rIt never displays visually, but it does live on the display list and can be moved, scaled,\rand rotated like any other Game Object.\r\rIts primary use is for creating Drop Zones and Input Hit Areas. It provides helper methods for\rboth circular and rectangular drop zones, and can also accept custom geometry shapes. Zones are\ralso useful for object overlap checks, or as a base class for your own non-displaying Game Objects.\r\rThe default origin is 0.5, placing it at the center of the Zone, consistent with other 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "The Scene to which this Game Object belongs.", "name": "scene" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The height of the Game Object.", "name": "height" } ], "scope": "static", "longname": "Phaser.GameObjects.Zone", "___id": "T000002R019027", "___s": true }, { "comment": "/**\r\n * The native (un-scaled) width of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Zone#width\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Zone.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "description": "The native (un-scaled) width of this Game Object.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "longname": "Phaser.GameObjects.Zone#width", "scope": "instance", "kind": "member", "___id": "T000002R019034", "___s": true }, { "comment": "/**\r\n * The native (un-scaled) height of this Game Object.\r\n *\r\n * @name Phaser.GameObjects.Zone#height\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Zone.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "description": "The native (un-scaled) height of this Game Object.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "longname": "Phaser.GameObjects.Zone#height", "scope": "instance", "kind": "member", "___id": "T000002R019036", "___s": true }, { "comment": "/**\r\n * The Blend Mode of the Game Object.\r\n * Although a Zone never renders, it still has a blend mode to allow it to fit seamlessly into\r\n * display lists without causing a batch flush.\r\n *\r\n * @name Phaser.GameObjects.Zone#blendMode\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Zone.js", "lineno": 89, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "description": "The Blend Mode of the Game Object.\rAlthough a Zone never renders, it still has a blend mode to allow it to fit seamlessly into\rdisplay lists without causing a batch flush.", "name": "blendMode", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "longname": "Phaser.GameObjects.Zone#blendMode", "scope": "instance", "kind": "member", "___id": "T000002R019038", "___s": true }, { "comment": "/**\r\n * The displayed width of this Game Object.\r\n * This value takes into account the scale factor.\r\n *\r\n * @name Phaser.GameObjects.Zone#displayWidth\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Zone.js", "lineno": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "description": "The displayed width of this Game Object.\rThis value takes into account the scale factor.", "name": "displayWidth", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "longname": "Phaser.GameObjects.Zone#displayWidth", "scope": "instance", "kind": "member", "___id": "T000002R019040", "___s": true }, { "comment": "/**\r\n * The displayed height of this Game Object.\r\n * This value takes into account the scale factor.\r\n *\r\n * @name Phaser.GameObjects.Zone#displayHeight\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Zone.js", "lineno": 125, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "description": "The displayed height of this Game Object.\rThis value takes into account the scale factor.", "name": "displayHeight", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.GameObjects.Zone", "longname": "Phaser.GameObjects.Zone#displayHeight", "scope": "instance", "kind": "member", "___id": "T000002R019045", "___s": true }, { "comment": "/**\r\n * Sets the native (un-scaled) width and height of this Zone. Also updates the display origin\r\n * and, by default, resizes any non-custom input hit area associated with this Zone.\r\n *\r\n * @method Phaser.GameObjects.Zone#setSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width of this Game Object.\r\n * @param {number} height - The height of this Game Object.\r\n * @param {boolean} [resizeInput=true] - If this Zone has a Rectangle for a hit area this argument will resize the hit area as well.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Zone.js", "lineno": 147, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "description": "Sets the native (un-scaled) width and height of this Zone. Also updates the display origin\rand, by default, resizes any non-custom input hit area associated with this Zone.", "kind": "function", "name": "setSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Game Object.", "name": "height" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Zone", "longname": "Phaser.GameObjects.Zone#setSize", "scope": "instance", "___id": "T000002R019050", "___s": true }, { "comment": "/**\r\n * Sets the display size of this Game Object.\r\n * Calling this will adjust the scale.\r\n *\r\n * @method Phaser.GameObjects.Zone#setDisplaySize\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width of this Game Object.\r\n * @param {number} height - The height of this Game Object.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Zone.js", "lineno": 180, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "description": "Sets the display size of this Game Object.\rCalling this will adjust the scale.", "kind": "function", "name": "setDisplaySize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of this Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of this Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Zone", "longname": "Phaser.GameObjects.Zone#setDisplaySize", "scope": "instance", "___id": "T000002R019058", "___s": true }, { "comment": "/**\r\n * Sets this Zone to be a Circular Drop Zone.\r\n * The circle is centered on this Zone's `x` and `y` coordinates.\r\n *\r\n * @method Phaser.GameObjects.Zone#setCircleDropZone\r\n * @since 3.0.0\r\n *\r\n * @param {number} radius - The radius of the Circle that will form the Drop Zone.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Zone.js", "lineno": 200, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "description": "Sets this Zone to be a Circular Drop Zone.\rThe circle is centered on this Zone's `x` and `y` coordinates.", "kind": "function", "name": "setCircleDropZone", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the Circle that will form the Drop Zone.", "name": "radius" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Zone", "longname": "Phaser.GameObjects.Zone#setCircleDropZone", "scope": "instance", "___id": "T000002R019062", "___s": true }, { "comment": "/**\r\n * Sets this Zone to be a Rectangle Drop Zone.\r\n * The rectangle is centered on this Zone's `x` and `y` coordinates.\r\n *\r\n * @method Phaser.GameObjects.Zone#setRectangleDropZone\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width of the rectangle drop zone.\r\n * @param {number} height - The height of the rectangle drop zone.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Zone.js", "lineno": 216, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "description": "Sets this Zone to be a Rectangle Drop Zone.\rThe rectangle is centered on this Zone's `x` and `y` coordinates.", "kind": "function", "name": "setRectangleDropZone", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the rectangle drop zone.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the rectangle drop zone.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Zone", "longname": "Phaser.GameObjects.Zone#setRectangleDropZone", "scope": "instance", "___id": "T000002R019064", "___s": true }, { "comment": "/**\r\n * Enables this Zone as an interactive Drop Zone by calling `setInteractive` with the given\r\n * hit area shape and callback. You can pass any Phaser geometry shape, or a custom shape with\r\n * a matching hit-test callback. If no arguments are provided, a Rectangle matching the size of\r\n * this Zone will be used automatically. Has no effect if this Zone is already interactive.\r\n *\r\n * @method Phaser.GameObjects.Zone#setDropZone\r\n * @since 3.0.0\r\n *\r\n * @param {object} [hitArea] - A Geometry shape instance, such as Phaser.Geom.Ellipse, or your own custom shape. If not given it will try to create a Rectangle based on the size of this zone.\r\n * @param {Phaser.Types.Input.HitAreaCallback} [hitAreaCallback] - A function that will return `true` if the given x/y coords it is sent are within the shape. If you provide a shape you must also provide a callback.\r\n *\r\n * @return {this} This Game Object.\r\n */", "meta": { "filename": "Zone.js", "lineno": 233, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "description": "Enables this Zone as an interactive Drop Zone by calling `setInteractive` with the given\rhit area shape and callback. You can pass any Phaser geometry shape, or a custom shape with\ra matching hit-test callback. If no arguments are provided, a Rectangle matching the size of\rthis Zone will be used automatically. Has no effect if this Zone is already interactive.", "kind": "function", "name": "setDropZone", "since": "3.0.0", "params": [ { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "optional": true, "description": "A Geometry shape instance, such as Phaser.Geom.Ellipse, or your own custom shape. If not given it will try to create a Rectangle based on the size of this zone.", "name": "hitArea" }, { "type": { "names": [ "Phaser.Types.Input.HitAreaCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.HitAreaCallback" } }, "optional": true, "description": "A function that will return `true` if the given x/y coords it is sent are within the shape. If you provide a shape you must also provide a callback.", "name": "hitAreaCallback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Game Object." } ], "memberof": "Phaser.GameObjects.Zone", "longname": "Phaser.GameObjects.Zone#setDropZone", "scope": "instance", "___id": "T000002R019066", "___s": true }, { "comment": "/**\r\n * Creates a new Zone Game Object and returns it.\r\n *\r\n * Note: This method will only be available if the Zone Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectCreator#zone\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.GameObjects.Zone.ZoneConfig} config - The configuration object this Game Object will use to create itself.\r\n *\r\n * @return {Phaser.GameObjects.Zone} The Game Object that was created.\r\n */", "meta": { "filename": "ZoneCreator.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "description": "Creates a new Zone Game Object and returns it.\r\rNote: 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": [ "Phaser.Types.GameObjects.Zone.ZoneConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.GameObjects.Zone.ZoneConfig" } }, "description": "The configuration object this Game Object will use to create itself.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Zone" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Zone" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectCreator", "longname": "Phaser.GameObjects.GameObjectCreator#zone", "scope": "instance", "___id": "T000002R019080", "___s": true }, { "comment": "/**\r\n * Creates a new Zone Game Object and adds it to the Scene.\r\n *\r\n * Note: This method will only be available if the Zone Game Object has been built into Phaser.\r\n *\r\n * @method Phaser.GameObjects.GameObjectFactory#zone\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The horizontal position of this Game Object in the world.\r\n * @param {number} y - The vertical position of this Game Object in the world.\r\n * @param {number} width - The width of the Game Object.\r\n * @param {number} height - The height of the Game Object.\r\n *\r\n * @return {Phaser.GameObjects.Zone} The Game Object that was created.\r\n */", "meta": { "filename": "ZoneFactory.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\gameobjects\\zone", "code": {} }, "description": "Creates a new Zone Game Object and adds it to the Scene.\r\rNote: 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal position of this Game Object in the world.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical position of this Game Object in the world.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the Game Object.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the Game Object.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.Zone" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.Zone" } }, "description": "The Game Object that was created." } ], "memberof": "Phaser.GameObjects.GameObjectFactory", "longname": "Phaser.GameObjects.GameObjectFactory#zone", "scope": "instance", "___id": "T000002R019087", "___s": true }, { "comment": "/**\r\n * Calculates the area of the circle.\r\n *\r\n * @function Phaser.Geom.Circle.Area\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The Circle to get the area of.\r\n *\r\n * @return {number} The area of the Circle.\r\n */", "meta": { "filename": "Area.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Calculates the area of the circle.", "kind": "function", "name": "Area", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to get the area of.", "name": "circle" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The area of the Circle." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.Area", "scope": "static", "___id": "T000002R019088", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Circle geometry object defined by a center position and radius.\r\n *\r\n * This is a geometry object, containing numerical values and related methods to inspect and modify them.\r\n * It is not a Game Object, in that you cannot add it to the display list, and it has no texture.\r\n * To render a Circle you should look at the capabilities of the Graphics class.\r\n *\r\n * Circle objects are commonly used for hit-testing, overlap checks, masking, and defining circular\r\n * regions of interest within a Scene. They can be used directly with Phaser's geometry intersection\r\n * methods, such as `Phaser.Geom.Intersects.CircleToCircle` or `Phaser.Geom.Intersects.CircleToRectangle`,\r\n * making them useful for simple spatial queries without requiring a physics body.\r\n *\r\n * @class Circle\r\n * @memberof Phaser.Geom\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The x position of the center of the circle.\r\n * @param {number} [y=0] - The y position of the center of the circle.\r\n * @param {number} [radius=0] - The radius of the circle.\r\n */", "meta": { "filename": "Circle.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "classdesc": "A Circle geometry object defined by a center position and radius.\r\rThis is a geometry object, containing numerical values and related methods to inspect and modify them.\rIt is not a Game Object, in that you cannot add it to the display list, and it has no texture.\rTo render a Circle you should look at the capabilities of the Graphics class.\r\rCircle objects are commonly used for hit-testing, overlap checks, masking, and defining circular\rregions of interest within a Scene. They can be used directly with Phaser's geometry intersection\rmethods, such as `Phaser.Geom.Intersects.CircleToCircle` or `Phaser.Geom.Intersects.CircleToRectangle`,\rmaking them useful for simple spatial queries without requiring a physics body.", "kind": "class", "name": "Circle", "memberof": "Phaser.Geom", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of the center of the circle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of the center of the circle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The radius of the circle.", "name": "radius" } ], "scope": "static", "longname": "Phaser.Geom.Circle", "___id": "T000002R019097", "___s": true }, { "comment": "/**\r\n * The geometry constant type of this object: `GEOM_CONST.CIRCLE`.\r\n * Used for fast type comparisons.\r\n *\r\n * @name Phaser.Geom.Circle#type\r\n * @type {number}\r\n * @readonly\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 46, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The geometry constant type of this object: `GEOM_CONST.CIRCLE`.\rUsed for fast type comparisons.", "name": "type", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.19.0", "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#type", "scope": "instance", "kind": "member", "___id": "T000002R019103", "___s": true }, { "comment": "/**\r\n * The x position of the center of the circle.\r\n *\r\n * @name Phaser.Geom.Circle#x\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The x position of the center of the circle.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#x", "scope": "instance", "kind": "member", "___id": "T000002R019105", "___s": true }, { "comment": "/**\r\n * The y position of the center of the circle.\r\n *\r\n * @name Phaser.Geom.Circle#y\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The y position of the center of the circle.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#y", "scope": "instance", "kind": "member", "___id": "T000002R019107", "___s": true }, { "comment": "/**\r\n * Check to see if the Circle contains the given x / y coordinates.\r\n *\r\n * @method Phaser.Geom.Circle#contains\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate to check within the circle.\r\n * @param {number} y - The y coordinate to check within the circle.\r\n *\r\n * @return {boolean} True if the coordinates are within the circle, otherwise false.\r\n */", "meta": { "filename": "Circle.js", "lineno": 98, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to check within the circle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to check within the circle.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the coordinates are within the circle, otherwise false." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#contains", "scope": "instance", "___id": "T000002R019113", "___s": true }, { "comment": "/**\r\n * Returns a Point object containing the coordinates of a point on the circumference of the Circle\r\n * based on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point\r\n * at 180 degrees around the circle.\r\n *\r\n * @method Phaser.Geom.Circle#getPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} position - A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the circle.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 to store the return values in. If not given a Vector2 object will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 containing the coordinates of the point around the circle.\r\n */", "meta": { "filename": "Circle.js", "lineno": 114, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Returns a Point object containing the coordinates of a point on the circumference of the Circle\rbased on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point\rat 180 degrees around the circle.", "kind": "function", "name": "getPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 to store the return values in. If not given a Vector2 object will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 containing the coordinates of the point around the circle." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#getPoint", "scope": "instance", "___id": "T000002R019115", "___s": true }, { "comment": "/**\r\n * Returns an array of Point objects containing the coordinates of the points around the circumference of the Circle,\r\n * based on the given quantity or stepRate values.\r\n *\r\n * @method Phaser.Geom.Circle#getPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2[]} O - [output,$return]\r\n *\r\n * @param {number} quantity - The amount of points to return. If a falsy value the quantity will be derived from the `stepRate` instead.\r\n * @param {number} [stepRate] - Sets the quantity by getting the circumference of the circle and dividing it by the stepRate.\r\n * @param {Phaser.Math.Vector2[]} [output] - An array to insert the Vector2s in to. If not provided a new array will be created.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2 objects pertaining to the points around the circumference of the circle.\r\n */", "meta": { "filename": "Circle.js", "lineno": 134, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Returns an array of Point objects containing the coordinates of the points around the circumference of the Circle,\rbased on the given quantity or stepRate values.", "kind": "function", "name": "getPoints", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [output,$return]", "value": "{Phaser.Math.Vector2[]} O - [output,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of points to return. If a falsy value the quantity will be derived from the `stepRate` instead.", "name": "quantity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An array to insert the Vector2s in to. If not provided a new array will be created.", "name": "output" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2 objects pertaining to the points around the circumference of the circle." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#getPoints", "scope": "instance", "___id": "T000002R019117", "___s": true }, { "comment": "/**\r\n * Returns a uniformly distributed random point from anywhere within the Circle.\r\n *\r\n * @method Phaser.Geom.Circle#getRandomPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [point,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [vec] - A Vector2 object to set the random `x` and `y` values in.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 object with the random values set in the `x` and `y` properties.\r\n */", "meta": { "filename": "Circle.js", "lineno": 154, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Returns a uniformly distributed random point from anywhere within the Circle.", "kind": "function", "name": "getRandomPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [point,$return]", "value": "{Phaser.Math.Vector2} O - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 object to set the random `x` and `y` values in.", "name": "vec" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 object with the random values set in the `x` and `y` properties." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#getRandomPoint", "scope": "instance", "___id": "T000002R019119", "___s": true }, { "comment": "/**\r\n * Sets the x, y and radius of this circle.\r\n *\r\n * @method Phaser.Geom.Circle#setTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The x position of the center of the circle.\r\n * @param {number} [y=0] - The y position of the center of the circle.\r\n * @param {number} [radius=0] - The radius of the circle.\r\n *\r\n * @return {this} This Circle object.\r\n */", "meta": { "filename": "Circle.js", "lineno": 171, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Sets the x, y and radius of this circle.", "kind": "function", "name": "setTo", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of the center of the circle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of the center of the circle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The radius of the circle.", "name": "radius" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Circle object." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#setTo", "scope": "instance", "___id": "T000002R019121", "___s": true }, { "comment": "/**\r\n * Sets this Circle to be empty with a radius of zero.\r\n * Does not change its position.\r\n *\r\n * @method Phaser.Geom.Circle#setEmpty\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Circle object.\r\n */", "meta": { "filename": "Circle.js", "lineno": 193, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Sets this Circle to be empty with a radius of zero.\rDoes not change its position.", "kind": "function", "name": "setEmpty", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Circle object." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#setEmpty", "scope": "instance", "___id": "T000002R019127", "___s": true }, { "comment": "/**\r\n * Sets the position of this Circle. If the `y` argument is omitted, both the x and y\r\n * positions will be set to the value of `x`.\r\n *\r\n * @method Phaser.Geom.Circle#setPosition\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The x position of the center of the circle.\r\n * @param {number} [y=0] - The y position of the center of the circle.\r\n *\r\n * @return {this} This Circle object.\r\n */", "meta": { "filename": "Circle.js", "lineno": 210, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Sets the position of this Circle. If the `y` argument is omitted, both the x and y\rpositions will be set to the value of `x`.", "kind": "function", "name": "setPosition", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of the center of the circle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of the center of the circle.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Circle object." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#setPosition", "scope": "instance", "___id": "T000002R019131", "___s": true }, { "comment": "/**\r\n * Checks to see if the Circle is empty: has a radius of zero.\r\n *\r\n * @method Phaser.Geom.Circle#isEmpty\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} True if the Circle is empty, otherwise false.\r\n */", "meta": { "filename": "Circle.js", "lineno": 232, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Circle is empty, otherwise false." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#isEmpty", "scope": "instance", "___id": "T000002R019136", "___s": true }, { "comment": "/**\r\n * The radius of the Circle. Setting this value also updates the diameter accordingly.\r\n *\r\n * @name Phaser.Geom.Circle#radius\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 245, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The radius of the Circle. Setting this value also updates the diameter accordingly.", "name": "radius", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#radius", "scope": "instance", "kind": "member", "___id": "T000002R019138", "___s": true }, { "comment": "/**\r\n * The diameter of the Circle, which is twice the radius. Setting this value also updates the radius accordingly.\r\n *\r\n * @name Phaser.Geom.Circle#diameter\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 267, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The diameter of the Circle, which is twice the radius. Setting this value also updates the radius accordingly.", "name": "diameter", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#diameter", "scope": "instance", "kind": "member", "___id": "T000002R019144", "___s": true }, { "comment": "/**\r\n * The leftmost point of the Circle, equal to `x - radius`. Setting this value adjusts the\r\n * x position of the circle's center while keeping the radius unchanged.\r\n *\r\n * @name Phaser.Geom.Circle#left\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The leftmost point of the Circle, equal to `x - radius`. Setting this value adjusts the\rx position of the circle's center while keeping the radius unchanged.", "name": "left", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#left", "scope": "instance", "kind": "member", "___id": "T000002R019150", "___s": true }, { "comment": "/**\r\n * The rightmost point of the Circle, equal to `x + radius`. Setting this value adjusts the\r\n * x position of the circle's center while keeping the radius unchanged.\r\n *\r\n * @name Phaser.Geom.Circle#right\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 311, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The rightmost point of the Circle, equal to `x + radius`. Setting this value adjusts the\rx position of the circle's center while keeping the radius unchanged.", "name": "right", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#right", "scope": "instance", "kind": "member", "___id": "T000002R019155", "___s": true }, { "comment": "/**\r\n * The topmost point of the Circle, equal to `y - radius`. Setting this value adjusts the\r\n * y position of the circle's center while keeping the radius unchanged.\r\n *\r\n * @name Phaser.Geom.Circle#top\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 333, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The topmost point of the Circle, equal to `y - radius`. Setting this value adjusts the\ry position of the circle's center while keeping the radius unchanged.", "name": "top", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#top", "scope": "instance", "kind": "member", "___id": "T000002R019160", "___s": true }, { "comment": "/**\r\n * The bottommost point of the Circle, equal to `y + radius`. Setting this value adjusts the\r\n * y position of the circle's center while keeping the radius unchanged.\r\n *\r\n * @name Phaser.Geom.Circle#bottom\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Circle.js", "lineno": 355, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "The bottommost point of the Circle, equal to `y + radius`. Setting this value adjusts the\ry position of the circle's center while keeping the radius unchanged.", "name": "bottom", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle#bottom", "scope": "instance", "kind": "member", "___id": "T000002R019165", "___s": true }, { "comment": "/**\r\n * Returns the circumference of the given Circle.\r\n *\r\n * @function Phaser.Geom.Circle.Circumference\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The Circle to get the circumference of.\r\n *\r\n * @return {number} The circumference of the Circle.\r\n */", "meta": { "filename": "Circumference.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Returns the circumference of the given Circle.", "kind": "function", "name": "Circumference", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to get the circumference of.", "name": "circle" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The circumference of the Circle." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.Circumference", "scope": "static", "___id": "T000002R019171", "___s": true }, { "comment": "/**\r\n * Returns a Vector2 object containing the coordinates of a point on the circumference of the Circle based on the given angle.\r\n *\r\n * @function Phaser.Geom.Circle.CircumferencePoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The Circle to get the circumference point on.\r\n * @param {number} angle - The angle from the center of the Circle to the circumference to return the point from. Given in radians.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 to store the results in. If not given a Vector2 will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 object where the `x` and `y` properties are the point on the circumference.\r\n */", "meta": { "filename": "CircumferencePoint.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Returns a Vector2 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to get the circumference point on.", "name": "circle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 to store the results in. If not given a Vector2 will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 object where the `x` and `y` properties are the point on the circumference." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.CircumferencePoint", "scope": "static", "___id": "T000002R019175", "___s": true }, { "comment": "/**\r\n * Creates a new Circle instance based on the values contained in the given source.\r\n *\r\n * @function Phaser.Geom.Circle.Clone\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Geom.Circle|object)} source - The Circle to be cloned. Can be an instance of a Circle or a circle-like object, with x, y and radius properties.\r\n *\r\n * @return {Phaser.Geom.Circle} A clone of the source Circle.\r\n */", "meta": { "filename": "Clone.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Circle" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "A clone of the source Circle." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.Clone", "scope": "static", "___id": "T000002R019182", "___s": true }, { "comment": "/**\r\n * Check to see if the Circle contains the given x / y coordinates.\r\n *\r\n * @function Phaser.Geom.Circle.Contains\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The Circle to check.\r\n * @param {number} x - The x coordinate to check within the circle.\r\n * @param {number} y - The y coordinate to check within the circle.\r\n *\r\n * @return {boolean} True if the coordinates are within the circle, otherwise false.\r\n */", "meta": { "filename": "Contains.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to check.", "name": "circle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to check within the circle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to check within the circle.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the coordinates are within the circle, otherwise false." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.Contains", "scope": "static", "___id": "T000002R019185", "___s": true }, { "comment": "/**\r\n * Check to see if the Circle contains the given x and y coordinates as stored in the Vector2.\r\n *\r\n * @function Phaser.Geom.Circle.ContainsPoint\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The Circle to check.\r\n * @param {Phaser.Math.Vector2} vec - The Vector2 object to check if its coordinates are within the Circle or not.\r\n *\r\n * @return {boolean} True if the Vector2 coordinates are within the circle, otherwise false.\r\n */", "meta": { "filename": "ContainsPoint.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Check to see if the Circle contains the given x and y coordinates as stored in the Vector2.", "kind": "function", "name": "ContainsPoint", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to check.", "name": "circle" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The Vector2 object to check if its coordinates are within the Circle or not.", "name": "vec" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Vector2 coordinates are within the circle, otherwise false." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.ContainsPoint", "scope": "static", "___id": "T000002R019191", "___s": true }, { "comment": "/**\r\n * Check to see if the Circle contains all four points of the given Rectangle object.\r\n *\r\n * @function Phaser.Geom.Circle.ContainsRect\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The Circle to check.\r\n * @param {(Phaser.Geom.Rectangle|object)} rect - The Rectangle object to check if it's within the Circle or not.\r\n *\r\n * @return {boolean} True if all of the Rectangle coordinates are within the circle, otherwise false.\r\n */", "meta": { "filename": "ContainsRect.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to check.", "name": "circle" }, { "type": { "names": [ "Phaser.Geom.Rectangle", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The Rectangle object to check if it's within the Circle or not.", "name": "rect" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R019195", "___s": true }, { "comment": "/**\r\n * Copies the `x`, `y` and `radius` properties from the `source` Circle\r\n * into the given `dest` Circle, then returns the `dest` Circle.\r\n *\r\n * @function Phaser.Geom.Circle.CopyFrom\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Circle} O - [dest,$return]\r\n *\r\n * @param {Phaser.Geom.Circle} source - The source Circle to copy the values from.\r\n * @param {Phaser.Geom.Circle} dest - The destination Circle to copy the values to.\r\n *\r\n * @return {Phaser.Geom.Circle} The destination Circle.\r\n */", "meta": { "filename": "CopyFrom.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Copies the `x`, `y` and `radius` properties from the `source` Circle\rinto the given `dest` Circle, then returns the `dest` Circle.", "kind": "function", "name": "CopyFrom", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Circle} O - [dest,$return]", "value": "{Phaser.Geom.Circle} O - [dest,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The source Circle to copy the values from.", "name": "source" }, { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The destination Circle to copy the values to.", "name": "dest" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The destination Circle." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.CopyFrom", "scope": "static", "___id": "T000002R019198", "___s": true }, { "comment": "/**\r\n * Compares the `x`, `y` and `radius` properties of the two given Circles.\r\n * Returns `true` if they all match, otherwise returns `false`.\r\n *\r\n * @function Phaser.Geom.Circle.Equals\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The first Circle to compare.\r\n * @param {Phaser.Geom.Circle} toCompare - The second Circle to compare.\r\n *\r\n * @return {boolean} `true` if the two Circles equal each other, otherwise `false`.\r\n */", "meta": { "filename": "Equals.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Compares the `x`, `y` and `radius` properties of the two given Circles.\rReturns `true` if they all match, otherwise returns `false`.", "kind": "function", "name": "Equals", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The first Circle to compare.", "name": "circle" }, { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The second Circle to compare.", "name": "toCompare" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the two Circles equal each other, otherwise `false`." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.Equals", "scope": "static", "___id": "T000002R019201", "___s": true }, { "comment": "/**\r\n * Returns the bounds of the Circle object.\r\n *\r\n * @function Phaser.Geom.Circle.GetBounds\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The Circle to get the bounds from.\r\n * @param {(Phaser.Geom.Rectangle|object)} [out] - A Rectangle, or rectangle-like object, to store the circle bounds in. If not given a new Rectangle will be created.\r\n *\r\n * @return {(Phaser.Geom.Rectangle|object)} The Rectangle object containing the Circle's bounds.\r\n */", "meta": { "filename": "GetBounds.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Returns the bounds of the Circle object.", "kind": "function", "name": "GetBounds", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [out,$return]", "value": "{Phaser.Geom.Rectangle} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to get the bounds from.", "name": "circle" }, { "type": { "names": [ "Phaser.Geom.Rectangle", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The Rectangle object containing the Circle's bounds." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.GetBounds", "scope": "static", "___id": "T000002R019205", "___s": true }, { "comment": "/**\r\n * Returns a Vector2 object containing the coordinates of a point on the circumference of the Circle\r\n * based on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point\r\n * at 180 degrees around the circle.\r\n *\r\n * @function Phaser.Geom.Circle.GetPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The Circle to get the circumference point on.\r\n * @param {number} position - A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the circle.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 instance to store the return values in. If not given a new Vector2 object will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 containing the coordinates of the point around the circle.\r\n */", "meta": { "filename": "GetPoint.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Returns a Vector2 object containing the coordinates of a point on the circumference of the Circle\rbased on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point\rat 180 degrees around the circle.", "kind": "function", "name": "GetPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to get the circumference point on.", "name": "circle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 instance to store the return values in. If not given a new Vector2 object will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 containing the coordinates of the point around the circle." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.GetPoint", "scope": "static", "___id": "T000002R019217", "___s": true }, { "comment": "/**\r\n * Returns an array of Vector2 objects containing the coordinates of the points around the circumference of the Circle,\r\n * based on the given quantity or stepRate values.\r\n *\r\n * @function Phaser.Geom.Circle.GetPoints\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The Circle to get the points from.\r\n * @param {number} quantity - The amount of points to return. If a falsy value the quantity will be derived from the `stepRate` instead.\r\n * @param {number} [stepRate] - Sets the quantity by getting the circumference of the circle and dividing it by the stepRate.\r\n * @param {array} [out] - An array to insert the points in to. If not provided a new array will be created.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2 objects pertaining to the points around the circumference of the circle.\r\n */", "meta": { "filename": "GetPoints.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Returns an array of Vector2 objects containing the coordinates of the points around the circumference of the Circle,\rbased on the given quantity or stepRate values.", "kind": "function", "name": "GetPoints", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to get the points from.", "name": "circle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of points to return. If a falsy value the quantity will be derived from the `stepRate` instead.", "name": "quantity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2 objects pertaining to the points around the circumference of the circle." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.GetPoints", "scope": "static", "___id": "T000002R019226", "___s": true }, { "comment": "/**\r\n * Offsets the Circle by the values given.\r\n *\r\n * @function Phaser.Geom.Circle.Offset\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Circle} O - [circle,$return]\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The Circle to be offset (translated.)\r\n * @param {number} x - The amount to horizontally offset the Circle by.\r\n * @param {number} y - The amount to vertically offset the Circle by.\r\n *\r\n * @return {Phaser.Geom.Circle} The Circle that was offset.\r\n */", "meta": { "filename": "Offset.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Offsets the Circle by the values given.", "kind": "function", "name": "Offset", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Circle} O - [circle,$return]", "value": "{Phaser.Geom.Circle} O - [circle,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to be offset (translated.)", "name": "circle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to horizontally offset the Circle by.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to vertically offset the Circle by.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle that was offset." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.Offset", "scope": "static", "___id": "T000002R019250", "___s": true }, { "comment": "/**\r\n * Offsets the Circle by the values given in the `x` and `y` properties of the Vector2 object.\r\n *\r\n * @function Phaser.Geom.Circle.OffsetPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Circle} O - [circle,$return]\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The Circle to be offset (translated.)\r\n * @param {Phaser.Math.Vector2} vec - The Vector2 object containing the values to offset the Circle by.\r\n *\r\n * @return {Phaser.Geom.Circle} The Circle that was offset.\r\n */", "meta": { "filename": "OffsetPoint.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Offsets the Circle by the values given in the `x` and `y` properties of the Vector2 object.", "kind": "function", "name": "OffsetPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Circle} O - [circle,$return]", "value": "{Phaser.Geom.Circle} O - [circle,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to be offset (translated.)", "name": "circle" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The Vector2 object containing the values to offset the Circle by.", "name": "vec" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle that was offset." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.OffsetPoint", "scope": "static", "___id": "T000002R019255", "___s": true }, { "comment": "/**\r\n * Returns a uniformly distributed random point from anywhere within the given Circle.\r\n *\r\n * @function Phaser.Geom.Circle.Random\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The Circle to get a random point from.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to set the random `x` and `y` values in.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 object with the random values set in the `x` and `y` properties.\r\n */", "meta": { "filename": "Random.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\circle", "code": {} }, "description": "Returns a uniformly distributed random point from anywhere within the given Circle.", "kind": "function", "name": "Random", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to get a random point from.", "name": "circle" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 object to set the random `x` and `y` values in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 object with the random values set in the `x` and `y` properties." } ], "memberof": "Phaser.Geom.Circle", "longname": "Phaser.Geom.Circle.Random", "scope": "static", "___id": "T000002R019261", "___s": true }, { "comment": "/**\r\n * A Circle Geometry object type.\r\n *\r\n * @name Phaser.Geom.CIRCLE\r\n * @type {number}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "const.js", "lineno": 9, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom", "code": {} }, "description": "A Circle Geometry object type.", "name": "CIRCLE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.19.0", "memberof": "Phaser.Geom", "longname": "Phaser.Geom.CIRCLE", "scope": "static", "kind": "member", "___id": "T000002R019273", "___s": true }, { "comment": "/**\r\n * An Ellipse Geometry object type.\r\n *\r\n * @name Phaser.Geom.ELLIPSE\r\n * @type {number}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "const.js", "lineno": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom", "code": {} }, "description": "An Ellipse Geometry object type.", "name": "ELLIPSE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.19.0", "memberof": "Phaser.Geom", "longname": "Phaser.Geom.ELLIPSE", "scope": "static", "kind": "member", "___id": "T000002R019275", "___s": true }, { "comment": "/**\r\n * A Line Geometry object type.\r\n *\r\n * @name Phaser.Geom.LINE\r\n * @type {number}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "const.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom", "code": {} }, "description": "A Line Geometry object type.", "name": "LINE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.19.0", "memberof": "Phaser.Geom", "longname": "Phaser.Geom.LINE", "scope": "static", "kind": "member", "___id": "T000002R019277", "___s": true }, { "comment": "/**\r\n * A Point Geometry object type.\r\n * This object type was removed in 4.0.0. Use Vector2 instead.\r\n *\r\n * @name Phaser.Geom.POINT\r\n * @type {number}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "const.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom", "code": {} }, "description": "A Point Geometry object type.\rThis object type was removed in 4.0.0. Use Vector2 instead.", "name": "POINT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.19.0", "memberof": "Phaser.Geom", "longname": "Phaser.Geom.POINT", "scope": "static", "kind": "member", "___id": "T000002R019279", "___s": true }, { "comment": "/**\r\n * A Polygon Geometry object type.\r\n *\r\n * @name Phaser.Geom.POLYGON\r\n * @type {number}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "const.js", "lineno": 46, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom", "code": {} }, "description": "A Polygon Geometry object type.", "name": "POLYGON", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.19.0", "memberof": "Phaser.Geom", "longname": "Phaser.Geom.POLYGON", "scope": "static", "kind": "member", "___id": "T000002R019281", "___s": true }, { "comment": "/**\r\n * A Rectangle Geometry object type.\r\n *\r\n * @name Phaser.Geom.RECTANGLE\r\n * @type {number}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "const.js", "lineno": 55, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom", "code": {} }, "description": "A Rectangle Geometry object type.", "name": "RECTANGLE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.19.0", "memberof": "Phaser.Geom", "longname": "Phaser.Geom.RECTANGLE", "scope": "static", "kind": "member", "___id": "T000002R019283", "___s": true }, { "comment": "/**\r\n * A Triangle Geometry object type.\r\n *\r\n * @name Phaser.Geom.TRIANGLE\r\n * @type {number}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "const.js", "lineno": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom", "code": {} }, "description": "A Triangle Geometry object type.", "name": "TRIANGLE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.19.0", "memberof": "Phaser.Geom", "longname": "Phaser.Geom.TRIANGLE", "scope": "static", "kind": "member", "___id": "T000002R019285", "___s": true }, { "comment": "/**\r\n * Calculates the area of the given Ellipse using the formula: π × majorRadius × minorRadius.\r\n * Returns 0 if the Ellipse is empty (i.e. has no width or height).\r\n *\r\n * @function Phaser.Geom.Ellipse.Area\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to get the area of.\r\n *\r\n * @return {number} The area of the Ellipse, or 0 if the Ellipse is empty.\r\n */", "meta": { "filename": "Area.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Calculates the area of the given Ellipse using the formula: π × majorRadius × minorRadius.\rReturns 0 if the Ellipse is empty (i.e. has no width or height).", "kind": "function", "name": "Area", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to get the area of.", "name": "ellipse" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The area of the Ellipse, or 0 if the Ellipse is empty." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.Area", "scope": "static", "___id": "T000002R019288", "___s": true }, { "comment": "/**\r\n * Returns the circumference of the given Ellipse.\r\n *\r\n * @function Phaser.Geom.Ellipse.Circumference\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to get the circumference of.\r\n *\r\n * @return {number} The circumference of the Ellipse.\r\n */", "meta": { "filename": "Circumference.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Returns the circumference of the given Ellipse.", "kind": "function", "name": "Circumference", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to get the circumference of.", "name": "ellipse" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The circumference of the Ellipse." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.Circumference", "scope": "static", "___id": "T000002R019291", "___s": true }, { "comment": "/**\r\n * Returns a Vector2 containing the coordinates of a point on the circumference of the Ellipse based on the given angle.\r\n *\r\n * @function Phaser.Geom.Ellipse.CircumferencePoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to get the circumference point on.\r\n * @param {number} angle - The angle from the center of the Ellipse to the circumference to return the point from. Given in radians.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 to store the results in. If not given a Vector2 will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 object where the `x` and `y` properties are the point on the circumference.\r\n */", "meta": { "filename": "CircumferencePoint.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Returns a Vector2 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to get the circumference point on.", "name": "ellipse" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 to store the results in. If not given a Vector2 will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 object where the `x` and `y` properties are the point on the circumference." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.CircumferencePoint", "scope": "static", "___id": "T000002R019298", "___s": true }, { "comment": "/**\r\n * Creates a new Ellipse instance based on the values contained in the given source.\r\n *\r\n * @function Phaser.Geom.Ellipse.Clone\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Ellipse} source - The Ellipse to be cloned. Can be an instance of an Ellipse or an ellipse-like object, with x, y, width and height properties.\r\n *\r\n * @return {Phaser.Geom.Ellipse} A clone of the source Ellipse.\r\n */", "meta": { "filename": "Clone.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to be cloned. Can be an instance of an Ellipse or an ellipse-like object, with x, y, width and height properties.", "name": "source" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "A clone of the source Ellipse." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.Clone", "scope": "static", "___id": "T000002R019307", "___s": true }, { "comment": "/**\r\n * Check to see if the Ellipse contains the given x / y coordinates.\r\n *\r\n * @function Phaser.Geom.Ellipse.Contains\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to check.\r\n * @param {number} x - The x coordinate to check within the ellipse.\r\n * @param {number} y - The y coordinate to check within the ellipse.\r\n *\r\n * @return {boolean} True if the coordinates are within the ellipse, otherwise false.\r\n */", "meta": { "filename": "Contains.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to check.", "name": "ellipse" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to check within the ellipse.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to check within the ellipse.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the coordinates are within the ellipse, otherwise false." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.Contains", "scope": "static", "___id": "T000002R019310", "___s": true }, { "comment": "/**\r\n * Check to see if the Ellipse contains the given x and y coordinates as stored in the Vector2.\r\n *\r\n * @function Phaser.Geom.Ellipse.ContainsPoint\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to check.\r\n * @param {Phaser.Math.Vector2} vec - The Vector2 object to check if its coordinates are within the Ellipse or not.\r\n *\r\n * @return {boolean} True if the Vector2 coordinates are within the ellipse, otherwise false.\r\n */", "meta": { "filename": "ContainsPoint.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Check to see if the Ellipse contains the given x and y coordinates as stored in the Vector2.", "kind": "function", "name": "ContainsPoint", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to check.", "name": "ellipse" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The Vector2 object to check if its coordinates are within the Ellipse or not.", "name": "vec" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Vector2 coordinates are within the ellipse, otherwise false." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.ContainsPoint", "scope": "static", "___id": "T000002R019318", "___s": true }, { "comment": "/**\r\n * Check to see if the Ellipse contains all four points of the given Rectangle object.\r\n *\r\n * @function Phaser.Geom.Ellipse.ContainsRect\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to check.\r\n * @param {(Phaser.Geom.Rectangle|object)} rect - The Rectangle object to check if it's within the Ellipse or not.\r\n *\r\n * @return {boolean} True if all of the Rectangle coordinates are within the ellipse, otherwise false.\r\n */", "meta": { "filename": "ContainsRect.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to check.", "name": "ellipse" }, { "type": { "names": [ "Phaser.Geom.Rectangle", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The Rectangle object to check if it's within the Ellipse or not.", "name": "rect" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R019322", "___s": true }, { "comment": "/**\r\n * Copies the `x`, `y`, `width` and `height` properties from the `source` Ellipse\r\n * into the given `dest` Ellipse, then returns the `dest` Ellipse.\r\n *\r\n * @function Phaser.Geom.Ellipse.CopyFrom\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Ellipse} O - [dest,$return]\r\n *\r\n * @param {Phaser.Geom.Ellipse} source - The source Ellipse to copy the values from.\r\n * @param {Phaser.Geom.Ellipse} dest - The destination Ellipse to copy the values to.\r\n *\r\n * @return {Phaser.Geom.Ellipse} The destination Ellipse.\r\n */", "meta": { "filename": "CopyFrom.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Copies the `x`, `y`, `width` and `height` properties from the `source` Ellipse\rinto the given `dest` Ellipse, then returns the `dest` Ellipse.", "kind": "function", "name": "CopyFrom", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Ellipse} O - [dest,$return]", "value": "{Phaser.Geom.Ellipse} O - [dest,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The source Ellipse to copy the values from.", "name": "source" }, { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The destination Ellipse to copy the values to.", "name": "dest" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The destination Ellipse." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.CopyFrom", "scope": "static", "___id": "T000002R019325", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An Ellipse object.\r\n *\r\n * An Ellipse is defined by its center position (x, y), a total width, and a total height. It can be\r\n * used for geometric intersection tests (point-in-ellipse containment), sampling evenly-spaced or random\r\n * points on its circumference or interior, and as a lightweight shape descriptor for collision or\r\n * hit-area purposes.\r\n *\r\n * This is a geometry object, containing numerical values and related methods to inspect and modify them.\r\n * It is not a Game Object, in that you cannot add it to the display list, and it has no texture.\r\n * To render an Ellipse you should look at the capabilities of the Graphics class.\r\n *\r\n * @class Ellipse\r\n * @memberof Phaser.Geom\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The x position of the center of the ellipse.\r\n * @param {number} [y=0] - The y position of the center of the ellipse.\r\n * @param {number} [width=0] - The width of the ellipse.\r\n * @param {number} [height=0] - The height of the ellipse.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "classdesc": "An Ellipse object.\r\rAn Ellipse is defined by its center position (x, y), a total width, and a total height. It can be\rused for geometric intersection tests (point-in-ellipse containment), sampling evenly-spaced or random\rpoints on its circumference or interior, and as a lightweight shape descriptor for collision or\rhit-area purposes.\r\rThis is a geometry object, containing numerical values and related methods to inspect and modify them.\rIt is not a Game Object, in that you cannot add it to the display list, and it has no texture.\rTo 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x position of the center of the ellipse.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y position of the center of the ellipse.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The width of the ellipse.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The height of the ellipse.", "name": "height" } ], "scope": "static", "longname": "Phaser.Geom.Ellipse", "___id": "T000002R019334", "___s": true }, { "comment": "/**\r\n * The geometry constant type of this object: `GEOM_CONST.ELLIPSE`.\r\n * Used for fast type comparisons.\r\n *\r\n * @name Phaser.Geom.Ellipse#type\r\n * @type {number}\r\n * @readonly\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 48, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "The geometry constant type of this object: `GEOM_CONST.ELLIPSE`.\rUsed for fast type comparisons.", "name": "type", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.19.0", "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#type", "scope": "instance", "kind": "member", "___id": "T000002R019341", "___s": true }, { "comment": "/**\r\n * The x position of the center of the ellipse.\r\n *\r\n * @name Phaser.Geom.Ellipse#x\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 59, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "The x position of the center of the ellipse.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#x", "scope": "instance", "kind": "member", "___id": "T000002R019343", "___s": true }, { "comment": "/**\r\n * The y position of the center of the ellipse.\r\n *\r\n * @name Phaser.Geom.Ellipse#y\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 69, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "The y position of the center of the ellipse.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#y", "scope": "instance", "kind": "member", "___id": "T000002R019345", "___s": true }, { "comment": "/**\r\n * The width of the ellipse.\r\n *\r\n * @name Phaser.Geom.Ellipse#width\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 79, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "The width of the ellipse.", "name": "width", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#width", "scope": "instance", "kind": "member", "___id": "T000002R019347", "___s": true }, { "comment": "/**\r\n * The height of the ellipse.\r\n *\r\n * @name Phaser.Geom.Ellipse#height\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 89, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "The height of the ellipse.", "name": "height", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#height", "scope": "instance", "kind": "member", "___id": "T000002R019349", "___s": true }, { "comment": "/**\r\n * Check to see if the Ellipse contains the given x / y coordinates.\r\n *\r\n * @method Phaser.Geom.Ellipse#contains\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate to check within the ellipse.\r\n * @param {number} y - The y coordinate to check within the ellipse.\r\n *\r\n * @return {boolean} True if the coordinates are within the ellipse, otherwise false.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 100, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to check within the ellipse.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to check within the ellipse.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the coordinates are within the ellipse, otherwise false." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#contains", "scope": "instance", "___id": "T000002R019351", "___s": true }, { "comment": "/**\r\n * Returns a Vector2 object containing the coordinates of a point on the circumference of the Ellipse\r\n * based on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point\r\n * at 180 degrees around the ellipse.\r\n *\r\n * @method Phaser.Geom.Ellipse#getPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {number} position - A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 around the ellipse.\r\n * @param {Phaser.Math.Vector2} [point] - A Vector2 to store the return values in. If not given a Vector2 object will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 instance containing the coordinates of the point around the ellipse.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 116, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Returns a Vector2 object containing the coordinates of a point on the circumference of the Ellipse\rbased on the given angle normalized to the range 0 to 1. I.e. a value of 0.5 will give the point\rat 180 degrees around the ellipse.", "kind": "function", "name": "getPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 to store the return values in. If not given a Vector2 object will be created.", "name": "point" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 instance containing the coordinates of the point around the ellipse." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#getPoint", "scope": "instance", "___id": "T000002R019353", "___s": true }, { "comment": "/**\r\n * Returns an array of Vector2 objects containing the coordinates of the points around the circumference of the Ellipse,\r\n * based on the given quantity or stepRate values.\r\n *\r\n * @method Phaser.Geom.Ellipse#getPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2[]} O - [output,$return]\r\n *\r\n * @param {number} quantity - The amount of points to return. If a falsey value the quantity will be derived from the `stepRate` instead.\r\n * @param {number} [stepRate] - Sets the quantity by getting the circumference of the ellipse and dividing it by the stepRate.\r\n * @param {Phaser.Math.Vector2[]} [output] - An array to insert the Vector2s in. If not provided a new array will be created.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2 objects pertaining to the points around the circumference of the ellipse.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 136, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Returns an array of Vector2 objects containing the coordinates of the points around the circumference of the Ellipse,\rbased on the given quantity or stepRate values.", "kind": "function", "name": "getPoints", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [output,$return]", "value": "{Phaser.Math.Vector2[]} O - [output,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An array to insert the Vector2s in. If not provided a new array will be created.", "name": "output" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2 objects pertaining to the points around the circumference of the ellipse." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#getPoints", "scope": "instance", "___id": "T000002R019355", "___s": true }, { "comment": "/**\r\n * Returns a uniformly distributed random point from anywhere within the given Ellipse.\r\n *\r\n * @method Phaser.Geom.Ellipse#getRandomPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [point,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [vec] - A Vector2 object to set the random `x` and `y` values in.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 object with the random values set in the `x` and `y` properties.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 156, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Returns a uniformly distributed random point from anywhere within the given Ellipse.", "kind": "function", "name": "getRandomPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [point,$return]", "value": "{Phaser.Math.Vector2} O - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 object to set the random `x` and `y` values in.", "name": "vec" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 object with the random values set in the `x` and `y` properties." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#getRandomPoint", "scope": "instance", "___id": "T000002R019357", "___s": true }, { "comment": "/**\r\n * Sets the x, y, width and height of this ellipse.\r\n *\r\n * @method Phaser.Geom.Ellipse#setTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x position of the center of the ellipse.\r\n * @param {number} y - The y position of the center of the ellipse.\r\n * @param {number} width - The width of the ellipse.\r\n * @param {number} height - The height of the ellipse.\r\n *\r\n * @return {this} This Ellipse object.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 173, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Sets the x, y, width and height of this ellipse.", "kind": "function", "name": "setTo", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the center of the ellipse.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the center of the ellipse.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the ellipse.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the ellipse.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Ellipse object." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#setTo", "scope": "instance", "___id": "T000002R019359", "___s": true }, { "comment": "/**\r\n * Sets this Ellipse to be empty with a width and height of zero.\r\n * Does not change its position.\r\n *\r\n * @method Phaser.Geom.Ellipse#setEmpty\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Ellipse object.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 196, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Sets this Ellipse to be empty with a width and height of zero.\rDoes not change its position.", "kind": "function", "name": "setEmpty", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Ellipse object." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#setEmpty", "scope": "instance", "___id": "T000002R019365", "___s": true }, { "comment": "/**\r\n * Sets the position of this Ellipse. If the `y` argument is omitted, both the x and y positions\r\n * will be set to the value of `x`.\r\n *\r\n * @method Phaser.Geom.Ellipse#setPosition\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x position of the center of the ellipse.\r\n * @param {number} y - The y position of the center of the ellipse.\r\n *\r\n * @return {this} This Ellipse object.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 213, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Sets the position of this Ellipse. If the `y` argument is omitted, both the x and y positions\rwill be set to the value of `x`.", "kind": "function", "name": "setPosition", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x position of the center of the ellipse.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y position of the center of the ellipse.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Ellipse object." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#setPosition", "scope": "instance", "___id": "T000002R019369", "___s": true }, { "comment": "/**\r\n * Sets the size of this Ellipse. Does not change its position.\r\n * If the `height` argument is omitted it will be set equal to `width`, producing a circle.\r\n *\r\n * @method Phaser.Geom.Ellipse#setSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width of the ellipse.\r\n * @param {number} [height=width] - The height of the ellipse.\r\n *\r\n * @return {this} This Ellipse object.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 235, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Sets the size of this Ellipse. Does not change its position.\rIf the `height` argument is omitted it will be set equal to `width`, producing a circle.", "kind": "function", "name": "setSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the ellipse.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "width", "description": "The height of the ellipse.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Ellipse object." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#setSize", "scope": "instance", "___id": "T000002R019374", "___s": true }, { "comment": "/**\r\n * Checks to see if the Ellipse is empty: has a width or height of zero or less.\r\n *\r\n * @method Phaser.Geom.Ellipse#isEmpty\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} True if the Ellipse is empty, otherwise false.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Checks to see if the Ellipse is empty: has a width or height of zero or less.", "kind": "function", "name": "isEmpty", "since": "3.0.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True if the Ellipse is empty, otherwise false." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#isEmpty", "scope": "instance", "___id": "T000002R019379", "___s": true }, { "comment": "/**\r\n * Returns the minor radius of the ellipse. Also known as the Semi Minor Axis.\r\n *\r\n * @method Phaser.Geom.Ellipse#getMinorRadius\r\n * @since 3.0.0\r\n *\r\n * @return {number} The minor radius.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 270, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The minor radius." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#getMinorRadius", "scope": "instance", "___id": "T000002R019381", "___s": true }, { "comment": "/**\r\n * Returns the major radius of the ellipse. Also known as the Semi Major Axis.\r\n *\r\n * @method Phaser.Geom.Ellipse#getMajorRadius\r\n * @since 3.0.0\r\n *\r\n * @return {number} The major radius.\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 283, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The major radius." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#getMajorRadius", "scope": "instance", "___id": "T000002R019383", "___s": true }, { "comment": "/**\r\n * The left position of the Ellipse.\r\n *\r\n * @name Phaser.Geom.Ellipse#left\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 296, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "The left position of the Ellipse.", "name": "left", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#left", "scope": "instance", "kind": "member", "___id": "T000002R019385", "___s": true }, { "comment": "/**\r\n * The right position of the Ellipse.\r\n *\r\n * @name Phaser.Geom.Ellipse#right\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 317, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "The right position of the Ellipse.", "name": "right", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#right", "scope": "instance", "kind": "member", "___id": "T000002R019390", "___s": true }, { "comment": "/**\r\n * The top position of the Ellipse.\r\n *\r\n * @name Phaser.Geom.Ellipse#top\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 338, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "The top position of the Ellipse.", "name": "top", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#top", "scope": "instance", "kind": "member", "___id": "T000002R019395", "___s": true }, { "comment": "/**\r\n * The bottom position of the Ellipse.\r\n *\r\n * @name Phaser.Geom.Ellipse#bottom\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Ellipse.js", "lineno": 359, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "The bottom position of the Ellipse.", "name": "bottom", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse#bottom", "scope": "instance", "kind": "member", "___id": "T000002R019400", "___s": true }, { "comment": "/**\r\n * Compares the `x`, `y`, `width` and `height` properties of the two given Ellipses.\r\n * Returns `true` if they all match, otherwise returns `false`.\r\n *\r\n * @function Phaser.Geom.Ellipse.Equals\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The first Ellipse to compare.\r\n * @param {Phaser.Geom.Ellipse} toCompare - The second Ellipse to compare.\r\n *\r\n * @return {boolean} `true` if the two Ellipse equal each other, otherwise `false`.\r\n */", "meta": { "filename": "Equals.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Compares the `x`, `y`, `width` and `height` properties of the two given Ellipses.\rReturns `true` if they all match, otherwise returns `false`.", "kind": "function", "name": "Equals", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The first Ellipse to compare.", "name": "ellipse" }, { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The second Ellipse to compare.", "name": "toCompare" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the two Ellipse equal each other, otherwise `false`." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.Equals", "scope": "static", "___id": "T000002R019406", "___s": true }, { "comment": "/**\r\n * Returns the bounds of the Ellipse object.\r\n *\r\n * @function Phaser.Geom.Ellipse.GetBounds\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to get the bounds from.\r\n * @param {(Phaser.Geom.Rectangle|object)} [out] - A Rectangle, or rectangle-like object, to store the ellipse bounds in. If not given a new Rectangle will be created.\r\n *\r\n * @return {(Phaser.Geom.Rectangle|object)} The Rectangle object containing the Ellipse bounds.\r\n */", "meta": { "filename": "GetBounds.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Returns the bounds of the Ellipse object.", "kind": "function", "name": "GetBounds", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [out,$return]", "value": "{Phaser.Geom.Rectangle} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to get the bounds from.", "name": "ellipse" }, { "type": { "names": [ "Phaser.Geom.Rectangle", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The Rectangle object containing the Ellipse bounds." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.GetBounds", "scope": "static", "___id": "T000002R019410", "___s": true }, { "comment": "/**\r\n * Returns a Vector2 object containing the coordinates of a point on the circumference of the Ellipse\r\n * based on the given angle normalized to the range 0 to 1. i.e. a value of 0.5 will give the point\r\n * at 180 degrees around the ellipse.\r\n *\r\n * @function Phaser.Geom.Ellipse.GetPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to get the circumference point on.\r\n * @param {number} position - A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 degrees around the ellipse.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the return values in. If not given a new Vector2 object will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 object, containing the coordinates of the point around the ellipse.\r\n */", "meta": { "filename": "GetPoint.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Returns a Vector2 object containing the coordinates of a point on the circumference of the Ellipse\rbased on the given angle normalized to the range 0 to 1. i.e. a value of 0.5 will give the point\rat 180 degrees around the ellipse.", "kind": "function", "name": "GetPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to get the circumference point on.", "name": "ellipse" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A value between 0 and 1, where 0 equals 0 degrees, 0.5 equals 180 degrees and 1 equals 360 degrees around the ellipse.", "name": "position" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 object to store the return values in. If not given a new Vector2 object will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 object, containing the coordinates of the point around the ellipse." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.GetPoint", "scope": "static", "___id": "T000002R019422", "___s": true }, { "comment": "/**\r\n * Returns an array of Vector2 objects containing the coordinates of the points around the circumference of the Ellipse,\r\n * based on the given quantity or stepRate values.\r\n *\r\n * @function Phaser.Geom.Ellipse.GetPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2[]} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to get the points from.\r\n * @param {number} quantity - The amount of points to return. If a falsy value the quantity will be derived from the `stepRate` instead.\r\n * @param {number} [stepRate] - Sets the quantity by getting the circumference of the ellipse and dividing it by the stepRate.\r\n * @param {Phaser.Math.Vector2[]} [out] - An array to insert the Vector2 objects into. If not provided a new array will be created.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2 objects pertaining to the points around the circumference of the ellipse.\r\n */", "meta": { "filename": "GetPoints.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Returns an array of Vector2 objects containing the coordinates of the points around the circumference of the Ellipse,\rbased on the given quantity or stepRate values.", "kind": "function", "name": "GetPoints", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [out,$return]", "value": "{Phaser.Math.Vector2[]} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to get the points from.", "name": "ellipse" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of points to return. If a falsy value the quantity will be derived from the `stepRate` instead.", "name": "quantity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An array to insert the Vector2 objects into. If not provided a new array will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2 objects pertaining to the points around the circumference of the ellipse." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.GetPoints", "scope": "static", "___id": "T000002R019431", "___s": true }, { "comment": "/**\r\n * Offsets the Ellipse by the values given.\r\n *\r\n * @function Phaser.Geom.Ellipse.Offset\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Ellipse} O - [ellipse,$return]\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to be offset (translated).\r\n * @param {number} x - The amount to horizontally offset the Ellipse by.\r\n * @param {number} y - The amount to vertically offset the Ellipse by.\r\n *\r\n * @return {Phaser.Geom.Ellipse} The Ellipse that was offset.\r\n */", "meta": { "filename": "Offset.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Offsets the Ellipse by the values given.", "kind": "function", "name": "Offset", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Ellipse} O - [ellipse,$return]", "value": "{Phaser.Geom.Ellipse} O - [ellipse,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to be offset (translated).", "name": "ellipse" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to horizontally offset the Ellipse by.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to vertically offset the Ellipse by.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse that was offset." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.Offset", "scope": "static", "___id": "T000002R019455", "___s": true }, { "comment": "/**\r\n * Offsets the Ellipse by the values given in the `x` and `y` properties of the Vector2 object.\r\n *\r\n * @function Phaser.Geom.Ellipse.OffsetPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Ellipse} O - [ellipse,$return]\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to be offset (translated.)\r\n * @param {Phaser.Math.Vector2} vec - The Vector2 object containing the values to offset the Ellipse by.\r\n *\r\n * @return {Phaser.Geom.Ellipse} The Ellipse that was offset.\r\n */", "meta": { "filename": "OffsetPoint.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Offsets the Ellipse by the values given in the `x` and `y` properties of the Vector2 object.", "kind": "function", "name": "OffsetPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Ellipse} O - [ellipse,$return]", "value": "{Phaser.Geom.Ellipse} O - [ellipse,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to be offset (translated.)", "name": "ellipse" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The Vector2 object containing the values to offset the Ellipse by.", "name": "vec" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse that was offset." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.OffsetPoint", "scope": "static", "___id": "T000002R019460", "___s": true }, { "comment": "/**\r\n * Returns a uniformly distributed random point from anywhere within the given Ellipse.\r\n *\r\n * @function Phaser.Geom.Ellipse.Random\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Ellipse} ellipse - The Ellipse to get a random point from.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to set the random `x` and `y` values in.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 object with the random values set in the `x` and `y` properties.\r\n */", "meta": { "filename": "Random.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\ellipse", "code": {} }, "description": "Returns a uniformly distributed random point from anywhere within the given Ellipse.", "kind": "function", "name": "Random", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Ellipse" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Ellipse" } }, "description": "The Ellipse to get a random point from.", "name": "ellipse" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 object to set the random `x` and `y` values in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 object with the random values set in the `x` and `y` properties." } ], "memberof": "Phaser.Geom.Ellipse", "longname": "Phaser.Geom.Ellipse.Random", "scope": "static", "___id": "T000002R019466", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Geom\r\n */", "meta": { "filename": "index.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom", "code": {} }, "kind": "namespace", "name": "Geom", "memberof": "Phaser", "longname": "Phaser.Geom", "scope": "static", "___id": "T000002R019476", "___s": true }, { "comment": "/**\r\n * Checks if two Circles intersect.\r\n *\r\n * @function Phaser.Geom.Intersects.CircleToCircle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Circle} circleA - The first Circle to check for intersection.\r\n * @param {Phaser.Geom.Circle} circleB - The second Circle to check for intersection.\r\n *\r\n * @return {boolean} `true` if the two Circles intersect, otherwise `false`.\r\n */", "meta": { "filename": "CircleToCircle.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks if two Circles intersect.", "kind": "function", "name": "CircleToCircle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The first Circle to check for intersection.", "name": "circleA" }, { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The second Circle to check for intersection.", "name": "circleB" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the two Circles intersect, otherwise `false`." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.CircleToCircle", "scope": "static", "___id": "T000002R019488", "___s": true }, { "comment": "/**\r\n * Checks for intersection between a circle and a rectangle.\r\n *\r\n * @function Phaser.Geom.Intersects.CircleToRectangle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The circle to be checked.\r\n * @param {Phaser.Geom.Rectangle} rect - The rectangle to be checked.\r\n *\r\n * @return {boolean} `true` if the two objects intersect, otherwise `false`.\r\n */", "meta": { "filename": "CircleToRectangle.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks for intersection between a circle and a rectangle.", "kind": "function", "name": "CircleToRectangle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The circle to be checked.", "name": "circle" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The rectangle to be checked.", "name": "rect" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the two objects intersect, otherwise `false`." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.CircleToRectangle", "scope": "static", "___id": "T000002R019491", "___s": true }, { "comment": "/**\r\n * Checks if two Circles intersect and returns the intersection points as a Point object array.\r\n *\r\n * @function Phaser.Geom.Intersects.GetCircleToCircle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Circle} circleA - The first Circle to check for intersection.\r\n * @param {Phaser.Geom.Circle} circleB - The second Circle to check for intersection.\r\n * @param {Phaser.Math.Vector2[]} [out] - An optional array of Vector2 objects in which to store the points of intersection.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array with the points of intersection if objects intersect, otherwise an empty array.\r\n */", "meta": { "filename": "GetCircleToCircle.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The first Circle to check for intersection.", "name": "circleA" }, { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The second Circle to check for intersection.", "name": "circleB" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of Vector2 objects in which to store the points of intersection.", "name": "out" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "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", "___id": "T000002R019507", "___s": true }, { "comment": "/**\r\n * Checks for intersection between a circle and a rectangle, and returns the\r\n * intersection points as an array of Point objects. If the shapes do not intersect,\r\n * an empty array is returned. If they do intersect, each of the rectangle's four\r\n * edges is tested against the circle and any intersection points found are added to\r\n * the output array.\r\n *\r\n * @function Phaser.Geom.Intersects.GetCircleToRectangle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Circle} circle - The circle to be checked.\r\n * @param {Phaser.Geom.Rectangle} rect - The rectangle to be checked.\r\n * @param {array} [out] - An optional array in which to store the points of intersection.\r\n *\r\n * @return {array} An array with the points of intersection if objects intersect, otherwise an empty array.\r\n */", "meta": { "filename": "GetCircleToRectangle.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks for intersection between a circle and a rectangle, and returns the\rintersection points as an array of Point objects. If the shapes do not intersect,\ran empty array is returned. If they do intersect, each of the rectangle's four\redges is tested against the circle and any intersection points found are added to\rthe output array.", "kind": "function", "name": "GetCircleToRectangle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The circle to be checked.", "name": "circle" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The rectangle to be checked.", "name": "rect" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An optional array in which to store the points of intersection.", "name": "out" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R019538", "___s": true }, { "comment": "/**\r\n * Checks for intersection between the line segment and circle,\r\n * and returns the intersection points as a Vector2 object array.\r\n *\r\n * @function Phaser.Geom.Intersects.GetLineToCircle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line segment to check.\r\n * @param {Phaser.Geom.Circle} circle - The circle to check against the line.\r\n * @param {Phaser.Math.Vector2[]} [out] - An optional array of Vector2 objects in which to store the points of intersection.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array with the points of intersection if objects intersect, otherwise an empty array.\r\n */", "meta": { "filename": "GetLineToCircle.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks for intersection between the line segment and circle,\rand returns the intersection points as a Vector2 object array.", "kind": "function", "name": "GetLineToCircle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line segment to check.", "name": "line" }, { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The circle to check against the line.", "name": "circle" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of Vector2 objects in which to store the points of intersection.", "name": "out" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "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", "___id": "T000002R019548", "___s": true }, { "comment": "/**\r\n * Checks for intersection between the two line segments, or a ray and a line segment,\r\n * and returns the intersection point as a Vector3, or `null` if the lines are parallel, or do not intersect.\r\n *\r\n * The `z` property of the Vector3 contains the parametric `t` value (a scalar between 0 and 1)\r\n * representing how far along `line1` the intersection occurs. This can be used to sort or compare\r\n * multiple intersection results to find the closest intersecting point from a group of line segments.\r\n *\r\n * @function Phaser.Geom.Intersects.GetLineToLine\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Geom.Line} line1 - The first line segment, or a ray, to check.\r\n * @param {Phaser.Geom.Line} line2 - The second line segment to check.\r\n * @param {boolean} [isRay=false] - Is `line1` a ray or a line segment?\r\n * @param {Phaser.Math.Vector3} [out] - A Vector3 to store the intersection results in.\r\n *\r\n * @return {Phaser.Math.Vector3} A Vector3 where `x` and `y` are the intersection point coordinates and `z` is the parametric `t` value along `line1`, or `null` if the lines do not intersect.\r\n */", "meta": { "filename": "GetLineToLine.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks for intersection between the two line segments, or a ray and a line segment,\rand returns the intersection point as a Vector3, or `null` if the lines are parallel, or do not intersect.\r\rThe `z` property of the Vector3 contains the parametric `t` value (a scalar between 0 and 1)\rrepresenting how far along `line1` the intersection occurs. This can be used to sort or compare\rmultiple intersection results to find the closest intersecting point from a group of line segments.", "kind": "function", "name": "GetLineToLine", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The first line segment, or a ray, to check.", "name": "line1" }, { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The second line segment to check.", "name": "line2" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is `line1` a ray or a line segment?", "name": "isRay" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "optional": true, "description": "A Vector3 to store the intersection results in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "A Vector3 where `x` and `y` are the intersection point coordinates and `z` is the parametric `t` value along `line1`, or `null` if the lines do not intersect." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.GetLineToLine", "scope": "static", "___id": "T000002R019579", "___s": true }, { "comment": "/**\r\n * Checks for the closest point of intersection between a line segment and an array of points, where each consecutive pair\r\n * of points is converted to a line segment for the intersection tests. The array is treated as a closed shape, meaning\r\n * the last point is connected back to the first point.\r\n *\r\n * If no intersection is found, this function returns `null`.\r\n *\r\n * If intersection was found, a Vector3 is returned with the following properties:\r\n *\r\n * The `x` and `y` components contain the point of the intersection.\r\n * The `z` component contains the closest distance.\r\n *\r\n * @function Phaser.Geom.Intersects.GetLineToPoints\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line segment, or ray, to check. If a ray, set the `isRay` parameter to `true`.\r\n * @param {Phaser.Math.Vector2[] | Phaser.Math.Vector2[]} points - An array of points to check.\r\n * @param {boolean} [isRay=false] - Is `line` a ray or a line segment?\r\n * @param {Phaser.Math.Vector3} [out] - A Vector3 to store the intersection results in.\r\n *\r\n * @return {Phaser.Math.Vector3} A Vector3 containing the intersection results, or `null`.\r\n */", "meta": { "filename": "GetLineToPoints.js", "lineno": 17, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks for the closest point of intersection between a line segment and an array of points, where each consecutive pair\rof points is converted to a line segment for the intersection tests. The array is treated as a closed shape, meaning\rthe last point is connected back to the first point.\r\rIf no intersection is found, this function returns `null`.\r\rIf intersection was found, a Vector3 is returned with the following properties:\r\rThe `x` and `y` components contain the point of the intersection.\rThe `z` component contains the closest distance.", "kind": "function", "name": "GetLineToPoints", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line segment, or ray, to check. If a ray, set the `isRay` parameter to `true`.", "name": "line" }, { "type": { "names": [ "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } ] } }, "description": "An array of points to check.", "name": "points" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is `line` a ray or a line segment?", "name": "isRay" }, { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "optional": true, "description": "A Vector3 to store the intersection results in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector3" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector3" } }, "description": "A Vector3 containing the intersection results, or `null`." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.GetLineToPoints", "scope": "static", "___id": "T000002R019612", "___s": true }, { "comment": "/**\r\n * Checks for the closest point of intersection between a line segment and an array of polygons.\r\n *\r\n * If no intersection is found, this function returns `null`.\r\n *\r\n * If intersection was found, a Vector4 is returned with the following properties:\r\n *\r\n * The `x` and `y` components contain the point of the intersection.\r\n * The `z` component contains the closest distance.\r\n * The `w` component contains the index of the polygon, in the given array, that triggered the intersection.\r\n *\r\n * @function Phaser.Geom.Intersects.GetLineToPolygon\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line segment, or ray, to check. If a ray, set the `isRay` parameter to `true`.\r\n * @param {Phaser.Geom.Polygon | Phaser.Geom.Polygon[]} polygons - A single polygon, or array of polygons, to check.\r\n * @param {boolean} [isRay=false] - Is `line` a ray or a line segment?\r\n * @param {Phaser.Math.Vector4} [out] - A Vector4 to store the intersection results in.\r\n *\r\n * @return {Phaser.Math.Vector4} A Vector4 containing the intersection results, or `null`.\r\n */", "meta": { "filename": "GetLineToPolygon.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks for the closest point of intersection between a line segment and an array of polygons.\r\rIf no intersection is found, this function returns `null`.\r\rIf intersection was found, a Vector4 is returned with the following properties:\r\rThe `x` and `y` components contain the point of the intersection.\rThe `z` component contains the closest distance.\rThe `w` component contains the index of the polygon, in the given array, that triggered the intersection.", "kind": "function", "name": "GetLineToPolygon", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line segment, or ray, to check. If a ray, set the `isRay` parameter to `true`.", "name": "line" }, { "type": { "names": [ "Phaser.Geom.Polygon", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Polygon" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Polygon", "type": "NameExpression" } ] } ] } }, "description": "A single polygon, or array of polygons, to check.", "name": "polygons" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is `line` a ray or a line segment?", "name": "isRay" }, { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "optional": true, "description": "A Vector4 to store the intersection results in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector4" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector4" } }, "description": "A Vector4 containing the intersection results, or `null`." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.GetLineToPolygon", "scope": "static", "___id": "T000002R019627", "___s": true }, { "comment": "/**\r\n * Checks for intersection between the Line and a Rectangle shape,\r\n * and returns the intersection points as a Vector2 array.\r\n *\r\n * @function Phaser.Geom.Intersects.GetLineToRectangle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The Line to check for intersection.\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to check for intersection.\r\n * @param {Phaser.Math.Vector2[]} [out] - An optional array of Vector2 objects in which to store the points of intersection.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array with the points of intersection if objects intersect, otherwise an empty array.\r\n */", "meta": { "filename": "GetLineToRectangle.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks for intersection between the Line and a Rectangle shape,\rand returns the intersection points as a Vector2 array.", "kind": "function", "name": "GetLineToRectangle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The Line to check for intersection.", "name": "line" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to check for intersection.", "name": "rect" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of Vector2 objects in which to store the points of intersection.", "name": "out" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "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", "___id": "T000002R019638", "___s": true }, { "comment": "/**\r\n * Projects rays out from the given point to each vertex of the polygons.\r\n *\r\n * If the rays intersect with the polygons, the points of intersection are returned in an array.\r\n *\r\n * If no intersections are found, the returned array will be empty.\r\n *\r\n * Each Vector4 intersection result has the following properties:\r\n *\r\n * The `x` and `y` components contain the point of the intersection.\r\n * The `z` component contains the angle of the projected ray, in radians.\r\n * The `w` component contains the index of the polygon, in the given array, that triggered the intersection.\r\n *\r\n * @function Phaser.Geom.Intersects.GetRaysFromPointToPolygon\r\n * @since 3.50.0\r\n *\r\n * @param {number} x - The x coordinate to project the rays from.\r\n * @param {number} y - The y coordinate to project the rays from.\r\n * @param {Phaser.Geom.Polygon | Phaser.Geom.Polygon[]} polygons - A single polygon, or array of polygons, to check against the rays.\r\n *\r\n * @return {Phaser.Math.Vector4[]} An array containing all intersections in Vector4s.\r\n */", "meta": { "filename": "GetRaysFromPointToPolygon.js", "lineno": 40, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Projects rays out from the given point to each vertex of the polygons.\r\rIf the rays intersect with the polygons, the points of intersection are returned in an array.\r\rIf no intersections are found, the returned array will be empty.\r\rEach Vector4 intersection result has the following properties:\r\rThe `x` and `y` components contain the point of the intersection.\rThe `z` component contains the angle of the projected ray, in radians.\rThe `w` component contains the index of the polygon, in the given array, that triggered the intersection.", "kind": "function", "name": "GetRaysFromPointToPolygon", "since": "3.50.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to project the rays from.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to project the rays from.", "name": "y" }, { "type": { "names": [ "Phaser.Geom.Polygon", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Polygon" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Polygon", "type": "NameExpression" } ] } ] } }, "description": "A single polygon, or array of polygons, to check against the rays.", "name": "polygons" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector4", "type": "NameExpression" } ] } }, "description": "An array containing all intersections in Vector4s." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.GetRaysFromPointToPolygon", "scope": "static", "___id": "T000002R019658", "___s": true }, { "comment": "/**\r\n * Checks if two Rectangle shapes intersect and returns the area of this intersection as Rectangle object.\r\n *\r\n * If 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 will be empty Rectangle (all values set to zero).\r\n *\r\n * If 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.\r\n *\r\n * @function Phaser.Geom.Intersects.GetRectangleIntersection\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [output,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rectA - The first Rectangle object.\r\n * @param {Phaser.Geom.Rectangle} rectB - The second Rectangle object.\r\n * @param {Phaser.Geom.Rectangle} [output] - 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.\r\n *\r\n * @return {Phaser.Geom.Rectangle} A rectangle object with intersection data.\r\n */", "meta": { "filename": "GetRectangleIntersection.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks if two Rectangle shapes intersect and returns the area of this intersection as Rectangle object.\r\rIf 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 will be empty Rectangle (all values set to zero).\r\rIf 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [output,$return]", "value": "{Phaser.Geom.Rectangle} O - [output,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The first Rectangle object.", "name": "rectA" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The second Rectangle object.", "name": "rectB" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "A rectangle object with intersection data." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.GetRectangleIntersection", "scope": "static", "___id": "T000002R019670", "___s": true }, { "comment": "/**\r\n * Checks if two Rectangles intersect and returns the intersection points as a Point object array.\r\n *\r\n * A 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.\r\n *\r\n * @function Phaser.Geom.Intersects.GetRectangleToRectangle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rectA - The first Rectangle to check for intersection.\r\n * @param {Phaser.Geom.Rectangle} rectB - The second Rectangle to check for intersection.\r\n * @param {array} [out] - An optional array in which to store the points of intersection.\r\n *\r\n * @return {array} An array with the points of intersection if objects intersect, otherwise an empty array.\r\n */", "meta": { "filename": "GetRectangleToRectangle.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks if two Rectangles intersect and returns the intersection points as a Point object array.\r\rA 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The first Rectangle to check for intersection.", "name": "rectA" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The second Rectangle to check for intersection.", "name": "rectB" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An optional array in which to store the points of intersection.", "name": "out" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R019680", "___s": true }, { "comment": "/**\r\n * Checks for intersection between Rectangle shape and Triangle shape,\r\n * and returns the intersection points as a Point object array.\r\n *\r\n * @function Phaser.Geom.Intersects.GetRectangleToTriangle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - Rectangle object to test.\r\n * @param {Phaser.Geom.Triangle} triangle - Triangle object to test.\r\n * @param {array} [out] - An optional array in which to store the points of intersection.\r\n *\r\n * @return {array} An array with the points of intersection if objects intersect, otherwise an empty array.\r\n */", "meta": { "filename": "GetRectangleToTriangle.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks for intersection between Rectangle shape and Triangle shape,\rand returns the intersection points as a Point object array.", "kind": "function", "name": "GetRectangleToTriangle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "Rectangle object to test.", "name": "rect" }, { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "Triangle object to test.", "name": "triangle" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An optional array in which to store the points of intersection.", "name": "out" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R019690", "___s": true }, { "comment": "/**\r\n * Checks if a Triangle and a Circle intersect, and returns the intersection points as a Point object array.\r\n *\r\n * A 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.\r\n *\r\n * @function Phaser.Geom.Intersects.GetTriangleToCircle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to check for intersection.\r\n * @param {Phaser.Geom.Circle} circle - The Circle to check for intersection.\r\n * @param {array} [out] - An optional array in which to store the points of intersection.\r\n *\r\n * @return {array} An array with the points of intersection if objects intersect, otherwise an empty array.\r\n */", "meta": { "filename": "GetTriangleToCircle.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks if a Triangle and a Circle intersect, and returns the intersection points as a Point object array.\r\rA 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to check for intersection.", "name": "triangle" }, { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to check for intersection.", "name": "circle" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An optional array in which to store the points of intersection.", "name": "out" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R019699", "___s": true }, { "comment": "/**\r\n * Checks if a Triangle and a Line intersect, and returns the intersection points as a Point object array.\r\n *\r\n * The 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\".\r\n *\r\n * @function Phaser.Geom.Intersects.GetTriangleToLine\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to check with.\r\n * @param {Phaser.Geom.Line} line - The Line to check with.\r\n * @param {Phaser.Math.Vector2[]} [out] - An optional array of Vector2 objects in which to store the points of intersection.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array with the points of intersection if objects intersect, otherwise an empty array.\r\n */", "meta": { "filename": "GetTriangleToLine.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks if a Triangle and a Line intersect, and returns the intersection points as a Point object array.\r\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to check with.", "name": "triangle" }, { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The Line to check with.", "name": "line" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of Vector2 objects in which to store the points of intersection.", "name": "out" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "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", "___id": "T000002R019709", "___s": true }, { "comment": "/**\r\n * Checks if two Triangles intersect, and returns the intersection points as a Point object array.\r\n *\r\n * A 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\".\r\n *\r\n * @function Phaser.Geom.Intersects.GetTriangleToTriangle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangleA - The first Triangle to check for intersection.\r\n * @param {Phaser.Geom.Triangle} triangleB - The second Triangle to check for intersection.\r\n * @param {array} [out] - An optional array in which to store the points of intersection.\r\n *\r\n * @return {array} An array with the points of intersection if objects intersect, otherwise an empty array.\r\n */", "meta": { "filename": "GetTriangleToTriangle.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks if two Triangles intersect, and returns the intersection points as a Point object array.\r\rA 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The first Triangle to check for intersection.", "name": "triangleA" }, { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The second Triangle to check for intersection.", "name": "triangleB" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An optional array in which to store the points of intersection.", "name": "out" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R019721", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Geom.Intersects\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "kind": "namespace", "name": "Intersects", "memberof": "Phaser.Geom", "longname": "Phaser.Geom.Intersects", "scope": "static", "___id": "T000002R019728", "___s": true }, { "comment": "/**\r\n * Checks for intersection between the line segment and circle.\r\n *\r\n * Based on code by [Matt DesLauriers](https://github.com/mattdesl/line-circle-collision/blob/master/LICENSE.md).\r\n *\r\n * @function Phaser.Geom.Intersects.LineToCircle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line segment to check.\r\n * @param {Phaser.Geom.Circle} circle - The circle to check against the line.\r\n * @param {Phaser.Math.Vector2} [nearest] - An optional Vector2 object. If given the closest point on the Line where the circle intersects will be stored in this object.\r\n *\r\n * @return {boolean} `true` if the two objects intersect, otherwise `false`.\r\n */", "meta": { "filename": "LineToCircle.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks for intersection between the line segment and circle.\r\rBased 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line segment to check.", "name": "line" }, { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The circle to check against the line.", "name": "circle" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "An optional Vector2 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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the two objects intersect, otherwise `false`." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.LineToCircle", "scope": "static", "___id": "T000002R019760", "___s": true }, { "comment": "/**\r\n * Checks if two Lines intersect. If the Lines are identical, they will be treated as parallel and thus non-intersecting.\r\n *\r\n * @function Phaser.Geom.Intersects.LineToLine\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line1 - The first Line to check.\r\n * @param {Phaser.Geom.Line} line2 - The second Line to check.\r\n * @param {Phaser.Types.Math.Vector2Like} [out] - An optional point-like object in which to store the coordinates of intersection, if needed.\r\n *\r\n * @return {boolean} `true` if the two Lines intersect, and the `out` object will be populated, if given. Otherwise, `false`.\r\n */", "meta": { "filename": "LineToLine.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The first Line to check.", "name": "line1" }, { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The second Line to check.", "name": "line2" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "optional": true, "description": "An optional point-like object in which to store the coordinates of intersection, if needed.", "name": "out" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R019781", "___s": true }, { "comment": "/**\r\n * Checks for intersection between the Line and a Rectangle shape, or a rectangle-like\r\n * object, with public `x`, `y`, `right` and `bottom` properties, such as a Sprite or Body.\r\n *\r\n * An intersection is considered valid if:\r\n *\r\n * The line starts within, or ends within, the Rectangle.\r\n * The line segment intersects one of the 4 rectangle edges.\r\n *\r\n * For the purposes of this function rectangles are considered 'solid'.\r\n *\r\n * @function Phaser.Geom.Intersects.LineToRectangle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The Line to check for intersection.\r\n * @param {(Phaser.Geom.Rectangle|object)} rect - The Rectangle to check for intersection.\r\n *\r\n * @return {boolean} `true` if the Line and the Rectangle intersect, `false` otherwise.\r\n */", "meta": { "filename": "LineToRectangle.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks for intersection between the Line and a Rectangle shape, or a rectangle-like\robject, with public `x`, `y`, `right` and `bottom` properties, such as a Sprite or Body.\r\rAn intersection is considered valid if:\r\rThe line starts within, or ends within, the Rectangle.\rThe line segment intersects one of the 4 rectangle edges.\r\rFor the purposes of this function rectangles are considered 'solid'.", "kind": "function", "name": "LineToRectangle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The Line to check for intersection.", "name": "line" }, { "type": { "names": [ "Phaser.Geom.Rectangle", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "object" } ] } }, "description": "The Rectangle to check for intersection.", "name": "rect" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Line and the Rectangle intersect, `false` otherwise." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.LineToRectangle", "scope": "static", "___id": "T000002R019797", "___s": true }, { "comment": "/**\r\n * Checks if a Point falls between the two end-points of a Line, based on the given line thickness.\r\n *\r\n * Assumes that the line end points are circular, not square.\r\n *\r\n * @function Phaser.Geom.Intersects.PointToLine\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.Math.Vector2|any)} point - The point, or point-like object to check.\r\n * @param {Phaser.Geom.Line} line - The line segment to test for intersection on.\r\n * @param {number} [lineThickness=1] - The line thickness. Assumes that the line end points are circular.\r\n *\r\n * @return {boolean} `true` if the Point falls on the Line, otherwise `false`.\r\n */", "meta": { "filename": "PointToLine.js", "lineno": 8, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks if a Point falls between the two end-points of a Line, based on the given line thickness.\r\rAssumes that the line end points are circular, not square.", "kind": "function", "name": "PointToLine", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2", "any" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "any" } ] } }, "description": "The point, or point-like object to check.", "name": "point" }, { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line segment to test for intersection on.", "name": "line" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "The line thickness. Assumes that the line end points are circular.", "name": "lineThickness" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Point falls on the Line, otherwise `false`." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.PointToLine", "scope": "static", "___id": "T000002R019813", "___s": true }, { "comment": "/**\r\n * Checks if a Point is located on the given line segment.\r\n *\r\n * @function Phaser.Geom.Intersects.PointToLineSegment\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Math.Vector2} point - The Point to check for intersection.\r\n * @param {Phaser.Geom.Line} line - The line segment to check for intersection.\r\n *\r\n * @return {boolean} `true` if the Point is on the given line segment, otherwise `false`.\r\n */", "meta": { "filename": "PointToLineSegment.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks if a Point is located on the given line segment.", "kind": "function", "name": "PointToLineSegment", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The Point to check for intersection.", "name": "point" }, { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line segment to check for intersection.", "name": "line" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R019827", "___s": true }, { "comment": "/**\r\n * Checks if two Rectangles intersect.\r\n *\r\n * A Rectangle intersects another Rectangle if any part of its bounds is within the other Rectangle's bounds.\r\n * As such, the two Rectangles are considered \"solid\".\r\n * A Rectangle with no width or no height will never intersect another Rectangle.\r\n *\r\n * @function Phaser.Geom.Intersects.RectangleToRectangle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rectA - The first Rectangle to check for intersection.\r\n * @param {Phaser.Geom.Rectangle} rectB - The second Rectangle to check for intersection.\r\n *\r\n * @return {boolean} `true` if the two Rectangles intersect, otherwise `false`.\r\n */", "meta": { "filename": "RectangleToRectangle.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks if two Rectangles intersect.\r\rA Rectangle intersects another Rectangle if any part of its bounds is within the other Rectangle's bounds.\rAs such, the two Rectangles are considered \"solid\".\rA 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The first Rectangle to check for intersection.", "name": "rectA" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The second Rectangle to check for intersection.", "name": "rectB" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the two Rectangles intersect, otherwise `false`." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.RectangleToRectangle", "scope": "static", "___id": "T000002R019834", "___s": true }, { "comment": "/**\r\n * Checks for intersection between a Rectangle and a Triangle shape.\r\n *\r\n * The test is performed in multiple stages of increasing cost. First, the bounding\r\n * boxes of the two shapes are compared for a quick early-out. If they overlap, the\r\n * test checks whether any triangle vertex lies inside the rectangle, then whether any\r\n * edge of the triangle intersects any edge of the rectangle, and finally whether any\r\n * corner of the rectangle lies inside the triangle.\r\n *\r\n * @function Phaser.Geom.Intersects.RectangleToTriangle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to test.\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to test.\r\n *\r\n * @return {boolean} A value of `true` if objects intersect; otherwise `false`.\r\n */", "meta": { "filename": "RectangleToTriangle.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks for intersection between a Rectangle and a Triangle shape.\r\rThe test is performed in multiple stages of increasing cost. First, the bounding\rboxes of the two shapes are compared for a quick early-out. If they overlap, the\rtest checks whether any triangle vertex lies inside the rectangle, then whether any\redge of the triangle intersects any edge of the rectangle, and finally whether any\rcorner of the rectangle lies inside the triangle.", "kind": "function", "name": "RectangleToTriangle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to test.", "name": "rect" }, { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to test.", "name": "triangle" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "A value of `true` if objects intersect; otherwise `false`." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.RectangleToTriangle", "scope": "static", "___id": "T000002R019841", "___s": true }, { "comment": "/**\r\n * Checks if a Rectangle intersects with a region defined by explicit left, right, top, and bottom boundary values.\r\n *\r\n * @function Phaser.Geom.Intersects.RectangleToValues\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to check for intersection.\r\n * @param {number} left - The x coordinate of the left edge of the region to check against.\r\n * @param {number} right - The x coordinate of the right edge of the region to check against.\r\n * @param {number} top - The y coordinate of the top edge of the region to check against.\r\n * @param {number} bottom - The y coordinate of the bottom edge of the region to check against.\r\n * @param {number} [tolerance=0] - Tolerance allowed in the calculation, expressed in pixels.\r\n *\r\n * @return {boolean} Returns true if there is an intersection.\r\n */", "meta": { "filename": "RectangleToValues.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks if a Rectangle intersects with a region defined by explicit left, right, top, and bottom boundary values.", "kind": "function", "name": "RectangleToValues", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to check for intersection.", "name": "rect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the left edge of the region to check against.", "name": "left" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the right edge of the region to check against.", "name": "right" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the top edge of the region to check against.", "name": "top" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the bottom edge of the region to check against.", "name": "bottom" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "Tolerance allowed in the calculation, expressed in pixels.", "name": "tolerance" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Returns true if there is an intersection." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.RectangleToValues", "scope": "static", "___id": "T000002R019853", "___s": true }, { "comment": "/**\r\n * Checks if a Triangle and a Circle intersect.\r\n *\r\n * A 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.\r\n *\r\n * @function Phaser.Geom.Intersects.TriangleToCircle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to check for intersection.\r\n * @param {Phaser.Geom.Circle} circle - The Circle to check for intersection.\r\n *\r\n * @return {boolean} `true` if the Triangle and the `Circle` intersect, otherwise `false`.\r\n */", "meta": { "filename": "TriangleToCircle.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks if a Triangle and a Circle intersect.\r\rA 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to check for intersection.", "name": "triangle" }, { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "description": "The Circle to check for intersection.", "name": "circle" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Triangle and the `Circle` intersect, otherwise `false`." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.TriangleToCircle", "scope": "static", "___id": "T000002R019859", "___s": true }, { "comment": "/**\r\n * Checks if a Triangle and a Line intersect.\r\n *\r\n * The 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\".\r\n *\r\n * @function Phaser.Geom.Intersects.TriangleToLine\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to check with.\r\n * @param {Phaser.Geom.Line} line - The Line to check with.\r\n *\r\n * @return {boolean} `true` if the Triangle and the Line intersect, otherwise `false`.\r\n */", "meta": { "filename": "TriangleToLine.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks if a Triangle and a Line intersect.\r\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to check with.", "name": "triangle" }, { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The Line to check with.", "name": "line" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Triangle and the Line intersect, otherwise `false`." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.TriangleToLine", "scope": "static", "___id": "T000002R019863", "___s": true }, { "comment": "/**\r\n * Checks if two Triangles intersect.\r\n *\r\n * A 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\".\r\n *\r\n * @function Phaser.Geom.Intersects.TriangleToTriangle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangleA - The first Triangle to check for intersection.\r\n * @param {Phaser.Geom.Triangle} triangleB - The second Triangle to check for intersection.\r\n *\r\n * @return {boolean} `true` if the Triangles intersect, otherwise `false`.\r\n */", "meta": { "filename": "TriangleToTriangle.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\intersects", "code": {} }, "description": "Checks if two Triangles intersect.\r\rA 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The first Triangle to check for intersection.", "name": "triangleA" }, { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The second Triangle to check for intersection.", "name": "triangleB" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Triangles intersect, otherwise `false`." } ], "memberof": "Phaser.Geom.Intersects", "longname": "Phaser.Geom.Intersects.TriangleToTriangle", "scope": "static", "___id": "T000002R019869", "___s": true }, { "comment": "/**\r\n * Calculate the angle of the line in radians.\r\n *\r\n * @function Phaser.Geom.Line.Angle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to calculate the angle of.\r\n *\r\n * @return {number} The angle of the line, in radians.\r\n */", "meta": { "filename": "Angle.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Calculate the angle of the line in radians.", "kind": "function", "name": "Angle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to calculate the angle of.", "name": "line" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of the line, in radians." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Angle", "scope": "static", "___id": "T000002R019882", "___s": true }, { "comment": "/**\r\n * Using Bresenham's line algorithm this will return an array of all coordinates on the given line.\r\n *\r\n * The `start` and `end` points are rounded before this runs as the algorithm works on integers.\r\n *\r\n * @function Phaser.Geom.Line.BresenhamPoints\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line.\r\n * @param {number} [stepRate=1] - Controls how densely the points are sampled along the line. A value of 1 returns every integer coordinate; a value of 2 returns every other coordinate, and so on.\r\n * @param {Phaser.Types.Math.Vector2Like[]} [results] - An optional array to push the resulting coordinates into.\r\n *\r\n * @return {Phaser.Types.Math.Vector2Like[]} The array of coordinates on the line.\r\n */", "meta": { "filename": "BresenhamPoints.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Using Bresenham's line algorithm this will return an array of all coordinates on the given line.\r\rThe `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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line.", "name": "line" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Controls how densely the points are sampled along the line. A value of 1 returns every integer coordinate; a value of 2 returns every other coordinate, and so on.", "name": "stepRate" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array to push the resulting coordinates into.", "name": "results" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } }, "description": "The array of coordinates on the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.BresenhamPoints", "scope": "static", "___id": "T000002R019885", "___s": true }, { "comment": "/**\r\n * Center a line on the given coordinates.\r\n *\r\n * @function Phaser.Geom.Line.CenterOn\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to center.\r\n * @param {number} x - The horizontal coordinate to center the line on.\r\n * @param {number} y - The vertical coordinate to center the line on.\r\n *\r\n * @return {Phaser.Geom.Line} The centered line.\r\n */", "meta": { "filename": "CenterOn.js", "lineno": 8, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Center a line on the given coordinates.", "kind": "function", "name": "CenterOn", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to center.", "name": "line" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate to center the line on.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate to center the line on.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The centered line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.CenterOn", "scope": "static", "___id": "T000002R019909", "___s": true }, { "comment": "/**\r\n * Clone the given line.\r\n *\r\n * @function Phaser.Geom.Line.Clone\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} source - The source line to clone.\r\n *\r\n * @return {Phaser.Geom.Line} The cloned line.\r\n */", "meta": { "filename": "Clone.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Clone the given line.", "kind": "function", "name": "Clone", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The source line to clone.", "name": "source" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The cloned line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Clone", "scope": "static", "___id": "T000002R019919", "___s": true }, { "comment": "/**\r\n * Copy the values of one line to a destination line.\r\n *\r\n * @function Phaser.Geom.Line.CopyFrom\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Line} O - [dest,$return]\r\n *\r\n * @param {Phaser.Geom.Line} source - The source line to copy the values from.\r\n * @param {Phaser.Geom.Line} dest - The destination line to copy the values to.\r\n *\r\n * @return {Phaser.Geom.Line} The destination line.\r\n */", "meta": { "filename": "CopyFrom.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Copy the values of one line to a destination line.", "kind": "function", "name": "CopyFrom", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Line} O - [dest,$return]", "value": "{Phaser.Geom.Line} O - [dest,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The source line to copy the values from.", "name": "source" }, { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The destination line to copy the values to.", "name": "dest" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The destination line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.CopyFrom", "scope": "static", "___id": "T000002R019922", "___s": true }, { "comment": "/**\r\n * Compares two lines for strict equality. Two lines are considered equal if their start\r\n * and end point coordinates all match exactly: `x1`, `y1`, `x2`, and `y2`.\r\n *\r\n * @function Phaser.Geom.Line.Equals\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The first line to compare.\r\n * @param {Phaser.Geom.Line} toCompare - The second line to compare.\r\n *\r\n * @return {boolean} `true` if the two lines have identical start and end point coordinates, otherwise `false`.\r\n */", "meta": { "filename": "Equals.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Compares two lines for strict equality. Two lines are considered equal if their start\rand end point coordinates all match exactly: `x1`, `y1`, `x2`, and `y2`.", "kind": "function", "name": "Equals", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The first line to compare.", "name": "line" }, { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The second line to compare.", "name": "toCompare" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the two lines have identical start and end point coordinates, otherwise `false`." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Equals", "scope": "static", "___id": "T000002R019925", "___s": true }, { "comment": "/**\r\n * Extends the start and end points of a Line by the given amounts.\r\n *\r\n * The amounts can be positive or negative. Positive values will increase the length of the line,\r\n * while negative ones will decrease it.\r\n *\r\n * If no `right` value is provided it will extend the length of the line equally in both directions.\r\n *\r\n * Pass a value of zero to leave the start or end point unchanged.\r\n *\r\n * The `left` value extends outward from the start point (x1, y1) along the line's direction, and the `right` value extends outward from the end point (x2, y2).\r\n *\r\n * @function Phaser.Geom.Line.Extend\r\n * @since 3.16.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line instance to extend.\r\n * @param {number} left - The amount to extend the start of the line by.\r\n * @param {number} [right] - The amount to extend the end of the line by. If not given it will be set to the `left` value.\r\n *\r\n * @return {Phaser.Geom.Line} The modified Line instance.\r\n */", "meta": { "filename": "Extend.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Extends the start and end points of a Line by the given amounts.\r\rThe amounts can be positive or negative. Positive values will increase the length of the line,\rwhile negative ones will decrease it.\r\rIf no `right` value is provided it will extend the length of the line equally in both directions.\r\rPass a value of zero to leave the start or end point unchanged.\r\rThe `left` value extends outward from the start point (x1, y1) along the line's direction, and the `right` value extends outward from the end point (x2, y2).", "kind": "function", "name": "Extend", "since": "3.16.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line instance to extend.", "name": "line" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to extend the start of the line by.", "name": "left" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The modified Line instance." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Extend", "scope": "static", "___id": "T000002R019929", "___s": true }, { "comment": "/**\r\n * Returns an array of `quantity` Points where each point is taken from the given Line,\r\n * spaced out according to the ease function specified.\r\n * \r\n * ```javascript\r\n * const line = new Phaser.Geom.Line(100, 300, 700, 300);\r\n * const points = Phaser.Geom.Line.GetEasedPoints(line, 'sine.out', 32)\r\n * ```\r\n * \r\n * In the above example, the `points` array will contain 32 points spread-out across\r\n * the length of `line`, where the position of each point is determined by the `Sine.out`\r\n * ease function.\r\n * \r\n * You can optionally provide a collinear threshold. In this case, the resulting points\r\n * are checked against each other, and if they are `< collinearThreshold` distance apart,\r\n * they are dropped from the results. This can help avoid lots of clustered points at\r\n * far ends of the line with tightly-packed eases such as Quartic. Leave the value set\r\n * to zero to skip this check.\r\n * \r\n * Note that if you provide a collinear threshold, the resulting array may not always\r\n * contain `quantity` points.\r\n *\r\n * @function Phaser.Geom.Line.GetEasedPoints\r\n * @since 3.23.0\r\n *\r\n * @generic {Phaser.Math.Vector2[]} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The Line object.\r\n * @param {(string|function)} ease - The ease to use. This can be either a string from the EaseMap, or a custom function.\r\n * @param {number} quantity - The number of points to return. Note that if you provide a `collinearThreshold`, the resulting array may not always contain this number of points.\r\n * @param {number} [collinearThreshold=0] - An optional threshold. The final array is reduced so that each point is spaced out at least this distance apart. This helps reduce clustering in noisy eases.\r\n * @param {number[]} [easeParams] - An optional array of ease parameters to go with the ease.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Math.Vector2s containing the coordinates of the points on the line.\r\n */", "meta": { "filename": "GetEasedPoints.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Returns an array of `quantity` Points where each point is taken from the given Line,\rspaced out according to the ease function specified.\r\r```javascript\rconst line = new Phaser.Geom.Line(100, 300, 700, 300);\rconst points = Phaser.Geom.Line.GetEasedPoints(line, 'sine.out', 32)\r```\r\rIn the above example, the `points` array will contain 32 points spread-out across\rthe length of `line`, where the position of each point is determined by the `Sine.out`\rease function.\r\rYou can optionally provide a collinear threshold. In this case, the resulting points\rare checked against each other, and if they are `< collinearThreshold` distance apart,\rthey are dropped from the results. This can help avoid lots of clustered points at\rfar ends of the line with tightly-packed eases such as Quartic. Leave the value set\rto zero to skip this check.\r\rNote that if you provide a collinear threshold, the resulting array may not always\rcontain `quantity` points.", "kind": "function", "name": "GetEasedPoints", "since": "3.23.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [out,$return]", "value": "{Phaser.Math.Vector2[]} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The Line object.", "name": "line" }, { "type": { "names": [ "string", "function" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "FunctionType", "params": [] } ] } }, "description": "The ease to use. This can be either a string from the EaseMap, or a custom function.", "name": "ease" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of points to return. Note that if you provide a `collinearThreshold`, the resulting array may not always contain this number of points.", "name": "quantity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "An optional threshold. The final array is reduced so that each point is spaced out at least this distance apart. This helps reduce clustering in noisy eases.", "name": "collinearThreshold" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of ease parameters to go with the ease.", "name": "easeParams" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Math.Vector2s containing the coordinates of the points on the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.GetEasedPoints", "scope": "static", "___id": "T000002R019943", "___s": true }, { "comment": "/**\r\n * Get the midpoint of the given line.\r\n *\r\n * @function Phaser.Geom.Line.GetMidPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to get the midpoint of.\r\n * @param {Phaser.Math.Vector2} [out] - An optional Vector2 object to store the midpoint in.\r\n *\r\n * @return {Phaser.Math.Vector2} The midpoint of the Line.\r\n */", "meta": { "filename": "GetMidPoint.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Get the midpoint of the given line.", "kind": "function", "name": "GetMidPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to get the midpoint of.", "name": "line" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "An optional Vector2 object to store the midpoint in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The midpoint of the Line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.GetMidPoint", "scope": "static", "___id": "T000002R019967", "___s": true }, { "comment": "/**\r\n * Gets the nearest point on the infinite line defined by the given Line segment to the specified point.\r\n * Note that the returned point is projected onto the full line, not clamped to the segment endpoints.\r\n *\r\n * @function Phaser.Geom.Line.GetNearestPoint\r\n * @since 3.16.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to get the nearest point on.\r\n * @param {Phaser.Math.Vector2} vec - The Vector2 to get the nearest point to.\r\n * @param {Phaser.Math.Vector2} [out] - An optional Vector2 object, to store the coordinates of the nearest point on the line.\r\n *\r\n * @return {Phaser.Math.Vector2} The nearest point on the line.\r\n */", "meta": { "filename": "GetNearestPoint.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Gets the nearest point on the infinite line defined by the given Line segment to the specified point.\rNote that the returned point is projected onto the full line, not clamped to the segment endpoints.", "kind": "function", "name": "GetNearestPoint", "since": "3.16.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to get the nearest point on.", "name": "line" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The Vector2 to get the nearest point to.", "name": "vec" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "An optional Vector2 object, to store the coordinates of the nearest point on the line.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The nearest point on the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.GetNearestPoint", "scope": "static", "___id": "T000002R019974", "___s": true }, { "comment": "/**\r\n * Calculate the normal of the given line.\r\n *\r\n * The normal of a line is a vector that points perpendicular from it.\r\n *\r\n * @function Phaser.Geom.Line.GetNormal\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to calculate the normal of.\r\n * @param {Phaser.Math.Vector2} [out] - An optional Vector2 object to store the normal in.\r\n *\r\n * @return {Phaser.Math.Vector2} The normal of the Line.\r\n */", "meta": { "filename": "GetNormal.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Calculate the normal of the given line.\r\rThe normal of a line is a vector that points perpendicular from it.", "kind": "function", "name": "GetNormal", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to calculate the normal of.", "name": "line" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "An optional Vector2 object to store the normal in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The normal of the Line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.GetNormal", "scope": "static", "___id": "T000002R019989", "___s": true }, { "comment": "/**\r\n * Get a point on a line that's a given percentage along its length.\r\n *\r\n * @function Phaser.Geom.Line.GetPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The line.\r\n * @param {number} position - A value between 0 and 1, where 0 is the start, 0.5 is the middle and 1 is the end of the line.\r\n * @param {Phaser.Math.Vector2} [out] - An optional Vector2 object to store the coordinates of the point on the line.\r\n *\r\n * @return {Phaser.Math.Vector2} The point on the line.\r\n */", "meta": { "filename": "GetPoint.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Get a point on a line that's a given percentage along its length.", "kind": "function", "name": "GetPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line.", "name": "line" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "An optional Vector2 object to store the coordinates of the point on the line.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point on the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.GetPoint", "scope": "static", "___id": "T000002R019997", "___s": true }, { "comment": "/**\r\n * Get a number of evenly-spaced points along a line, starting from the first endpoint (x1, y1).\r\n * The last endpoint (x2, y2) is not included in the returned points.\r\n *\r\n * Provide a `quantity` to get an exact number of points along the line.\r\n *\r\n * Provide a `stepRate` to ensure a specific distance between each point on the line. Set `quantity` to `0` when\r\n * providing a `stepRate`.\r\n *\r\n * See also `GetEasedPoints` for a way to distribute the points across the line according to an ease type or input function.\r\n *\r\n * @function Phaser.Geom.Line.GetPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2[]} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The line.\r\n * @param {number} quantity - The number of points to place on the line. Set to `0` to use `stepRate` instead.\r\n * @param {number} [stepRate] - The distance between each point on the line. When set, `quantity` is calculated as the line length divided by this value; `quantity` should be set to `0`.\r\n * @param {Phaser.Math.Vector2[]} [out] - An optional array of Vector2 objects to store the coordinates of the points on the line.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2 objects containing the coordinates of the points on the line.\r\n */", "meta": { "filename": "GetPoints.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Get a number of evenly-spaced points along a line, starting from the first endpoint (x1, y1).\rThe last endpoint (x2, y2) is not included in the returned points.\r\rProvide a `quantity` to get an exact number of points along the line.\r\rProvide a `stepRate` to ensure a specific distance between each point on the line. Set `quantity` to `0` when\rproviding a `stepRate`.\r\rSee also `GetEasedPoints` for a way to distribute the points across the line according to an ease type or input function.", "kind": "function", "name": "GetPoints", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [out,$return]", "value": "{Phaser.Math.Vector2[]} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line.", "name": "line" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of points to place on the line. Set to `0` to use `stepRate` instead.", "name": "quantity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The distance between each point on the line. When set, `quantity` is calculated as the line length divided by this value; `quantity` should be set to `0`.", "name": "stepRate" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of Vector2 objects to store the coordinates of the points on the line.", "name": "out" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2 objects containing the coordinates of the points on the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.GetPoints", "scope": "static", "___id": "T000002R020005", "___s": true }, { "comment": "/**\r\n * Calculates the shortest (perpendicular) distance from an infinite line, defined by the two\r\n * endpoints of the given Line object, to the given Point. If the line has zero length (both\r\n * endpoints are identical), this function returns `false`.\r\n *\r\n * @function Phaser.Geom.Line.GetShortestDistance\r\n * @since 3.16.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to get the distance from.\r\n * @param {Phaser.Types.Math.Vector2Like} point - The point to get the shortest distance to.\r\n *\r\n * @return {(boolean|number)} The shortest perpendicular distance from the line to the point, or `false` if the line has zero length.\r\n */", "meta": { "filename": "GetShortestDistance.js", "lineno": 8, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Calculates the shortest (perpendicular) distance from an infinite line, defined by the two\rendpoints of the given Line object, to the given Point. If the line has zero length (both\rendpoints are identical), this function returns `false`.", "kind": "function", "name": "GetShortestDistance", "since": "3.16.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to get the distance from.", "name": "line" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "The point to get the shortest distance to.", "name": "point" } ], "returns": [ { "type": { "names": [ "boolean", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "The shortest perpendicular distance from the line to the point, or `false` if the line has zero length." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.GetShortestDistance", "scope": "static", "___id": "T000002R020018", "___s": true }, { "comment": "/**\r\n * Calculate the height of the given line.\r\n *\r\n * @function Phaser.Geom.Line.Height\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to calculate the height of.\r\n *\r\n * @return {number} The height of the line.\r\n */", "meta": { "filename": "Height.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Calculate the height of the given line.", "kind": "function", "name": "Height", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to calculate the height of.", "name": "line" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Height", "scope": "static", "___id": "T000002R020027", "___s": true }, { "comment": "/**\r\n * Calculate the length of the given line.\r\n *\r\n * @function Phaser.Geom.Line.Length\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to calculate the length of.\r\n *\r\n * @return {number} The length of the line.\r\n */", "meta": { "filename": "Length.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Calculate the length of the given line.", "kind": "function", "name": "Length", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to calculate the length of.", "name": "line" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Length", "scope": "static", "___id": "T000002R020061", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Defines a Line segment: a finite portion of a line described by a start point (`x1`, `y1`)\r\n * and an end point (`x2`, `y2`). Unlike an infinite mathematical line, a Line segment has a\r\n * fixed length and direction.\r\n *\r\n * Line segments are used throughout Phaser for collision detection, geometry calculations,\r\n * path and boundary definitions, and placement utilities. You can retrieve a point at any\r\n * percentage along the line via `getPoint`, get an array of evenly-spaced points via\r\n * `getPoints`, or query the bounding extents through the `left`, `right`, `top`, and `bottom`\r\n * accessors.\r\n *\r\n * @class Line\r\n * @memberof Phaser.Geom\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x1=0] - The x coordinate of the line's starting point.\r\n * @param {number} [y1=0] - The y coordinate of the line's starting point.\r\n * @param {number} [x2=0] - The x coordinate of the line's ending point.\r\n * @param {number} [y2=0] - The y coordinate of the line's ending point.\r\n */", "meta": { "filename": "Line.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "classdesc": "Defines a Line segment: a finite portion of a line described by a start point (`x1`, `y1`)\rand an end point (`x2`, `y2`). Unlike an infinite mathematical line, a Line segment has a\rfixed length and direction.\r\rLine segments are used throughout Phaser for collision detection, geometry calculations,\rpath and boundary definitions, and placement utilities. You can retrieve a point at any\rpercentage along the line via `getPoint`, get an array of evenly-spaced points via\r`getPoints`, or query the bounding extents through the `left`, `right`, `top`, and `bottom`\raccessors.", "kind": "class", "name": "Line", "memberof": "Phaser.Geom", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the line's starting point.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the line's starting point.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the line's ending point.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the line's ending point.", "name": "y2" } ], "scope": "static", "longname": "Phaser.Geom.Line", "___id": "T000002R020070", "___s": true }, { "comment": "/**\r\n * The geometry constant type of this object: `GEOM_CONST.LINE`.\r\n * Used for fast type comparisons.\r\n *\r\n * @name Phaser.Geom.Line#type\r\n * @type {number}\r\n * @readonly\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Line.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The geometry constant type of this object: `GEOM_CONST.LINE`.\rUsed for fast type comparisons.", "name": "type", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.19.0", "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#type", "scope": "instance", "kind": "member", "___id": "T000002R020077", "___s": true }, { "comment": "/**\r\n * The x coordinate of the line's starting point.\r\n *\r\n * @name Phaser.Geom.Line#x1\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Line.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The x coordinate of the line's starting point.", "name": "x1", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#x1", "scope": "instance", "kind": "member", "___id": "T000002R020079", "___s": true }, { "comment": "/**\r\n * The y coordinate of the line's starting point.\r\n *\r\n * @name Phaser.Geom.Line#y1\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Line.js", "lineno": 67, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The y coordinate of the line's starting point.", "name": "y1", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#y1", "scope": "instance", "kind": "member", "___id": "T000002R020081", "___s": true }, { "comment": "/**\r\n * The x coordinate of the line's ending point.\r\n *\r\n * @name Phaser.Geom.Line#x2\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Line.js", "lineno": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The x coordinate of the line's ending point.", "name": "x2", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#x2", "scope": "instance", "kind": "member", "___id": "T000002R020083", "___s": true }, { "comment": "/**\r\n * The y coordinate of the line's ending point.\r\n *\r\n * @name Phaser.Geom.Line#y2\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Line.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The y coordinate of the line's ending point.", "name": "y2", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#y2", "scope": "instance", "kind": "member", "___id": "T000002R020085", "___s": true }, { "comment": "/**\r\n * Get a point on a line that's a given percentage along its length.\r\n *\r\n * @method Phaser.Geom.Line#getPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [output,$return]\r\n *\r\n * @param {number} position - A value between 0 and 1, where 0 is the start, 0.5 is the middle and 1 is the end of the line.\r\n * @param {Phaser.Math.Vector2} [output] - An optional Vector2 object to store the coordinates of the point on the line.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 object containing the coordinates of the point on the line.\r\n */", "meta": { "filename": "Line.js", "lineno": 95, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Get a point on a line that's a given percentage along its length.", "kind": "function", "name": "getPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [output,$return]", "value": "{Phaser.Math.Vector2} O - [output,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "An optional Vector2 object to store the coordinates of the point on the line.", "name": "output" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 object containing the coordinates of the point on the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#getPoint", "scope": "instance", "___id": "T000002R020087", "___s": true }, { "comment": "/**\r\n * Get a number of points along a line's length.\r\n *\r\n * Provide a `quantity` to get an exact number of points along the line.\r\n *\r\n * Provide a `stepRate` to ensure a specific distance between each point on the line. Set `quantity` to `0` when\r\n * providing a `stepRate`.\r\n *\r\n * @method Phaser.Geom.Line#getPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2[]} O - [output,$return]\r\n *\r\n * @param {number} quantity - The number of points to place on the line. Set to `0` to use `stepRate` instead.\r\n * @param {number} [stepRate] - The distance between each point on the line. When set, `quantity` is implied and should be set to `0`.\r\n * @param {Phaser.Math.Vector2[]} [output] - An optional array of Vector2 objects to store the coordinates of the points on the line.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2 objects containing the coordinates of the points on the line.\r\n */", "meta": { "filename": "Line.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Get a number of points along a line's length.\r\rProvide a `quantity` to get an exact number of points along the line.\r\rProvide a `stepRate` to ensure a specific distance between each point on the line. Set `quantity` to `0` when\rproviding a `stepRate`.", "kind": "function", "name": "getPoints", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [output,$return]", "value": "{Phaser.Math.Vector2[]} O - [output,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of points to place on the line. Set to `0` to use `stepRate` instead.", "name": "quantity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array of Vector2 objects to store the coordinates of the points on the line.", "name": "output" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2 objects containing the coordinates of the points on the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#getPoints", "scope": "instance", "___id": "T000002R020089", "___s": true }, { "comment": "/**\r\n * Returns a randomly chosen point on this Line, selected with uniform distribution along its length.\r\n * If a Vector2 is provided it will be populated with the result and returned; otherwise a new Vector2 is created.\r\n *\r\n * @method Phaser.Geom.Line#getRandomPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [point,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [point] - An instance of a Vector2 to be modified.\r\n *\r\n * @return {Phaser.Math.Vector2} A random point on the Line.\r\n */", "meta": { "filename": "Line.js", "lineno": 137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Returns a randomly chosen point on this Line, selected with uniform distribution along its length.\rIf a Vector2 is provided it will be populated with the result and returned; otherwise a new Vector2 is created.", "kind": "function", "name": "getRandomPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [point,$return]", "value": "{Phaser.Math.Vector2} O - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "An instance of a Vector2 to be modified.", "name": "point" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A random point on the Line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#getRandomPoint", "scope": "instance", "___id": "T000002R020091", "___s": true }, { "comment": "/**\r\n * Set new coordinates for the line endpoints.\r\n *\r\n * @method Phaser.Geom.Line#setTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x1=0] - The x coordinate of the line's starting point.\r\n * @param {number} [y1=0] - The y coordinate of the line's starting point.\r\n * @param {number} [x2=0] - The x coordinate of the line's ending point.\r\n * @param {number} [y2=0] - The y coordinate of the line's ending point.\r\n *\r\n * @return {this} This Line object.\r\n */", "meta": { "filename": "Line.js", "lineno": 155, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Set new coordinates for the line endpoints.", "kind": "function", "name": "setTo", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the line's starting point.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the line's starting point.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The x coordinate of the line's ending point.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The y coordinate of the line's ending point.", "name": "y2" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Line object." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#setTo", "scope": "instance", "___id": "T000002R020093", "___s": true }, { "comment": "/**\r\n * Sets this Line to match the x/y coordinates of the two given Vector2Like objects.\r\n *\r\n * @method Phaser.Geom.Line#setFromObjects\r\n * @since 3.70.0\r\n *\r\n * @param {Phaser.Types.Math.Vector2Like} start - Any object with public `x` and `y` properties, whose values will be assigned to the x1/y1 components of this Line.\r\n * @param {Phaser.Types.Math.Vector2Like} end - Any object with public `x` and `y` properties, whose values will be assigned to the x2/y2 components of this Line.\r\n *\r\n * @return {this} This Line object.\r\n */", "meta": { "filename": "Line.js", "lineno": 184, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Sets this Line to match the x/y coordinates of the two given Vector2Like objects.", "kind": "function", "name": "setFromObjects", "since": "3.70.0", "params": [ { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "Any object with public `x` and `y` properties, whose values will be assigned to the x1/y1 components of this Line.", "name": "start" }, { "type": { "names": [ "Phaser.Types.Math.Vector2Like" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Math.Vector2Like" } }, "description": "Any object with public `x` and `y` properties, whose values will be assigned to the x2/y2 components of this Line.", "name": "end" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Line object." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#setFromObjects", "scope": "instance", "___id": "T000002R020103", "___s": true }, { "comment": "/**\r\n * Returns a Vector2 object that corresponds to the start of this Line.\r\n *\r\n * @method Phaser.Geom.Line#getPointA\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [vec2,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [vec2] - A Vector2 object to set the results in. If `undefined` a new Vector2 will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 object that corresponds to the start of this Line.\r\n */", "meta": { "filename": "Line.js", "lineno": 206, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Returns a Vector2 object that corresponds to the start of this Line.", "kind": "function", "name": "getPointA", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [vec2,$return]", "value": "{Phaser.Math.Vector2} O - [vec2,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R020109", "___s": true }, { "comment": "/**\r\n * Returns a Vector2 object that corresponds to the end of this Line.\r\n *\r\n * @method Phaser.Geom.Line#getPointB\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [vec2,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [vec2] - A Vector2 object to set the results in. If `undefined` a new Vector2 will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 object that corresponds to the end of this Line.\r\n */", "meta": { "filename": "Line.js", "lineno": 227, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Returns a Vector2 object that corresponds to the end of this Line.", "kind": "function", "name": "getPointB", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [vec2,$return]", "value": "{Phaser.Math.Vector2} O - [vec2,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R020112", "___s": true }, { "comment": "/**\r\n * The left-most x coordinate of this Line, i.e. the lesser of `x1` and `x2`.\r\n * When set, the endpoint that currently holds the smaller x value is moved to the new position.\r\n *\r\n * @name Phaser.Geom.Line#left\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Line.js", "lineno": 248, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The left-most x coordinate of this Line, i.e. the lesser of `x1` and `x2`.\rWhen set, the endpoint that currently holds the smaller x value is moved to the new position.", "name": "left", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#left", "scope": "instance", "kind": "member", "___id": "T000002R020115", "___s": true }, { "comment": "/**\r\n * The right-most x coordinate of this Line, i.e. the greater of `x1` and `x2`.\r\n * When set, the endpoint that currently holds the larger x value is moved to the new position.\r\n *\r\n * @name Phaser.Geom.Line#right\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Line.js", "lineno": 277, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The right-most x coordinate of this Line, i.e. the greater of `x1` and `x2`.\rWhen set, the endpoint that currently holds the larger x value is moved to the new position.", "name": "right", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#right", "scope": "instance", "kind": "member", "___id": "T000002R020121", "___s": true }, { "comment": "/**\r\n * The top-most y coordinate of this Line, i.e. the lesser of `y1` and `y2`.\r\n * When set, the endpoint that currently holds the smaller y value is moved to the new position.\r\n *\r\n * @name Phaser.Geom.Line#top\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Line.js", "lineno": 306, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The top-most y coordinate of this Line, i.e. the lesser of `y1` and `y2`.\rWhen set, the endpoint that currently holds the smaller y value is moved to the new position.", "name": "top", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#top", "scope": "instance", "kind": "member", "___id": "T000002R020127", "___s": true }, { "comment": "/**\r\n * The bottom-most y coordinate of this Line, i.e. the greater of `y1` and `y2`.\r\n * When set, the endpoint that currently holds the larger y value is moved to the new position.\r\n *\r\n * @name Phaser.Geom.Line#bottom\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Line.js", "lineno": 335, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The bottom-most y coordinate of this Line, i.e. the greater of `y1` and `y2`.\rWhen set, the endpoint that currently holds the larger y value is moved to the new position.", "name": "bottom", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line#bottom", "scope": "instance", "kind": "member", "___id": "T000002R020133", "___s": true }, { "comment": "/**\r\n * Get the angle of the normal of the given line in radians.\r\n *\r\n * @function Phaser.Geom.Line.NormalAngle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to calculate the angle of the normal of.\r\n *\r\n * @return {number} The angle of the normal of the line in radians.\r\n */", "meta": { "filename": "NormalAngle.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to calculate the angle of the normal of.", "name": "line" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of the normal of the line in radians." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.NormalAngle", "scope": "static", "___id": "T000002R020143", "___s": true }, { "comment": "/**\r\n * Returns the x component of the normal vector of the given line.\r\n *\r\n * @function Phaser.Geom.Line.NormalX\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The Line object to get the normal value from.\r\n *\r\n * @return {number} The x component of the normal vector of the line.\r\n */", "meta": { "filename": "NormalX.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Returns the x component of the normal vector of the given line.", "kind": "function", "name": "NormalX", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The Line object to get the normal value from.", "name": "line" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x component of the normal vector of the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.NormalX", "scope": "static", "___id": "T000002R020149", "___s": true }, { "comment": "/**\r\n * The Y value of the normal of the given line.\r\n * The normal of a line is a vector that points perpendicular from it.\r\n *\r\n * @function Phaser.Geom.Line.NormalY\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to calculate the normal of.\r\n *\r\n * @return {number} The Y value of the normal of the Line.\r\n */", "meta": { "filename": "NormalY.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "The Y value of the normal of the given line.\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to calculate the normal of.", "name": "line" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y value of the normal of the Line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.NormalY", "scope": "static", "___id": "T000002R020154", "___s": true }, { "comment": "/**\r\n * Translates both endpoints of the given Line by the specified horizontal and vertical amounts, effectively moving the line to a new position in 2D space while preserving its length and angle.\r\n *\r\n * @function Phaser.Geom.Line.Offset\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Line} O - [line,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to offset.\r\n * @param {number} x - The horizontal offset to add to the line.\r\n * @param {number} y - The vertical offset to add to the line.\r\n *\r\n * @return {Phaser.Geom.Line} The modified Line object, with both endpoints moved by the given offset.\r\n */", "meta": { "filename": "Offset.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Translates both endpoints of the given Line by the specified horizontal and vertical amounts, effectively moving the line to a new position in 2D space while preserving its length and angle.", "kind": "function", "name": "Offset", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Line} O - [line,$return]", "value": "{Phaser.Geom.Line} O - [line,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to offset.", "name": "line" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal offset to add to the line.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical offset to add to the line.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The modified Line object, with both endpoints moved by the given offset." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Offset", "scope": "static", "___id": "T000002R020157", "___s": true }, { "comment": "/**\r\n * Calculate the perpendicular slope of the given line.\r\n *\r\n * @function Phaser.Geom.Line.PerpSlope\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to calculate the perpendicular slope of.\r\n *\r\n * @return {number} The perpendicular slope of the line.\r\n */", "meta": { "filename": "PerpSlope.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Calculate the perpendicular slope of the given line.", "kind": "function", "name": "PerpSlope", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to calculate the perpendicular slope of.", "name": "line" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The perpendicular slope of the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.PerpSlope", "scope": "static", "___id": "T000002R020164", "___s": true }, { "comment": "/**\r\n * Returns a random point on a given Line.\r\n *\r\n * @function Phaser.Geom.Line.Random\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The Line to calculate the random point on.\r\n * @param {Phaser.Math.Vector2} [out] - An instance of a Vector2 to be modified.\r\n *\r\n * @return {Phaser.Math.Vector2} A random point on the Line stored in a Vector2.\r\n */", "meta": { "filename": "Random.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Returns a random point on a given Line.", "kind": "function", "name": "Random", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The Line to calculate the random point on.", "name": "line" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "An instance of a Vector2 to be modified.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A random point on the Line stored in a Vector2." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Random", "scope": "static", "___id": "T000002R020168", "___s": true }, { "comment": "/**\r\n * Calculates the reflected angle of Line A off the surface represented by Line B. This is the outgoing angle based on the angle of incidence (Line A) and the surface normal of Line B. The result is in radians.\r\n *\r\n * @function Phaser.Geom.Line.ReflectAngle\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} lineA - The incident line whose angle of incidence is used.\r\n * @param {Phaser.Geom.Line} lineB - The surface line, used to calculate the normal angle of reflection.\r\n *\r\n * @return {number} The reflected angle of Line A off the surface of Line B, in radians.\r\n */", "meta": { "filename": "ReflectAngle.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Calculates the reflected angle of Line A off the surface represented by Line B. This is the outgoing angle based on the angle of incidence (Line A) and the surface normal of Line B. The result is in radians.", "kind": "function", "name": "ReflectAngle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The incident line whose angle of incidence is used.", "name": "lineA" }, { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The surface line, used to calculate the normal angle of reflection.", "name": "lineB" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The reflected angle of Line A off the surface of Line B, in radians." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.ReflectAngle", "scope": "static", "___id": "T000002R020177", "___s": true }, { "comment": "/**\r\n * Rotate a line around its midpoint by the given angle in radians.\r\n *\r\n * @function Phaser.Geom.Line.Rotate\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Line} O - [line,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to rotate.\r\n * @param {number} angle - The angle of rotation in radians.\r\n *\r\n * @return {Phaser.Geom.Line} The rotated line.\r\n */", "meta": { "filename": "Rotate.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Rotate a line around its midpoint by the given angle in radians.", "kind": "function", "name": "Rotate", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Line} O - [line,$return]", "value": "{Phaser.Geom.Line} O - [line,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to rotate.", "name": "line" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of rotation in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The rotated line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Rotate", "scope": "static", "___id": "T000002R020181", "___s": true }, { "comment": "/**\r\n * Rotate a line around a point by the given angle in radians.\r\n *\r\n * @function Phaser.Geom.Line.RotateAroundPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Line} O - [line,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to rotate.\r\n * @param {Phaser.Math.Vector2} point - The point to rotate the line around.\r\n * @param {number} angle - The angle of rotation in radians.\r\n *\r\n * @return {Phaser.Geom.Line} The rotated line.\r\n */", "meta": { "filename": "RotateAroundPoint.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Rotate a line around a point by the given angle in radians.", "kind": "function", "name": "RotateAroundPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Line} O - [line,$return]", "value": "{Phaser.Geom.Line} O - [line,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to rotate.", "name": "line" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The point to rotate the line around.", "name": "point" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of rotation in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The rotated line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.RotateAroundPoint", "scope": "static", "___id": "T000002R020187", "___s": true }, { "comment": "/**\r\n * Rotate a line around the given coordinates by the given angle in radians.\r\n *\r\n * @function Phaser.Geom.Line.RotateAroundXY\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Line} O - [line,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to rotate.\r\n * @param {number} x - The horizontal coordinate to rotate the line around.\r\n * @param {number} y - The vertical coordinate to rotate the line around.\r\n * @param {number} angle - The angle of rotation in radians.\r\n *\r\n * @return {Phaser.Geom.Line} The rotated line.\r\n */", "meta": { "filename": "RotateAroundXY.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Rotate a line around the given coordinates by the given angle in radians.", "kind": "function", "name": "RotateAroundXY", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Line} O - [line,$return]", "value": "{Phaser.Geom.Line} O - [line,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to rotate.", "name": "line" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate to rotate the line around.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate to rotate the line around.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of rotation in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The rotated line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.RotateAroundXY", "scope": "static", "___id": "T000002R020190", "___s": true }, { "comment": "/**\r\n * Set a line to a given position, angle and length.\r\n *\r\n * @function Phaser.Geom.Line.SetToAngle\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Line} O - [line,$return]\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to set.\r\n * @param {number} x - The horizontal start position of the line.\r\n * @param {number} y - The vertical start position of the line.\r\n * @param {number} angle - The angle of the line in radians.\r\n * @param {number} length - The length of the line.\r\n *\r\n * @return {Phaser.Geom.Line} The updated line.\r\n */", "meta": { "filename": "SetToAngle.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Set a line to a given position, angle and length.", "kind": "function", "name": "SetToAngle", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Line} O - [line,$return]", "value": "{Phaser.Geom.Line} O - [line,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to set.", "name": "line" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal start position of the line.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical start position of the line.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of the line in radians.", "name": "angle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of the line.", "name": "length" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The updated line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.SetToAngle", "scope": "static", "___id": "T000002R020203", "___s": true }, { "comment": "/**\r\n * Calculate the slope of the given line.\r\n *\r\n * @function Phaser.Geom.Line.Slope\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to calculate the slope of.\r\n *\r\n * @return {number} The slope of the line.\r\n */", "meta": { "filename": "Slope.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Calculate the slope of the given line.", "kind": "function", "name": "Slope", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to calculate the slope of.", "name": "line" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The slope of the line." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Slope", "scope": "static", "___id": "T000002R020210", "___s": true }, { "comment": "/**\r\n * Calculates the width of the given line, defined as the absolute difference between\r\n * the x-coordinates of its two endpoints (`x1` and `x2`). This represents the\r\n * horizontal extent of the line, not its geometric length. To get the true length\r\n * of the line, use `Phaser.Geom.Line.Length` instead.\r\n *\r\n * @function Phaser.Geom.Line.Width\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Line} line - The line to calculate the width of.\r\n *\r\n * @return {number} The width of the line, i.e. the absolute difference between its x1 and x2 coordinates.\r\n */", "meta": { "filename": "Width.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\line", "code": {} }, "description": "Calculates the width of the given line, defined as the absolute difference between\rthe x-coordinates of its two endpoints (`x1` and `x2`). This represents the\rhorizontal extent of the line, not its geometric length. To get the true length\rof the line, use `Phaser.Geom.Line.Length` instead.", "kind": "function", "name": "Width", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Line" } }, "description": "The line to calculate the width of.", "name": "line" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the line, i.e. the absolute difference between its x1 and x2 coordinates." } ], "memberof": "Phaser.Geom.Line", "longname": "Phaser.Geom.Line.Width", "scope": "static", "___id": "T000002R020213", "___s": true }, { "comment": "/**\r\n * Create a new polygon which is a copy of the specified polygon\r\n *\r\n * @function Phaser.Geom.Polygon.Clone\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Polygon} polygon - The polygon to create a clone of\r\n *\r\n * @return {Phaser.Geom.Polygon} A new separate Polygon cloned from the specified polygon, based on the same points.\r\n */", "meta": { "filename": "Clone.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Polygon" } }, "description": "The polygon to create a clone of", "name": "polygon" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Polygon" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R020217", "___s": true }, { "comment": "/**\r\n * Checks if a point is within the bounds of a Polygon.\r\n *\r\n * @function Phaser.Geom.Polygon.Contains\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Polygon} polygon - The Polygon to check against.\r\n * @param {number} x - The X coordinate of the point to check.\r\n * @param {number} y - The Y coordinate of the point to check.\r\n *\r\n * @return {boolean} `true` if the point is within the bounds of the Polygon, otherwise `false`.\r\n */", "meta": { "filename": "Contains.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Polygon" } }, "description": "The Polygon to check against.", "name": "polygon" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the point to check.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the point to check.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R020220", "___s": true }, { "comment": "/**\r\n * Checks the given Point against the Polygon to see if the Point lays within its vertices.\r\n *\r\n * @function Phaser.Geom.Polygon.ContainsPoint\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Polygon} polygon - The Polygon to check.\r\n * @param {Phaser.Math.Vector2} vec - The Vector2 point to check if it's within the Polygon.\r\n *\r\n * @return {boolean} `true` if the point is within the Polygon, otherwise `false`.\r\n */", "meta": { "filename": "ContainsPoint.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "Checks the given Point against the Polygon to see if the Point lays within its vertices.", "kind": "function", "name": "ContainsPoint", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Polygon" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Polygon" } }, "description": "The Polygon to check.", "name": "polygon" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The Vector2 point to check if it's within the Polygon.", "name": "vec" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the point is within the Polygon, otherwise `false`." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon.ContainsPoint", "scope": "static", "___id": "T000002R020233", "___s": true }, { "comment": "/**\r\n * This module implements a modified ear slicing algorithm, optimized by z-order curve hashing and extended to\r\n * handle holes, twisted polygons, degeneracies and self-intersections in a way that doesn't guarantee correctness\r\n * of triangulation, but attempts to always produce acceptable results for practical data.\r\n *\r\n * Example:\r\n *\r\n * ```javascript\r\n * const triangles = Phaser.Geom.Polygon.Earcut([10,0, 0,50, 60,60, 70,10]); // returns [1,0,3, 3,2,1]\r\n * ```\r\n *\r\n * Each group of three vertex indices in the resulting array forms a triangle.\r\n *\r\n * ```javascript\r\n * // triangulating a polygon with a hole\r\n * earcut([0,0, 100,0, 100,100, 0,100, 20,20, 80,20, 80,80, 20,80], [4]);\r\n * // [3,0,4, 5,4,0, 3,4,7, 5,0,1, 2,3,7, 6,5,1, 2,7,6, 6,1,2]\r\n *\r\n * // triangulating a polygon with 3d coords\r\n * earcut([10,0,1, 0,50,2, 60,60,3, 70,10,4], null, 3);\r\n * // [1,0,3, 3,2,1]\r\n * ```\r\n *\r\n * If you pass a single vertex as a hole, Earcut treats it as a Steiner point.\r\n *\r\n * If your input is a multi-dimensional array (e.g. GeoJSON Polygon), you can convert it to the format\r\n * expected by Earcut with `Phaser.Geom.Polygon.Earcut.flatten`:\r\n *\r\n * ```javascript\r\n * var data = earcut.flatten(geojson.geometry.coordinates);\r\n * var triangles = earcut(data.vertices, data.holes, data.dimensions);\r\n * ```\r\n *\r\n * After getting a triangulation, you can verify its correctness with `Phaser.Geom.Polygon.Earcut.deviation`:\r\n *\r\n * ```javascript\r\n * var deviation = earcut.deviation(vertices, holes, dimensions, triangles);\r\n * ```\r\n * Returns the relative difference between the total area of triangles and the area of the input polygon.\r\n * 0 means the triangulation is fully correct.\r\n *\r\n * For more information see https://github.com/mapbox/earcut\r\n *\r\n * @function Phaser.Geom.Polygon.Earcut\r\n * @since 3.50.0\r\n *\r\n * @param {number[]} data - A flat array of vertex coordinates, like [x0,y0, x1,y1, x2,y2, ...]\r\n * @param {number[]} [holeIndices] - 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).\r\n * @param {number} [dimensions=2] - The number of coordinates per vertex in the input array (2 by default).\r\n *\r\n * @return {number[]} An array of triangulated data.\r\n */", "meta": { "filename": "Earcut.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "This module implements a modified ear slicing algorithm, optimized by z-order curve hashing and extended to\rhandle holes, twisted polygons, degeneracies and self-intersections in a way that doesn't guarantee correctness\rof triangulation, but attempts to always produce acceptable results for practical data.\r\rExample:\r\r```javascript\rconst triangles = Phaser.Geom.Polygon.Earcut([10,0, 0,50, 60,60, 70,10]); // returns [1,0,3, 3,2,1]\r```\r\rEach group of three vertex indices in the resulting array forms a triangle.\r\r```javascript\r// triangulating a polygon with a hole\rearcut([0,0, 100,0, 100,100, 0,100, 20,20, 80,20, 80,80, 20,80], [4]);\r// [3,0,4, 5,4,0, 3,4,7, 5,0,1, 2,3,7, 6,5,1, 2,7,6, 6,1,2]\r\r// triangulating a polygon with 3d coords\rearcut([10,0,1, 0,50,2, 60,60,3, 70,10,4], null, 3);\r// [1,0,3, 3,2,1]\r```\r\rIf you pass a single vertex as a hole, Earcut treats it as a Steiner point.\r\rIf your input is a multi-dimensional array (e.g. GeoJSON Polygon), you can convert it to the format\rexpected by Earcut with `Phaser.Geom.Polygon.Earcut.flatten`:\r\r```javascript\rvar data = earcut.flatten(geojson.geometry.coordinates);\rvar triangles = earcut(data.vertices, data.holes, data.dimensions);\r```\r\rAfter getting a triangulation, you can verify its correctness with `Phaser.Geom.Polygon.Earcut.deviation`:\r\r```javascript\rvar deviation = earcut.deviation(vertices, holes, dimensions, triangles);\r```\rReturns the relative difference between the total area of triangles and the area of the input polygon.\r0 means the triangulation is fully correct.\r\rFor more information see https://github.com/mapbox/earcut", "kind": "function", "name": "Earcut", "since": "3.50.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "A flat array of vertex coordinates, like [x0,y0, x1,y1, x2,y2, ...]", "name": "data" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "optional": true, "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": "holeIndices" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 2, "description": "The number of coordinates per vertex in the input array (2 by default).", "name": "dimensions" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array of triangulated data." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon.Earcut", "scope": "static", "___id": "T000002R020236", "___s": true }, { "comment": "/**\r\n * Calculates the bounding AABB rectangle of a polygon.\r\n *\r\n * @function Phaser.Geom.Polygon.GetAABB\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Polygon} polygon - The polygon that should be calculated.\r\n * @param {(Phaser.Geom.Rectangle|object)} [out] - The rectangle or object that has x, y, width, and height properties to store the result. Optional.\r\n *\r\n * @return {(Phaser.Geom.Rectangle|object)} The resulting rectangle or object that is passed in with position and dimensions of the polygon's AABB.\r\n */", "meta": { "filename": "GetAABB.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "Calculates the bounding AABB rectangle of a polygon.", "kind": "function", "name": "GetAABB", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [out,$return]", "value": "{Phaser.Geom.Rectangle} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Polygon" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Polygon" } }, "description": "The polygon that should be calculated.", "name": "polygon" }, { "type": { "names": [ "Phaser.Geom.Rectangle", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" }, { "type": "NameExpression", "name": "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", "___id": "T000002R020535", "___s": true }, { "comment": "/**\r\n * Stores all of the points of a Polygon into a flat array of numbers following the sequence [ x,y, x,y, x,y ],\r\n * i.e. each point of the Polygon, in the order it's defined, corresponds to two elements of the resultant\r\n * array for the point's X and Y coordinate.\r\n *\r\n * @function Phaser.Geom.Polygon.GetNumberArray\r\n * @since 3.0.0\r\n *\r\n * @generic {number[]} O - [output,$return]\r\n *\r\n * @param {Phaser.Geom.Polygon} polygon - The Polygon whose points to export.\r\n * @param {(array|number[])} [output] - An array to which the points' coordinates should be appended.\r\n *\r\n * @return {(array|number[])} The modified `output` array, or a new array if none was given.\r\n */", "meta": { "filename": "GetNumberArray.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "Stores all of the points of a Polygon into a flat array of numbers following the sequence [ x,y, x,y, x,y ],\ri.e. each point of the Polygon, in the order it's defined, corresponds to two elements of the resultant\rarray for the point's X and Y coordinate.", "kind": "function", "name": "GetNumberArray", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{number[]} O - [output,$return]", "value": "{number[]} O - [output,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Polygon" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Polygon" } }, "description": "The Polygon whose points to export.", "name": "polygon" }, { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An array to which the points' coordinates should be appended.", "name": "output" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } ] } }, "description": "The modified `output` array, or a new array if none was given." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon.GetNumberArray", "scope": "static", "___id": "T000002R020554", "___s": true }, { "comment": "/**\r\n * Returns an array of Vector2 objects containing the coordinates of the points around the perimeter of the Polygon,\r\n * based on the given quantity or stepRate values.\r\n *\r\n * @function Phaser.Geom.Polygon.GetPoints\r\n * @since 3.12.0\r\n *\r\n * @param {Phaser.Geom.Polygon} polygon - The Polygon to get the points from.\r\n * @param {number} quantity - The amount of points to return. If a falsy value the quantity will be derived from the `stepRate` instead.\r\n * @param {number} [stepRate] - Sets the quantity by getting the perimeter of the Polygon and dividing it by the stepRate.\r\n * @param {array} [output] - An array to insert the points in to. If not provided a new array will be created.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2 objects pertaining to the points around the perimeter of the Polygon.\r\n */", "meta": { "filename": "GetPoints.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "Returns an array of Vector2 objects containing the coordinates of the points around the perimeter of the Polygon,\rbased on the given quantity or stepRate values.", "kind": "function", "name": "GetPoints", "since": "3.12.0", "params": [ { "type": { "names": [ "Phaser.Geom.Polygon" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Polygon" } }, "description": "The Polygon to get the points from.", "name": "polygon" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of points to return. If a falsy value the quantity will be derived from the `stepRate` instead.", "name": "quantity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2 objects pertaining to the points around the perimeter of the Polygon." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon.GetPoints", "scope": "static", "___id": "T000002R020562", "___s": true }, { "comment": "/**\r\n * Returns the perimeter of the given Polygon by summing the lengths of all its edges.\r\n * The polygon is treated as closed, so the edge between the last point and the first\r\n * point is included in the total.\r\n *\r\n * @function Phaser.Geom.Polygon.Perimeter\r\n * @since 3.12.0\r\n *\r\n * @param {Phaser.Geom.Polygon} polygon - The Polygon to get the perimeter of.\r\n *\r\n * @return {number} The perimeter of the Polygon.\r\n */", "meta": { "filename": "Perimeter.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "Returns the perimeter of the given Polygon by summing the lengths of all its edges.\rThe polygon is treated as closed, so the edge between the last point and the first\rpoint is included in the total.", "kind": "function", "name": "Perimeter", "since": "3.12.0", "params": [ { "type": { "names": [ "Phaser.Geom.Polygon" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Polygon" } }, "description": "The Polygon to get the perimeter of.", "name": "polygon" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The perimeter of the Polygon." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon.Perimeter", "scope": "static", "___id": "T000002R020595", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Polygon object\r\n *\r\n * The polygon is a closed shape consisting of a series of connected straight lines defined by a list of ordered points.\r\n * Several formats are supported to define the list of points, check the setTo method for details.\r\n * This is a geometry object allowing you to define and inspect the shape.\r\n * It is not a Game Object, in that you cannot add it to the display list, and it has no texture.\r\n * To render a Polygon you should look at the capabilities of the Graphics class.\r\n *\r\n * @class Polygon\r\n * @memberof Phaser.Geom\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number[]|Phaser.Types.Math.Vector2Like[])} [points] - List of points defining the perimeter of this Polygon. Several formats are supported:\r\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'`\r\n * - An array of Point objects: `[new Phaser.Point(x1, y1), ...]`\r\n * - An array of objects with public x y properties: `[obj1, obj2, ...]`\r\n * - An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\r\n * - An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\r\n */", "meta": { "filename": "Polygon.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "classdesc": "A Polygon object\r\rThe polygon is a closed shape consisting of a series of connected straight lines defined by a list of ordered points.\rSeveral formats are supported to define the list of points, check the setTo method for details.\rThis is a geometry object allowing you to define and inspect the shape.\rIt is not a Game Object, in that you cannot add it to the display list, and it has no texture.\rTo 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": [ "string", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "List of points defining the perimeter of this Polygon. Several formats are supported:\r- 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'`\r- An array of Point objects: `[new Phaser.Point(x1, y1), ...]`\r- An array of objects with public x y properties: `[obj1, obj2, ...]`\r- An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\r- An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`", "name": "points" } ], "scope": "static", "longname": "Phaser.Geom.Polygon", "___id": "T000002R020609", "___s": true }, { "comment": "/**\r\n * The geometry constant type of this object: `GEOM_CONST.POLYGON`.\r\n * Used for fast type comparisons.\r\n *\r\n * @name Phaser.Geom.Polygon#type\r\n * @type {number}\r\n * @readonly\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Polygon.js", "lineno": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "The geometry constant type of this object: `GEOM_CONST.POLYGON`.\rUsed for fast type comparisons.", "name": "type", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.19.0", "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon#type", "scope": "instance", "kind": "member", "___id": "T000002R020612", "___s": true }, { "comment": "/**\r\n * The area of this Polygon.\r\n *\r\n * @name Phaser.Geom.Polygon#area\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Polygon.js", "lineno": 51, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "The area of this Polygon.", "name": "area", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon#area", "scope": "instance", "kind": "member", "___id": "T000002R020614", "___s": true }, { "comment": "/**\r\n * An array of number pair objects that make up this polygon. I.e. [ {x,y}, {x,y}, {x,y} ]\r\n *\r\n * @name Phaser.Geom.Polygon#points\r\n * @type {Phaser.Math.Vector2[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Polygon.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon#points", "scope": "instance", "kind": "member", "___id": "T000002R020616", "___s": true }, { "comment": "/**\r\n * Check to see if the Polygon contains the given x / y coordinates.\r\n *\r\n * @method Phaser.Geom.Polygon#contains\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate to check within the polygon.\r\n * @param {number} y - The y coordinate to check within the polygon.\r\n *\r\n * @return {boolean} `true` if the coordinates are within the polygon, otherwise `false`.\r\n */", "meta": { "filename": "Polygon.js", "lineno": 76, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate to check within the polygon.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate to check within the polygon.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the coordinates are within the polygon, otherwise `false`." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon#contains", "scope": "instance", "___id": "T000002R020618", "___s": true }, { "comment": "/**\r\n * Sets this Polygon to the given points.\r\n *\r\n * The points can be set from a variety of formats:\r\n *\r\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'`\r\n * - An array of Point objects: `[new Phaser.Point(x1, y1), ...]`\r\n * - An array of objects with public x/y properties: `[obj1, obj2, ...]`\r\n * - An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\r\n * - An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\r\n *\r\n * `setTo` may also be called without any arguments to remove all points.\r\n *\r\n * @method Phaser.Geom.Polygon#setTo\r\n * @since 3.0.0\r\n *\r\n * @param {(string|number[]|Phaser.Types.Math.Vector2Like[])} [points] - Points defining the perimeter of this polygon. Please check function description above for the different supported formats.\r\n *\r\n * @return {this} This Polygon object.\r\n */", "meta": { "filename": "Polygon.js", "lineno": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "Sets this Polygon to the given points.\r\rThe points can be set from a variety of formats:\r\r- A string containing paired values separated by a single space: `'40 0 40 20 100 20 100 80 40 80 40 100 0 50'`\r- An array of Point objects: `[new Phaser.Point(x1, y1), ...]`\r- An array of objects with public x/y properties: `[obj1, obj2, ...]`\r- An array of paired numbers that represent point coordinates: `[x1,y1, x2,y2, ...]`\r- An array of arrays with two elements representing x/y coordinates: `[[x1, y1], [x2, y2], ...]`\r\r`setTo` may also be called without any arguments to remove all points.", "kind": "function", "name": "setTo", "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Math.Vector2Like", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "Points defining the perimeter of this polygon. Please check function description above for the different supported formats.", "name": "points" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Polygon object." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon#setTo", "scope": "instance", "___id": "T000002R020620", "___s": true }, { "comment": "/**\r\n * Calculates the area of the Polygon using the Shoelace formula. The result is stored in the `area` property.\r\n *\r\n * @method Phaser.Geom.Polygon#calculateArea\r\n * @since 3.0.0\r\n *\r\n * @return {number} The area of the polygon.\r\n */", "meta": { "filename": "Polygon.js", "lineno": 160, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "Calculates the area of the Polygon using the Shoelace formula. The result is stored in the `area` property.", "kind": "function", "name": "calculateArea", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The area of the polygon." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon#calculateArea", "scope": "instance", "___id": "T000002R020636", "___s": true }, { "comment": "/**\r\n * Returns an array of Vector2 objects containing the coordinates of the points around the perimeter of the Polygon,\r\n * based on the given quantity or stepRate values.\r\n *\r\n * @method Phaser.Geom.Polygon#getPoints\r\n * @since 3.12.0\r\n *\r\n * @generic {Phaser.Math.Vector2[]} O - [output,$return]\r\n *\r\n * @param {number} quantity - The amount of points to return. If a falsy value the quantity will be derived from the `stepRate` instead.\r\n * @param {number} [stepRate] - Sets the quantity by getting the perimeter of the Polygon and dividing it by the stepRate.\r\n * @param {Phaser.Math.Vector2[]} [output] - An array to insert the points in to. If not provided a new array will be created.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2 objects pertaining to the points around the perimeter of the Polygon.\r\n */", "meta": { "filename": "Polygon.js", "lineno": 199, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "Returns an array of Vector2 objects containing the coordinates of the points around the perimeter of the Polygon,\rbased on the given quantity or stepRate values.", "kind": "function", "name": "getPoints", "since": "3.12.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [output,$return]", "value": "{Phaser.Math.Vector2[]} O - [output,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of points to return. If a falsy value the quantity will be derived from the `stepRate` instead.", "name": "quantity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2 objects pertaining to the points around the perimeter of the Polygon." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon#getPoints", "scope": "instance", "___id": "T000002R020650", "___s": true }, { "comment": "/**\r\n * Reverses the order of the points of a Polygon.\r\n *\r\n * @function Phaser.Geom.Polygon.Reverse\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Polygon} O - [polygon,$return]\r\n *\r\n * @param {Phaser.Geom.Polygon} polygon - The Polygon to modify.\r\n *\r\n * @return {Phaser.Geom.Polygon} The modified Polygon.\r\n */", "meta": { "filename": "Reverse.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "Reverses the order of the points of a Polygon.", "kind": "function", "name": "Reverse", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Polygon} O - [polygon,$return]", "value": "{Phaser.Geom.Polygon} O - [polygon,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Polygon" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Polygon" } }, "description": "The Polygon to modify.", "name": "polygon" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Polygon" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Polygon" } }, "description": "The modified Polygon." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon.Reverse", "scope": "static", "___id": "T000002R020653", "___s": true }, { "comment": "/**\r\n * Takes a Polygon object and simplifies the points by running them through a combination of\r\n * Douglas-Peucker and Radial Distance algorithms. Simplification dramatically reduces the number of\r\n * points in a polygon while retaining its shape, giving a huge performance boost when processing\r\n * it and also reducing visual noise.\r\n *\r\n * @function Phaser.Geom.Polygon.Simplify\r\n * @since 3.50.0\r\n *\r\n * @generic {Phaser.Geom.Polygon} O - [polygon,$return]\r\n *\r\n * @param {Phaser.Geom.Polygon} polygon - The polygon to be simplified. The polygon will be modified in-place and returned.\r\n * @param {number} [tolerance=1] - Affects the amount of simplification (in the same metric as the point coordinates).\r\n * @param {boolean} [highestQuality=false] - Excludes distance-based preprocessing step which leads to highest quality simplification but runs ~10-20 times slower.\r\n *\r\n * @return {Phaser.Geom.Polygon} The input polygon.\r\n */", "meta": { "filename": "Simplify.js", "lineno": 160, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "Takes a Polygon object and simplifies the points by running them through a combination of\rDouglas-Peucker and Radial Distance algorithms. Simplification dramatically reduces the number of\rpoints in a polygon while retaining its shape, giving a huge performance boost when processing\rit and also reducing visual noise.", "kind": "function", "name": "Simplify", "since": "3.50.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Polygon} O - [polygon,$return]", "value": "{Phaser.Geom.Polygon} O - [polygon,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Polygon" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Polygon" } }, "description": "The polygon to be simplified. The polygon will be modified in-place and returned.", "name": "polygon" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Affects the amount of simplification (in the same metric as the point coordinates).", "name": "tolerance" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Excludes distance-based preprocessing step which leads to highest quality simplification but runs ~10-20 times slower.", "name": "highestQuality" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Polygon" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Polygon" } }, "description": "The input polygon." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon.Simplify", "scope": "static", "___id": "T000002R020689", "___s": true }, { "comment": "/**\r\n * Takes a Polygon object and applies Chaikin's smoothing algorithm on its points.\r\n *\r\n * Chaikin's algorithm is a corner-cutting technique that replaces each edge between\r\n * two consecutive points with two new points positioned along that edge, resulting in\r\n * a smoother curve. Each iteration of the algorithm increases the total number of points\r\n * in the polygon. The original first and last points are preserved, while all intermediate\r\n * points are replaced by pairs of new points at 85% and 15% along each edge.\r\n *\r\n * The polygon is modified in-place and the same polygon object is returned.\r\n *\r\n * @function Phaser.Geom.Polygon.Smooth\r\n * @since 3.13.0\r\n *\r\n * @generic {Phaser.Geom.Polygon} O - [polygon,$return]\r\n *\r\n * @param {Phaser.Geom.Polygon} polygon - The polygon to be smoothed. The polygon will be modified in-place and returned.\r\n *\r\n * @return {Phaser.Geom.Polygon} The input polygon.\r\n */", "meta": { "filename": "Smooth.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "Takes a Polygon object and applies Chaikin's smoothing algorithm on its points.\r\rChaikin's algorithm is a corner-cutting technique that replaces each edge between\rtwo consecutive points with two new points positioned along that edge, resulting in\ra smoother curve. Each iteration of the algorithm increases the total number of points\rin the polygon. The original first and last points are preserved, while all intermediate\rpoints are replaced by pairs of new points at 85% and 15% along each edge.\r\rThe polygon is modified in-place and the same polygon object is returned.", "kind": "function", "name": "Smooth", "since": "3.13.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Polygon} O - [polygon,$return]", "value": "{Phaser.Geom.Polygon} O - [polygon,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Polygon" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Polygon" } }, "description": "The input polygon." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon.Smooth", "scope": "static", "___id": "T000002R020700", "___s": true }, { "comment": "/**\r\n * Translates the points of the given Polygon.\r\n *\r\n * @function Phaser.Geom.Polygon.Translate\r\n * @since 3.50.0\r\n *\r\n * @generic {Phaser.Geom.Polygon} O - [polygon,$return]\r\n *\r\n * @param {Phaser.Geom.Polygon} polygon - The Polygon to modify.\r\n * @param {number} x - The amount to horizontally translate the points by.\r\n * @param {number} y - The amount to vertically translate the points by.\r\n *\r\n * @return {Phaser.Geom.Polygon} The modified Polygon.\r\n */", "meta": { "filename": "Translate.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\polygon", "code": {} }, "description": "Translates the points of the given Polygon.", "kind": "function", "name": "Translate", "since": "3.50.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Polygon} O - [polygon,$return]", "value": "{Phaser.Geom.Polygon} O - [polygon,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Polygon" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Polygon" } }, "description": "The Polygon to modify.", "name": "polygon" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to horizontally translate the points by.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount to vertically translate the points by.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Polygon" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Polygon" } }, "description": "The modified Polygon." } ], "memberof": "Phaser.Geom.Polygon", "longname": "Phaser.Geom.Polygon.Translate", "scope": "static", "___id": "T000002R020715", "___s": true }, { "comment": "/**\r\n * Calculates the area of the given Rectangle object.\r\n *\r\n * @function Phaser.Geom.Rectangle.Area\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The rectangle to calculate the area of.\r\n *\r\n * @return {number} The area of the Rectangle object.\r\n */", "meta": { "filename": "Area.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Calculates the area of the given Rectangle object.", "kind": "function", "name": "Area", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The rectangle to calculate the area of.", "name": "rect" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The area of the Rectangle object." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.Area", "scope": "static", "___id": "T000002R020722", "___s": true }, { "comment": "/**\r\n * Rounds a Rectangle's position up to the smallest integer greater than or equal to each current coordinate.\r\n *\r\n * @function Phaser.Geom.Rectangle.Ceil\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [rect,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to adjust.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The adjusted Rectangle.\r\n */", "meta": { "filename": "Ceil.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [rect,$return]", "value": "{Phaser.Geom.Rectangle} O - [rect,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to adjust.", "name": "rect" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The adjusted Rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.Ceil", "scope": "static", "___id": "T000002R020725", "___s": true }, { "comment": "/**\r\n * Rounds a Rectangle's position and size up to the smallest integer greater than or equal to each respective value.\r\n *\r\n * @function Phaser.Geom.Rectangle.CeilAll\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [rect,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to modify.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The modified Rectangle.\r\n */", "meta": { "filename": "CeilAll.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [rect,$return]", "value": "{Phaser.Geom.Rectangle} O - [rect,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to modify.", "name": "rect" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The modified Rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.CeilAll", "scope": "static", "___id": "T000002R020730", "___s": true }, { "comment": "/**\r\n * Moves the top-left corner of a Rectangle so that its center is at the given coordinates.\r\n *\r\n * @function Phaser.Geom.Rectangle.CenterOn\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [rect,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to be centered.\r\n * @param {number} x - The X coordinate of the Rectangle's center.\r\n * @param {number} y - The Y coordinate of the Rectangle's center.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The centered rectangle.\r\n */", "meta": { "filename": "CenterOn.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [rect,$return]", "value": "{Phaser.Geom.Rectangle} O - [rect,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to be centered.", "name": "rect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the Rectangle's center.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the Rectangle's center.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The centered rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.CenterOn", "scope": "static", "___id": "T000002R020737", "___s": true }, { "comment": "/**\r\n * Creates a new Rectangle which is identical to the given one.\r\n *\r\n * @function Phaser.Geom.Rectangle.Clone\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} source - The Rectangle to clone.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The newly created Rectangle, which is separate from the given one.\r\n */", "meta": { "filename": "Clone.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to clone.", "name": "source" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R020743", "___s": true }, { "comment": "/**\r\n * Checks if a given point is inside a Rectangle's bounds.\r\n *\r\n * @function Phaser.Geom.Rectangle.Contains\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to check.\r\n * @param {number} x - The X coordinate of the point to check.\r\n * @param {number} y - The Y coordinate of the point to check.\r\n *\r\n * @return {boolean} `true` if the point is within the Rectangle's bounds, otherwise `false`.\r\n */", "meta": { "filename": "Contains.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to check.", "name": "rect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the point to check.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the point to check.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R020746", "___s": true }, { "comment": "/**\r\n * Determines whether the specified point is contained within the rectangular region defined by this Rectangle object.\r\n *\r\n * @function Phaser.Geom.Rectangle.ContainsPoint\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle object.\r\n * @param {Phaser.Math.Vector2} vec - The Vector2 object to check the coordinates of.\r\n *\r\n * @return {boolean} A value of true if the Rectangle object contains the specified point, otherwise false.\r\n */", "meta": { "filename": "ContainsPoint.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle object.", "name": "rect" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The Vector2 object to check the coordinates of.", "name": "vec" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R020750", "___s": true }, { "comment": "/**\r\n * Tests if one rectangle fully contains another. A rectangle is considered fully contained\r\n * if all four of its edges (left, right, top, and bottom) lie strictly within the bounds\r\n * of the outer rectangle. Rectangles that merely touch or overlap are not considered contained.\r\n *\r\n * @function Phaser.Geom.Rectangle.ContainsRect\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rectA - The outer rectangle to test as the container.\r\n * @param {Phaser.Geom.Rectangle} rectB - The inner rectangle to test for full containment within rectA.\r\n *\r\n * @return {boolean} True only if rectA fully contains rectB.\r\n */", "meta": { "filename": "ContainsRect.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Tests if one rectangle fully contains another. A rectangle is considered fully contained\rif all four of its edges (left, right, top, and bottom) lie strictly within the bounds\rof the outer rectangle. Rectangles that merely touch or overlap are not considered contained.", "kind": "function", "name": "ContainsRect", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The outer rectangle to test as the container.", "name": "rectA" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The inner rectangle to test for full containment within rectA.", "name": "rectB" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "True only if rectA fully contains rectB." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.ContainsRect", "scope": "static", "___id": "T000002R020753", "___s": true }, { "comment": "/**\r\n * Copy the values of one Rectangle to a destination Rectangle.\r\n *\r\n * @function Phaser.Geom.Rectangle.CopyFrom\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [dest,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} source - The source Rectangle to copy the values from.\r\n * @param {Phaser.Geom.Rectangle} dest - The destination Rectangle to copy the values to.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The destination Rectangle.\r\n */", "meta": { "filename": "CopyFrom.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Copy the values of one Rectangle to a destination Rectangle.", "kind": "function", "name": "CopyFrom", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [dest,$return]", "value": "{Phaser.Geom.Rectangle} O - [dest,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The source Rectangle to copy the values from.", "name": "source" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The destination Rectangle to copy the values to.", "name": "dest" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The destination Rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.CopyFrom", "scope": "static", "___id": "T000002R020756", "___s": true }, { "comment": "/**\r\n * Creates an array of plain `{x, y}` point objects for each of the four corners of a Rectangle, in the order: top-left, top-right, bottom-right, bottom-left.\r\n * If an output array is provided, each point object will be pushed to the end of it, otherwise a new array will be created and returned.\r\n *\r\n * @function Phaser.Geom.Rectangle.Decompose\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle object to be decomposed.\r\n * @param {array} [out] - If provided, each point will be added to this array.\r\n *\r\n * @return {array} Will return the array you specified or a new array containing the points of the Rectangle.\r\n */", "meta": { "filename": "Decompose.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Creates an array of plain `{x, y}` point objects for each of the four corners of a Rectangle, in the order: top-left, top-right, bottom-right, bottom-left.\rIf an output array is provided, each point object will be pushed to the end of it, otherwise a new array will be created and returned.", "kind": "function", "name": "Decompose", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle object to be decomposed.", "name": "rect" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "If provided, each point will be added to this array.", "name": "out" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R020759", "___s": true }, { "comment": "/**\r\n * Compares the `x`, `y`, `width` and `height` properties of two rectangles.\r\n * Returns `true` only if all four values match exactly using strict equality.\r\n * This function does not consider rectangles with the same area but different\r\n * positions or dimensions to be equal.\r\n *\r\n * @function Phaser.Geom.Rectangle.Equals\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The first rectangle to compare.\r\n * @param {Phaser.Geom.Rectangle} toCompare - The second rectangle to compare against.\r\n *\r\n * @return {boolean} `true` if the rectangles' properties are an exact match, otherwise `false`.\r\n */", "meta": { "filename": "Equals.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Compares the `x`, `y`, `width` and `height` properties of two rectangles.\rReturns `true` only if all four values match exactly using strict equality.\rThis function does not consider rectangles with the same area but different\rpositions or dimensions to be equal.", "kind": "function", "name": "Equals", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The first rectangle to compare.", "name": "rect" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The second rectangle to compare against.", "name": "toCompare" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the rectangles' properties are an exact match, otherwise `false`." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.Equals", "scope": "static", "___id": "T000002R020771", "___s": true }, { "comment": "/**\r\n * Adjusts the target rectangle, changing its width, height and position,\r\n * so that it fits inside the area of the source rectangle, while maintaining its original\r\n * aspect ratio.\r\n *\r\n * Unlike the `FitOutside` function, there may be some space inside the source area not covered.\r\n *\r\n * @function Phaser.Geom.Rectangle.FitInside\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [target,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} target - The target rectangle to adjust.\r\n * @param {Phaser.Geom.Rectangle} source - The source rectangle to envelop the target in.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The modified target rectangle instance.\r\n */", "meta": { "filename": "FitInside.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Adjusts the target rectangle, changing its width, height and position,\rso that it fits inside the area of the source rectangle, while maintaining its original\raspect ratio.\r\rUnlike the `FitOutside` function, there may be some space inside the source area not covered.", "kind": "function", "name": "FitInside", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [target,$return]", "value": "{Phaser.Geom.Rectangle} O - [target,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The target rectangle to adjust.", "name": "target" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The source rectangle to envelop the target in.", "name": "source" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The modified target rectangle instance." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.FitInside", "scope": "static", "___id": "T000002R020775", "___s": true }, { "comment": "/**\r\n * Adjusts the target rectangle, changing its width, height and position,\r\n * so that it fully covers the area of the source rectangle, while maintaining its original\r\n * aspect ratio.\r\n *\r\n * Unlike the `FitInside` function, the target rectangle may extend further out than the source.\r\n *\r\n * @function Phaser.Geom.Rectangle.FitOutside\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [target,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} target - The target rectangle to adjust.\r\n * @param {Phaser.Geom.Rectangle} source - The source rectangle to envelope the target in.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The modified target rectangle instance.\r\n */", "meta": { "filename": "FitOutside.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Adjusts the target rectangle, changing its width, height and position,\rso that it fully covers the area of the source rectangle, while maintaining its original\raspect ratio.\r\rUnlike the `FitInside` function, the target rectangle may extend further out than the source.", "kind": "function", "name": "FitOutside", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [target,$return]", "value": "{Phaser.Geom.Rectangle} O - [target,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The target rectangle to adjust.", "name": "target" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The source rectangle to envelope the target in.", "name": "source" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The modified target rectangle instance." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.FitOutside", "scope": "static", "___id": "T000002R020780", "___s": true }, { "comment": "/**\r\n * Rounds down (floors) the top left X and Y coordinates of the given Rectangle to the largest integer less than or equal to them\r\n *\r\n * @function Phaser.Geom.Rectangle.Floor\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [rect,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The rectangle to floor the top left X and Y coordinates of\r\n *\r\n * @return {Phaser.Geom.Rectangle} The rectangle that was passed to this function with its coordinates floored.\r\n */", "meta": { "filename": "Floor.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [rect,$return]", "value": "{Phaser.Geom.Rectangle} O - [rect,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The rectangle to floor the top left X and Y coordinates of", "name": "rect" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R020784", "___s": true }, { "comment": "/**\r\n * Rounds a Rectangle's position and size down to the largest integer less than or equal to each current coordinate or dimension.\r\n *\r\n * @function Phaser.Geom.Rectangle.FloorAll\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [rect,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to adjust.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The adjusted Rectangle.\r\n */", "meta": { "filename": "FloorAll.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [rect,$return]", "value": "{Phaser.Geom.Rectangle} O - [rect,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to adjust.", "name": "rect" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The adjusted Rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.FloorAll", "scope": "static", "___id": "T000002R020789", "___s": true }, { "comment": "/**\r\n * Constructs a new Rectangle or repositions and resizes an existing Rectangle so that all of the given points are on or within its bounds.\r\n *\r\n * The `points` parameter is an array of Point-like objects:\r\n *\r\n * ```js\r\n * const points = [\r\n * [100, 200],\r\n * [200, 400],\r\n * { x: 30, y: 60 }\r\n * ]\r\n * ```\r\n *\r\n * @function Phaser.Geom.Rectangle.FromPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [out,$return]\r\n *\r\n * @param {array} points - 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.\r\n * @param {Phaser.Geom.Rectangle} [out] - Optional Rectangle to adjust.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The adjusted `out` Rectangle, or a new Rectangle if none was provided.\r\n */", "meta": { "filename": "FromPoints.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Constructs a new Rectangle or repositions and resizes an existing Rectangle so that all of the given points are on or within its bounds.\r\rThe `points` parameter is an array of Point-like objects:\r\r```js\rconst points = [\r [100, 200],\r [200, 400],\r { x: 30, y: 60 }\r]\r```", "kind": "function", "name": "FromPoints", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [out,$return]", "value": "{Phaser.Geom.Rectangle} O - [out,$return]" } ], "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "optional": true, "description": "Optional Rectangle to adjust.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R020798", "___s": true }, { "comment": "/**\r\n * Create the smallest Rectangle containing two coordinate pairs.\r\n *\r\n * @function Phaser.Geom.Rectangle.FromXY\r\n * @since 3.23.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [out,$return]\r\n *\r\n * @param {number} x1 - The X coordinate of the first point.\r\n * @param {number} y1 - The Y coordinate of the first point.\r\n * @param {number} x2 - The X coordinate of the second point.\r\n * @param {number} y2 - The Y coordinate of the second point.\r\n * @param {Phaser.Geom.Rectangle} [out] - Optional Rectangle to adjust.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The adjusted `out` Rectangle, or a new Rectangle if none was provided.\r\n */", "meta": { "filename": "FromXY.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Create the smallest Rectangle containing two coordinate pairs.", "kind": "function", "name": "FromXY", "since": "3.23.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [out,$return]", "value": "{Phaser.Geom.Rectangle} O - [out,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the first point.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the first point.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the second point.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the second point.", "name": "y2" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "optional": true, "description": "Optional Rectangle to adjust.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The adjusted `out` Rectangle, or a new Rectangle if none was provided." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.FromXY", "scope": "static", "___id": "T000002R020824", "___s": true }, { "comment": "/**\r\n * Calculates the width/height ratio of a rectangle.\r\n *\r\n * @function Phaser.Geom.Rectangle.GetAspectRatio\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The rectangle.\r\n *\r\n * @return {number} The width/height ratio of the rectangle.\r\n */", "meta": { "filename": "GetAspectRatio.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Calculates the width/height ratio of a rectangle.", "kind": "function", "name": "GetAspectRatio", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The rectangle.", "name": "rect" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width/height ratio of the rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.GetAspectRatio", "scope": "static", "___id": "T000002R020828", "___s": true }, { "comment": "/**\r\n * Returns the center of a Rectangle as a Point.\r\n *\r\n * @function Phaser.Geom.Rectangle.GetCenter\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to get the center of.\r\n * @param {Phaser.Math.Vector2} [out] - Optional Vector2 object to update with the center coordinates.\r\n *\r\n * @return {Phaser.Math.Vector2} The modified `out` object, or a new Vector2 if none was provided.\r\n */", "meta": { "filename": "GetCenter.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Returns the center of a Rectangle as a Point.", "kind": "function", "name": "GetCenter", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to get the center of.", "name": "rect" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "Optional Vector2 object to update with the center coordinates.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The modified `out` object, or a new Vector2 if none was provided." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.GetCenter", "scope": "static", "___id": "T000002R020832", "___s": true }, { "comment": "/**\r\n * Calculates the coordinates of a point at a certain `position` on the Rectangle's perimeter.\r\n *\r\n * The `position` is a fraction between 0 and 1 which defines how far into the perimeter the point is.\r\n *\r\n * A 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.\r\n *\r\n * @function Phaser.Geom.Rectangle.GetPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rectangle - The Rectangle to get the perimeter point from.\r\n * @param {number} position - The normalized distance into the Rectangle's perimeter to return.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to update with the `x` and `y` coordinates of the point.\r\n *\r\n * @return {Phaser.Math.Vector2} The updated `out` object, or a new Vector2 if no `out` object was given.\r\n */", "meta": { "filename": "GetPoint.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Calculates the coordinates of a point at a certain `position` on the Rectangle's perimeter.\r\rThe `position` is a fraction between 0 and 1 which defines how far into the perimeter the point is.\r\rA 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to get the perimeter point from.", "name": "rectangle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The normalized distance into the Rectangle's perimeter to return.", "name": "position" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 object to update with the `x` and `y` coordinates of the point.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The updated `out` object, or a new Vector2 if no `out` object was given." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.GetPoint", "scope": "static", "___id": "T000002R020840", "___s": true }, { "comment": "/**\r\n * Return an array of Vector2 points from the perimeter of the rectangle, each spaced out based on the quantity or step required.\r\n *\r\n * @function Phaser.Geom.Rectangle.GetPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2[]} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rectangle - The Rectangle object to get the points from.\r\n * @param {number} quantity - The number of evenly spaced points from the rectangle's perimeter to return. If falsey, stepRate param will be used to calculate the number of points.\r\n * @param {number} stepRate - Step between points. Used to calculate the number of points to return when quantity is falsey. Ignored if quantity is positive.\r\n * @param {Phaser.Math.Vector2[]} [out] - An optional array to store the points in.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array of Vector2 points from the perimeter of the rectangle.\r\n */", "meta": { "filename": "GetPoints.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Return an array of Vector2 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [out,$return]", "value": "{Phaser.Math.Vector2[]} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle object to get the points from.", "name": "rectangle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The number of evenly spaced points from the rectangle's perimeter to return. If falsey, stepRate param will be used to calculate the number of points.", "name": "quantity" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Step between points. Used to calculate the number of points to return when quantity is falsey. Ignored if quantity is positive.", "name": "stepRate" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An optional array to store the points in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2 points from the perimeter of the rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.GetPoints", "scope": "static", "___id": "T000002R020858", "___s": true }, { "comment": "/**\r\n * Returns the size of the Rectangle, expressed as a Vector2 object.\r\n * With the value of the `width` as the `x` property and the `height` as the `y` property.\r\n *\r\n * @function Phaser.Geom.Rectangle.GetSize\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to get the size from.\r\n * @param {Phaser.Math.Vector2} [out] - The Vector2 object to store the size in. If not given, a new Vector2 instance is created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 object where `x` holds the width and `y` holds the height of the Rectangle.\r\n */", "meta": { "filename": "GetSize.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Returns the size of the Rectangle, expressed as a Vector2 object.\rWith the value of the `width` as the `x` property and the `height` as the `y` property.", "kind": "function", "name": "GetSize", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to get the size from.", "name": "rect" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "The Vector2 object to store the size in. If not given, a new Vector2 instance is created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 object where `x` holds the width and `y` holds the height of the Rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.GetSize", "scope": "static", "___id": "T000002R020866", "___s": true }, { "comment": "/**\r\n * Increases the size of a Rectangle by a specified amount.\r\n *\r\n * The 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.\r\n *\r\n * @function Phaser.Geom.Rectangle.Inflate\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [rect,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to inflate.\r\n * @param {number} x - How many pixels the left and the right side should be moved by horizontally.\r\n * @param {number} y - How many pixels the top and the bottom side should be moved by vertically.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The inflated Rectangle.\r\n */", "meta": { "filename": "Inflate.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Increases the size of a Rectangle by a specified amount.\r\rThe 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [rect,$return]", "value": "{Phaser.Geom.Rectangle} O - [rect,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to inflate.", "name": "rect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many pixels the left and the right side should be moved by horizontally.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "How many pixels the top and the bottom side should be moved by vertically.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The inflated Rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.Inflate", "scope": "static", "___id": "T000002R020913", "___s": true }, { "comment": "/**\r\n * Takes two Rectangles and first checks to see if they intersect.\r\n * If they intersect it will return the area of intersection in the `out` Rectangle.\r\n * If they do not intersect, the `out` Rectangle will have a width and height of zero.\r\n *\r\n * @function Phaser.Geom.Rectangle.Intersection\r\n * @since 3.11.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [rect,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rectA - The first Rectangle to get the intersection from.\r\n * @param {Phaser.Geom.Rectangle} rectB - The second Rectangle to get the intersection from.\r\n * @param {Phaser.Geom.Rectangle} [out] - A Rectangle to store the intersection results in.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The intersection result. If the width and height are zero, no intersection occurred.\r\n */", "meta": { "filename": "Intersection.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Takes two Rectangles and first checks to see if they intersect.\rIf they intersect it will return the area of intersection in the `out` Rectangle.\rIf they do not intersect, the `out` Rectangle will have a width and height of zero.", "kind": "function", "name": "Intersection", "since": "3.11.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [rect,$return]", "value": "{Phaser.Geom.Rectangle} O - [rect,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The first Rectangle to get the intersection from.", "name": "rectA" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The second Rectangle to get the intersection from.", "name": "rectB" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "optional": true, "description": "A Rectangle to store the intersection results in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R020920", "___s": true }, { "comment": "/**\r\n * Returns an array of Vector2 points evenly distributed around the perimeter of the Rectangle. This is\r\n * commonly used to create a \"marching ants\" selection effect, where the returned points are used to\r\n * animate a dashed outline that appears to march around the border of the rectangle.\r\n *\r\n * You can control the spacing of the points either by providing a pixel `step` distance between each\r\n * point, or by specifying the total `quantity` of points to distribute evenly around the full perimeter.\r\n * If both are omitted, an empty array is returned. If `step` is provided, `quantity` is derived from\r\n * the perimeter length divided by the step. If only `quantity` is provided, the step is derived instead.\r\n *\r\n * @function Phaser.Geom.Rectangle.MarchingAnts\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2[]} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to get the perimeter points from.\r\n * @param {number} [step] - The distance between each point of the perimeter. Set to `null` if you wish to use the `quantity` parameter instead.\r\n * @param {number} [quantity] - The total number of points to return. The step is then calculated based on the length of the Rectangle, divided by this value.\r\n * @param {Phaser.Math.Vector2[]} [out] - An array in which the perimeter points will be stored. If not given, a new array instance is created.\r\n *\r\n * @return {Phaser.Math.Vector2[]} An array containing the perimeter points from the Rectangle.\r\n */", "meta": { "filename": "MarchingAnts.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Returns an array of Vector2 points evenly distributed around the perimeter of the Rectangle. This is\rcommonly used to create a \"marching ants\" selection effect, where the returned points are used to\ranimate a dashed outline that appears to march around the border of the rectangle.\r\rYou can control the spacing of the points either by providing a pixel `step` distance between each\rpoint, or by specifying the total `quantity` of points to distribute evenly around the full perimeter.\rIf both are omitted, an empty array is returned. If `step` is provided, `quantity` is derived from\rthe perimeter length divided by the step. If only `quantity` is provided, the step is derived instead.", "kind": "function", "name": "MarchingAnts", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [out,$return]", "value": "{Phaser.Math.Vector2[]} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to get the perimeter points from.", "name": "rect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The distance between each point of the perimeter. Set to `null` if you wish to use the `quantity` parameter instead.", "name": "step" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "The total number of points to return. The step is then calculated based on the length of the Rectangle, divided by this value.", "name": "quantity" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An array in which the perimeter points will be stored. If not given, a new array instance is created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array containing the perimeter points from the Rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.MarchingAnts", "scope": "static", "___id": "T000002R020930", "___s": true }, { "comment": "/**\r\n * 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.\r\n *\r\n * @function Phaser.Geom.Rectangle.MergePoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [target,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} target - The Rectangle which should be merged.\r\n * @param {Phaser.Math.Vector2[]} points - An array of Vector2 objects which should be merged with the Rectangle.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The modified Rectangle.\r\n */", "meta": { "filename": "MergePoints.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [target,$return]", "value": "{Phaser.Geom.Rectangle} O - [target,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle which should be merged.", "name": "target" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2 objects which should be merged with the Rectangle.", "name": "points" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The modified Rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.MergePoints", "scope": "static", "___id": "T000002R020955", "___s": true }, { "comment": "/**\r\n * Merges the source rectangle into the target rectangle and returns the target.\r\n * Neither rectangle should have a negative width or height.\r\n *\r\n * @function Phaser.Geom.Rectangle.MergeRect\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [target,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} target - Target rectangle. Will be modified to include source rectangle.\r\n * @param {Phaser.Geom.Rectangle} source - Rectangle that will be merged into target rectangle.\r\n *\r\n * @return {Phaser.Geom.Rectangle} Modified target rectangle that contains source rectangle.\r\n */", "meta": { "filename": "MergeRect.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Merges the source rectangle into the target rectangle and returns the target.\rNeither rectangle should have a negative width or height.", "kind": "function", "name": "MergeRect", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [target,$return]", "value": "{Phaser.Geom.Rectangle} O - [target,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "Target rectangle. Will be modified to include source rectangle.", "name": "target" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "Rectangle that will be merged into target rectangle.", "name": "source" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "Modified target rectangle that contains source rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.MergeRect", "scope": "static", "___id": "T000002R020971", "___s": true }, { "comment": "/**\r\n * Merges a Rectangle with a point by repositioning and/or resizing it so that the point is on or within its bounds.\r\n *\r\n * @function Phaser.Geom.Rectangle.MergeXY\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [target,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} target - The Rectangle which should be merged and modified.\r\n * @param {number} x - The X coordinate of the point which should be merged.\r\n * @param {number} y - The Y coordinate of the point which should be merged.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The modified `target` Rectangle.\r\n */", "meta": { "filename": "MergeXY.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [target,$return]", "value": "{Phaser.Geom.Rectangle} O - [target,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle which should be merged and modified.", "name": "target" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the point which should be merged.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the point which should be merged.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The modified `target` Rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.MergeXY", "scope": "static", "___id": "T000002R020982", "___s": true }, { "comment": "/**\r\n * Translates a Rectangle by the given horizontal and vertical amounts, moving its position while preserving its size.\r\n *\r\n * @function Phaser.Geom.Rectangle.Offset\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [rect,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to adjust.\r\n * @param {number} x - The distance to move the Rectangle horizontally.\r\n * @param {number} y - The distance to move the Rectangle vertically.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The adjusted Rectangle.\r\n */", "meta": { "filename": "Offset.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Translates a Rectangle by the given horizontal and vertical amounts, moving its position while preserving its size.", "kind": "function", "name": "Offset", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [rect,$return]", "value": "{Phaser.Geom.Rectangle} O - [rect,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to adjust.", "name": "rect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance to move the Rectangle horizontally.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance to move the Rectangle vertically.", "name": "y" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The adjusted Rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.Offset", "scope": "static", "___id": "T000002R020993", "___s": true }, { "comment": "/**\r\n * Translates the top-left corner of a Rectangle by the coordinates of a translation vector.\r\n *\r\n * @function Phaser.Geom.Rectangle.OffsetPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [rect,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to adjust.\r\n * @param {Phaser.Math.Vector2} vec - The Vector2 point whose coordinates should be used as an offset.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The adjusted Rectangle.\r\n */", "meta": { "filename": "OffsetPoint.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Translates the top-left corner of a Rectangle by the coordinates of a translation vector.", "kind": "function", "name": "OffsetPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [rect,$return]", "value": "{Phaser.Geom.Rectangle} O - [rect,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to adjust.", "name": "rect" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The Vector2 point whose coordinates should be used as an offset.", "name": "vec" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The adjusted Rectangle." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.OffsetPoint", "scope": "static", "___id": "T000002R020998", "___s": true }, { "comment": "/**\r\n * 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\".\r\n *\r\n * @function Phaser.Geom.Rectangle.Overlaps\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rectA - The first Rectangle to check.\r\n * @param {Phaser.Geom.Rectangle} rectB - The second Rectangle to check.\r\n *\r\n * @return {boolean} `true` if the two Rectangles overlap, `false` otherwise.\r\n */", "meta": { "filename": "Overlaps.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The first Rectangle to check.", "name": "rectA" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The second Rectangle to check.", "name": "rectB" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the two Rectangles overlap, `false` otherwise." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.Overlaps", "scope": "static", "___id": "T000002R021003", "___s": true }, { "comment": "/**\r\n * Calculates the perimeter of a Rectangle.\r\n *\r\n * @function Phaser.Geom.Rectangle.Perimeter\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to use.\r\n *\r\n * @return {number} The perimeter of the Rectangle, equal to `(width * 2) + (height * 2)`.\r\n */", "meta": { "filename": "Perimeter.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Calculates the perimeter of a Rectangle.", "kind": "function", "name": "Perimeter", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to use.", "name": "rect" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The perimeter of the Rectangle, equal to `(width * 2) + (height * 2)`." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.Perimeter", "scope": "static", "___id": "T000002R021006", "___s": true }, { "comment": "/**\r\n * Returns a point from the perimeter of a Rectangle based on the given angle, measured in degrees from the center of the Rectangle.\r\n *\r\n * @function Phaser.Geom.Rectangle.PerimeterPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rectangle - The Rectangle to get the perimeter point from.\r\n * @param {number} angle - The angle of the point, in degrees.\r\n * @param {Phaser.Math.Vector2} [out] - The Vector2 object to store the position in. If not given, a new Vector2 instance is created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 object holding the coordinates of the point on the Rectangle's perimeter.\r\n */", "meta": { "filename": "PerimeterPoint.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Returns a point from the perimeter of a Rectangle based on the given angle, measured in degrees from the center of the Rectangle.", "kind": "function", "name": "PerimeterPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to get the perimeter point from.", "name": "rectangle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle of the point, in degrees.", "name": "angle" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "The Vector2 object to store the position in. If not given, a new Vector2 instance is created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 object holding the coordinates of the point on the Rectangle's perimeter." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.PerimeterPoint", "scope": "static", "___id": "T000002R021011", "___s": true }, { "comment": "/**\r\n * Returns a random point within a Rectangle.\r\n *\r\n * @function Phaser.Geom.Rectangle.Random\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The Rectangle to return a point from.\r\n * @param {Phaser.Math.Vector2} out - The object to update with the point's coordinates.\r\n *\r\n * @return {Phaser.Math.Vector2} The modified `out` object, or a new Point if none was provided.\r\n */", "meta": { "filename": "Random.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Returns a random point within a Rectangle.", "kind": "function", "name": "Random", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The Rectangle to return a point from.", "name": "rect" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The object to update with the point's coordinates.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The modified `out` object, or a new Point if none was provided." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.Random", "scope": "static", "___id": "T000002R021025", "___s": true }, { "comment": "/**\r\n * Calculates a random point that lies within the `outer` Rectangle, but outside of the `inner` Rectangle.\r\n * The inner Rectangle must be fully contained within the outer rectangle for a point to be generated.\r\n * If `inner` is not fully contained within `outer`, the function returns the `out` vector unchanged.\r\n *\r\n * @function Phaser.Geom.Rectangle.RandomOutside\r\n * @since 3.10.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} outer - The outer Rectangle to get the random point within.\r\n * @param {Phaser.Geom.Rectangle} inner - The inner Rectangle to exclude from the returned point.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the result in. If not specified, a new Vector2 will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 object containing the random values in its `x` and `y` properties.\r\n */", "meta": { "filename": "RandomOutside.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Calculates a random point that lies within the `outer` Rectangle, but outside of the `inner` Rectangle.\rThe inner Rectangle must be fully contained within the outer rectangle for a point to be generated.\rIf `inner` is not fully contained within `outer`, the function returns the `out` vector unchanged.", "kind": "function", "name": "RandomOutside", "since": "3.10.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The outer Rectangle to get the random point within.", "name": "outer" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The inner Rectangle to exclude from the returned point.", "name": "inner" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 object to store the result in. If not specified, a new Vector2 will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 object containing the random values in its `x` and `y` properties." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle.RandomOutside", "scope": "static", "___id": "T000002R021034", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Rectangle is an axis-aligned region of 2D space defined by its top-left corner position (`x`, `y`) and its\r\n * dimensions (`width`, `height`). It is one of the core geometric primitives in Phaser and is used extensively\r\n * throughout the framework for bounds checking, camera viewports, hit areas, culling regions, and UI layout.\r\n *\r\n * Rectangles support containment tests, perimeter point sampling, and many other geometric operations available\r\n * via the `Phaser.Geom.Rectangle` static methods. The `left`, `right`, `top`, `bottom`, `centerX`, and `centerY`\r\n * properties provide convenient access to derived positional values and can be set directly to reposition or\r\n * resize the Rectangle.\r\n *\r\n * @class Rectangle\r\n * @memberof Phaser.Geom\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x=0] - The X coordinate of the top left corner of the Rectangle.\r\n * @param {number} [y=0] - The Y coordinate of the top left corner of the Rectangle.\r\n * @param {number} [width=0] - The width of the Rectangle.\r\n * @param {number} [height=0] - The height of the Rectangle.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "classdesc": "A Rectangle is an axis-aligned region of 2D space defined by its top-left corner position (`x`, `y`) and its\rdimensions (`width`, `height`). It is one of the core geometric primitives in Phaser and is used extensively\rthroughout the framework for bounds checking, camera viewports, hit areas, culling regions, and UI layout.\r\rRectangles support containment tests, perimeter point sampling, and many other geometric operations available\rvia the `Phaser.Geom.Rectangle` static methods. The `left`, `right`, `top`, `bottom`, `centerX`, and `centerY`\rproperties provide convenient access to derived positional values and can be set directly to reposition or\rresize the Rectangle.", "kind": "class", "name": "Rectangle", "memberof": "Phaser.Geom", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The X coordinate of the top left corner of the Rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The Y coordinate of the top left corner of the Rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The width of the Rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "The height of the Rectangle.", "name": "height" } ], "scope": "static", "longname": "Phaser.Geom.Rectangle", "___id": "T000002R021053", "___s": true }, { "comment": "/**\r\n * The geometry constant type of this object: `GEOM_CONST.RECTANGLE`.\r\n * Used for fast type comparisons.\r\n *\r\n * @name Phaser.Geom.Rectangle#type\r\n * @type {number}\r\n * @readonly\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "The geometry constant type of this object: `GEOM_CONST.RECTANGLE`.\rUsed for fast type comparisons.", "name": "type", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.19.0", "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#type", "scope": "instance", "kind": "member", "___id": "T000002R021060", "___s": true }, { "comment": "/**\r\n * The X coordinate of the top left corner of the Rectangle.\r\n *\r\n * @name Phaser.Geom.Rectangle#x\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "The X coordinate of the top left corner of the Rectangle.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#x", "scope": "instance", "kind": "member", "___id": "T000002R021062", "___s": true }, { "comment": "/**\r\n * The Y coordinate of the top left corner of the Rectangle.\r\n *\r\n * @name Phaser.Geom.Rectangle#y\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "The Y coordinate of the top left corner of the Rectangle.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#y", "scope": "instance", "kind": "member", "___id": "T000002R021064", "___s": true }, { "comment": "/**\r\n * The width of the Rectangle, i.e. the distance between its left side (defined by `x`) and its right side.\r\n *\r\n * @name Phaser.Geom.Rectangle#width\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 78, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#width", "scope": "instance", "kind": "member", "___id": "T000002R021066", "___s": true }, { "comment": "/**\r\n * The height of the Rectangle, i.e. the distance between its top side (defined by `y`) and its bottom side.\r\n *\r\n * @name Phaser.Geom.Rectangle#height\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 88, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#height", "scope": "instance", "kind": "member", "___id": "T000002R021068", "___s": true }, { "comment": "/**\r\n * Checks if the given point is inside the Rectangle's bounds.\r\n *\r\n * @method Phaser.Geom.Rectangle#contains\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The X coordinate of the point to check.\r\n * @param {number} y - The Y coordinate of the point to check.\r\n *\r\n * @return {boolean} `true` if the point is within the Rectangle's bounds, otherwise `false`.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 99, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Checks if the given point is inside the Rectangle's bounds.", "kind": "function", "name": "contains", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the point to check.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the point to check.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021070", "___s": true }, { "comment": "/**\r\n * Calculates the coordinates of a point at a certain `position` on the Rectangle's perimeter.\r\n *\r\n * The `position` is a fraction between 0 and 1 which defines how far into the perimeter the point is.\r\n *\r\n * A 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.\r\n *\r\n * @method Phaser.Geom.Rectangle#getPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [output,$return]\r\n *\r\n * @param {number} position - The normalized distance into the Rectangle's perimeter to return.\r\n * @param {Phaser.Math.Vector2} [output] - A Vector2 instance to update with the `x` and `y` coordinates of the point.\r\n *\r\n * @return {Phaser.Math.Vector2} The updated `output` object, or a new Vector2 if no `output` object was given.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 115, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Calculates the coordinates of a point at a certain `position` on the Rectangle's perimeter.\r\rThe `position` is a fraction between 0 and 1 which defines how far into the perimeter the point is.\r\rA 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [output,$return]", "value": "{Phaser.Math.Vector2} O - [output,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The normalized distance into the Rectangle's perimeter to return.", "name": "position" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 instance to update with the `x` and `y` coordinates of the point.", "name": "output" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The updated `output` object, or a new Vector2 if no `output` object was given." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#getPoint", "scope": "instance", "___id": "T000002R021072", "___s": true }, { "comment": "/**\r\n * Returns an array of points from the perimeter of the Rectangle, each spaced out based on the quantity or step required.\r\n *\r\n * @method Phaser.Geom.Rectangle#getPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2[]} O - [output,$return]\r\n *\r\n * @param {number} quantity - 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`.\r\n * @param {number} [stepRate] - If `quantity` is 0, determines the normalized distance between each returned point.\r\n * @param {Phaser.Math.Vector2[]} [output] - An array to which to append the points.\r\n *\r\n * @return {Phaser.Math.Vector2[]} The modified `output` array, or a new array if none was provided.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 137, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [output,$return]", "value": "{Phaser.Math.Vector2[]} O - [output,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "If `quantity` is 0, determines the normalized distance between each returned point.", "name": "stepRate" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An array to which to append the points.", "name": "output" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "The modified `output` array, or a new array if none was provided." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#getPoints", "scope": "instance", "___id": "T000002R021074", "___s": true }, { "comment": "/**\r\n * Returns a random point within the Rectangle's bounds.\r\n *\r\n * @method Phaser.Geom.Rectangle#getRandomPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [point,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [vec] - The object in which to store the `x` and `y` coordinates of the point.\r\n *\r\n * @return {Phaser.Math.Vector2} The updated `vec`, or a new Vector2 if none was provided.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 156, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Returns a random point within the Rectangle's bounds.", "kind": "function", "name": "getRandomPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [point,$return]", "value": "{Phaser.Math.Vector2} O - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "The object in which to store the `x` and `y` coordinates of the point.", "name": "vec" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The updated `vec`, or a new Vector2 if none was provided." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#getRandomPoint", "scope": "instance", "___id": "T000002R021076", "___s": true }, { "comment": "/**\r\n * Sets the position, width, and height of the Rectangle.\r\n *\r\n * @method Phaser.Geom.Rectangle#setTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The X coordinate of the top left corner of the Rectangle.\r\n * @param {number} y - The Y coordinate of the top left corner of the Rectangle.\r\n * @param {number} width - The width of the Rectangle.\r\n * @param {number} height - The height of the Rectangle.\r\n *\r\n * @return {this} This Rectangle object.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 173, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Sets the position, width, and height of the Rectangle.", "kind": "function", "name": "setTo", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the top left corner of the Rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the top left corner of the Rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the Rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the Rectangle.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Rectangle object." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#setTo", "scope": "instance", "___id": "T000002R021078", "___s": true }, { "comment": "/**\r\n * Resets the position, width, and height of the Rectangle to 0.\r\n *\r\n * @method Phaser.Geom.Rectangle#setEmpty\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Rectangle object.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 196, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Resets the position, width, and height of the Rectangle to 0.", "kind": "function", "name": "setEmpty", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Rectangle object." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#setEmpty", "scope": "instance", "___id": "T000002R021084", "___s": true }, { "comment": "/**\r\n * Sets the position of the Rectangle.\r\n *\r\n * @method Phaser.Geom.Rectangle#setPosition\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The X coordinate of the top left corner of the Rectangle.\r\n * @param {number} [y=x] - The Y coordinate of the top left corner of the Rectangle.\r\n *\r\n * @return {this} This Rectangle object.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 209, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Sets the position of the Rectangle.", "kind": "function", "name": "setPosition", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the top left corner of the Rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "x", "description": "The Y coordinate of the top left corner of the Rectangle.", "name": "y" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Rectangle object." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#setPosition", "scope": "instance", "___id": "T000002R021086", "___s": true }, { "comment": "/**\r\n * Sets the width and height of the Rectangle.\r\n *\r\n * @method Phaser.Geom.Rectangle#setSize\r\n * @since 3.0.0\r\n *\r\n * @param {number} width - The width to set the Rectangle to.\r\n * @param {number} [height=width] - The height to set the Rectangle to.\r\n *\r\n * @return {this} This Rectangle object.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Sets the width and height of the Rectangle.", "kind": "function", "name": "setSize", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width to set the Rectangle to.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "width", "description": "The height to set the Rectangle to.", "name": "height" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Rectangle object." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#setSize", "scope": "instance", "___id": "T000002R021091", "___s": true }, { "comment": "/**\r\n * Determines if the Rectangle is empty. A Rectangle is empty if its width or height is less than or equal to 0.\r\n *\r\n * @method Phaser.Geom.Rectangle#isEmpty\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the Rectangle is empty, otherwise `false`.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 251, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Rectangle is empty, otherwise `false`." } ], "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#isEmpty", "scope": "instance", "___id": "T000002R021096", "___s": true }, { "comment": "/**\r\n * Returns a Line object that corresponds to the top of this Rectangle.\r\n *\r\n * @method Phaser.Geom.Rectangle#getLineA\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Line} O - [line,$return]\r\n *\r\n * @param {Phaser.Geom.Line} [line] - A Line object to set the results in. If `undefined` a new Line will be created.\r\n *\r\n * @return {Phaser.Geom.Line} A Line object that corresponds to the top of this Rectangle.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 264, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Returns a Line object that corresponds to the top of this Rectangle.", "kind": "function", "name": "getLineA", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Line} O - [line,$return]", "value": "{Phaser.Geom.Line} O - [line,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021098", "___s": true }, { "comment": "/**\r\n * Returns a Line object that corresponds to the right of this Rectangle.\r\n *\r\n * @method Phaser.Geom.Rectangle#getLineB\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Line} O - [line,$return]\r\n *\r\n * @param {Phaser.Geom.Line} [line] - A Line object to set the results in. If `undefined` a new Line will be created.\r\n *\r\n * @return {Phaser.Geom.Line} A Line object that corresponds to the right of this Rectangle.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 285, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Returns a Line object that corresponds to the right of this Rectangle.", "kind": "function", "name": "getLineB", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Line} O - [line,$return]", "value": "{Phaser.Geom.Line} O - [line,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021101", "___s": true }, { "comment": "/**\r\n * Returns a Line object that corresponds to the bottom of this Rectangle.\r\n *\r\n * @method Phaser.Geom.Rectangle#getLineC\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Line} O - [line,$return]\r\n *\r\n * @param {Phaser.Geom.Line} [line] - A Line object to set the results in. If `undefined` a new Line will be created.\r\n *\r\n * @return {Phaser.Geom.Line} A Line object that corresponds to the bottom of this Rectangle.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 306, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Returns a Line object that corresponds to the bottom of this Rectangle.", "kind": "function", "name": "getLineC", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Line} O - [line,$return]", "value": "{Phaser.Geom.Line} O - [line,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021104", "___s": true }, { "comment": "/**\r\n * Returns a Line object that corresponds to the left of this Rectangle.\r\n *\r\n * @method Phaser.Geom.Rectangle#getLineD\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Line} O - [line,$return]\r\n *\r\n * @param {Phaser.Geom.Line} [line] - A Line object to set the results in. If `undefined` a new Line will be created.\r\n *\r\n * @return {Phaser.Geom.Line} A Line object that corresponds to the left of this Rectangle.\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 327, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Returns a Line object that corresponds to the left of this Rectangle.", "kind": "function", "name": "getLineD", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Line} O - [line,$return]", "value": "{Phaser.Geom.Line} O - [line,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021107", "___s": true }, { "comment": "/**\r\n * The x coordinate of the left of the Rectangle.\r\n * Changing 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.\r\n *\r\n * @name Phaser.Geom.Rectangle#left\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 348, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "The x coordinate of the left of the Rectangle.\rChanging 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#left", "scope": "instance", "kind": "member", "___id": "T000002R021110", "___s": true }, { "comment": "/**\r\n * The sum of the x and width properties.\r\n * Changing the right property of a Rectangle object has no effect on the x, y and height properties, however it does affect the width property.\r\n *\r\n * @name Phaser.Geom.Rectangle#right\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 379, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "The sum of the x and width properties.\rChanging 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#right", "scope": "instance", "kind": "member", "___id": "T000002R021117", "___s": true }, { "comment": "/**\r\n * 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.\r\n * However it does affect the height property, whereas changing the y value does not affect the height property.\r\n *\r\n * @name Phaser.Geom.Rectangle#top\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 408, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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.\rHowever it does affect the height property, whereas changing the y value does not affect the height property.", "name": "top", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#top", "scope": "instance", "kind": "member", "___id": "T000002R021123", "___s": true }, { "comment": "/**\r\n * The sum of the y and height properties.\r\n * Changing the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.\r\n *\r\n * @name Phaser.Geom.Rectangle#bottom\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 439, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "The sum of the y and height properties.\rChanging 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#bottom", "scope": "instance", "kind": "member", "___id": "T000002R021130", "___s": true }, { "comment": "/**\r\n * The x coordinate of the center of the Rectangle.\r\n *\r\n * @name Phaser.Geom.Rectangle#centerX\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 468, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "The x coordinate of the center of the Rectangle.", "name": "centerX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#centerX", "scope": "instance", "kind": "member", "___id": "T000002R021136", "___s": true }, { "comment": "/**\r\n * The y coordinate of the center of the Rectangle.\r\n *\r\n * @name Phaser.Geom.Rectangle#centerY\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Rectangle.js", "lineno": 489, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "The y coordinate of the center of the Rectangle.", "name": "centerY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Rectangle", "longname": "Phaser.Geom.Rectangle#centerY", "scope": "instance", "kind": "member", "___id": "T000002R021141", "___s": true }, { "comment": "/**\r\n * Determines if the two objects (either Rectangles or Rectangle-like) have the same width and height values under strict equality.\r\n *\r\n * @function Phaser.Geom.Rectangle.SameDimensions\r\n * @since 3.15.0\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The first Rectangle object.\r\n * @param {Phaser.Geom.Rectangle} toCompare - The second Rectangle object.\r\n *\r\n * @return {boolean} `true` if the objects have equivalent values for the `width` and `height` properties, otherwise `false`.\r\n */", "meta": { "filename": "SameDimensions.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The first Rectangle object.", "name": "rect" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The second Rectangle object.", "name": "toCompare" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021147", "___s": true }, { "comment": "/**\r\n * Scales the width and height of the given Rectangle by the given factors.\r\n *\r\n * @function Phaser.Geom.Rectangle.Scale\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [rect,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rect - The `Rectangle` object that will be scaled by the specified amount(s).\r\n * @param {number} x - The factor by which to scale the rectangle horizontally.\r\n * @param {number} y - The factor by which to scale the rectangle vertically. If this is not specified, the rectangle will be scaled by the factor `x` in both directions.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The rectangle object with updated `width` and `height` properties as calculated from the scaling factor(s).\r\n */", "meta": { "filename": "Scale.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "description": "Scales the width and height of the given Rectangle by the given factors.", "kind": "function", "name": "Scale", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [rect,$return]", "value": "{Phaser.Geom.Rectangle} O - [rect,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The `Rectangle` object that will be scaled by the specified amount(s).", "name": "rect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The factor by which to scale the rectangle horizontally.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The factor 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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021150", "___s": true }, { "comment": "/**\r\n * 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.\r\n *\r\n * @function Phaser.Geom.Rectangle.Union\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Rectangle} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Rectangle} rectA - The first Rectangle to use.\r\n * @param {Phaser.Geom.Rectangle} rectB - The second Rectangle to use.\r\n * @param {Phaser.Geom.Rectangle} [out] - The Rectangle to store the union in.\r\n *\r\n * @return {Phaser.Geom.Rectangle} The modified `out` Rectangle, or a new Rectangle if none was provided.\r\n */", "meta": { "filename": "Union.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\rectangle", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Rectangle} O - [out,$return]", "value": "{Phaser.Geom.Rectangle} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The first Rectangle to use.", "name": "rectA" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "description": "The second Rectangle to use.", "name": "rectB" }, { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Rectangle" } }, "optional": true, "description": "The Rectangle to store the union in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Rectangle" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021157", "___s": true }, { "comment": "/**\r\n * Returns the area of a Triangle.\r\n *\r\n * @function Phaser.Geom.Triangle.Area\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to use.\r\n *\r\n * @return {number} The area of the Triangle, always non-negative.\r\n */", "meta": { "filename": "Area.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns the area of a Triangle.", "kind": "function", "name": "Area", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to use.", "name": "triangle" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The area of the Triangle, always non-negative." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.Area", "scope": "static", "___id": "T000002R021165", "___s": true }, { "comment": "/**\r\n * 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).\r\n * The x/y specifies the top-middle of the triangle (x1/y1) and length is the length of each side.\r\n *\r\n * @function Phaser.Geom.Triangle.BuildEquilateral\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - x coordinate of the top point of the triangle.\r\n * @param {number} y - y coordinate of the top point of the triangle.\r\n * @param {number} length - Length of each side of the triangle.\r\n *\r\n * @return {Phaser.Geom.Triangle} A new equilateral Triangle with its apex at (`x`, `y`) and all sides of the specified `length`.\r\n */", "meta": { "filename": "BuildEquilateral.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "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).\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "x coordinate of the top point of the triangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "y coordinate of the top point of the triangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Length of each side of the triangle.", "name": "length" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "A new equilateral Triangle with its apex at (`x`, `y`) and all sides of the specified `length`." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.BuildEquilateral", "scope": "static", "___id": "T000002R021175", "___s": true }, { "comment": "/**\r\n * Takes an array of vertex coordinates, and optionally an array of hole indices, then returns an array\r\n * of Triangle instances, where the given vertices have been decomposed into a series of triangles.\r\n *\r\n * @function Phaser.Geom.Triangle.BuildFromPolygon\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Triangle[]} O - [out,$return]\r\n *\r\n * @param {array} data - A flat array of vertex coordinates like [x0,y0, x1,y1, x2,y2, ...]\r\n * @param {array} [holes=null] - 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).\r\n * @param {number} [scaleX=1] - Horizontal scale factor to multiply the resulting points by.\r\n * @param {number} [scaleY=1] - Vertical scale factor to multiply the resulting points by.\r\n * @param {(array|Phaser.Geom.Triangle[])} [out] - An array to store the resulting Triangle instances in. If not provided, a new array is created.\r\n *\r\n * @return {(array|Phaser.Geom.Triangle[])} An array of Triangle instances, where each triangle is based on the decomposed vertices data.\r\n */", "meta": { "filename": "BuildFromPolygon.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Takes an array of vertex coordinates, and optionally an array of hole indices, then returns an array\rof Triangle instances, where the given vertices have been decomposed into a series of triangles.", "kind": "function", "name": "BuildFromPolygon", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Triangle[]} O - [out,$return]", "value": "{Phaser.Geom.Triangle[]} O - [out,$return]" } ], "params": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "A flat array of vertex coordinates like [x0,y0, x1,y1, x2,y2, ...]", "name": "data" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Horizontal scale factor to multiply the resulting points by.", "name": "scaleX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "Vertical scale factor to multiply the resulting points by.", "name": "scaleY" }, { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Triangle", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "An array to store the resulting Triangle instances in. If not provided, a new array is created.", "name": "out" } ], "returns": [ { "type": { "names": [ "array", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "array" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Geom.Triangle", "type": "NameExpression" } ] } ] } }, "description": "An array of Triangle instances, where each triangle is based on the decomposed vertices data." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.BuildFromPolygon", "scope": "static", "___id": "T000002R021187", "___s": true }, { "comment": "/**\r\n * Builds a right triangle, i.e. one which has a 90-degree angle and two acute angles. The `x` and `y` coordinates mark the position of the right-angle vertex, which becomes the first point of the Triangle. The `width` and `height` values determine the lengths of the two sides adjacent to the right angle and may be positive or negative, which controls the direction in which each side extends from the right-angle vertex.\r\n *\r\n * @function Phaser.Geom.Triangle.BuildRight\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The X coordinate of the right angle, which will also be the first X coordinate of the constructed Triangle.\r\n * @param {number} y - The Y coordinate of the right angle, which will also be the first Y coordinate of the constructed Triangle.\r\n * @param {number} width - The length of the side which is to the left or to the right of the right angle.\r\n * @param {number} height - The length of the side which is above or below the right angle. If not given, defaults to the value of `width`.\r\n *\r\n * @return {Phaser.Geom.Triangle} The constructed right Triangle.\r\n */", "meta": { "filename": "BuildRight.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Builds a right triangle, i.e. one which has a 90-degree angle and two acute angles. The `x` and `y` coordinates mark the position of the right-angle vertex, which becomes the first point of the Triangle. The `width` and `height` values determine the lengths of the two sides adjacent to the right angle and may be positive or negative, which controls the direction in which each side extends from the right-angle vertex.", "kind": "function", "name": "BuildRight", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of the side which is above or below the right angle. If not given, defaults to the value of `width`.", "name": "height" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The constructed right Triangle." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.BuildRight", "scope": "static", "___id": "T000002R021216", "___s": true }, { "comment": "/**\r\n * @callback CenterFunction\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to return the center coordinates of.\r\n *\r\n * @return {Phaser.Math.Vector2} The center point of the Triangle according to the function.\r\n */", "meta": { "filename": "CenterOn.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "kind": "typedef", "name": "CenterFunction", "type": { "names": [ "function" ] }, "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to return the center coordinates of.", "name": "triangle" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The center point of the Triangle according to the function." } ], "longname": "CenterFunction", "scope": "global", "___id": "T000002R021228", "___s": true }, { "comment": "/**\r\n * Positions the Triangle so that it is centered on the given coordinates.\r\n *\r\n * @function Phaser.Geom.Triangle.CenterOn\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Triangle} O - [triangle,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The triangle to be positioned.\r\n * @param {number} x - The horizontal coordinate to center on.\r\n * @param {number} y - The vertical coordinate to center on.\r\n * @param {CenterFunction} [centerFunc] - The function used to center the triangle. Defaults to Centroid centering.\r\n *\r\n * @return {Phaser.Geom.Triangle} The Triangle that was centered.\r\n */", "meta": { "filename": "CenterOn.js", "lineno": 18, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Positions the Triangle so that it is centered on the given coordinates.", "kind": "function", "name": "CenterOn", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Triangle} O - [triangle,$return]", "value": "{Phaser.Geom.Triangle} O - [triangle,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The triangle to be positioned.", "name": "triangle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal coordinate to center on.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical coordinate to center on.", "name": "y" }, { "type": { "names": [ "CenterFunction" ], "parsedType": { "type": "NameExpression", "name": "CenterFunction" } }, "optional": true, "description": "The function used to center the triangle. Defaults to Centroid centering.", "name": "centerFunc" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle that was centered." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.CenterOn", "scope": "static", "___id": "T000002R021229", "___s": true }, { "comment": "/**\r\n * Calculates the position of a Triangle's centroid, which is also its center of mass (center of gravity).\r\n *\r\n * The 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.\r\n *\r\n * @function Phaser.Geom.Triangle.Centroid\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to use.\r\n * @param {Phaser.Math.Vector2} [out] - A Vector2 object to store the coordinates in.\r\n *\r\n * @return {Phaser.Math.Vector2} The `out` object with modified `x` and `y` properties, or a new Vector2 if none was provided.\r\n */", "meta": { "filename": "Centroid.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Calculates the position of a Triangle's centroid, which is also its center of mass (center of gravity).\r\rThe 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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to use.", "name": "triangle" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "A Vector2 object to store the coordinates in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The `out` object with modified `x` and `y` properties, or a new Vector2 if none was provided." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.Centroid", "scope": "static", "___id": "T000002R021237", "___s": true }, { "comment": "/**\r\n * Computes the circumcenter of a triangle. The circumcenter is the centre of\r\n * the circumcircle, the unique circle that passes through all three vertices of\r\n * the triangle. It is also the common intersection point of the perpendicular\r\n * bisectors of the sides of the triangle, and is the only point which has equal\r\n * distance to all three vertices of the triangle.\r\n * \r\n * Adapted from http://bjornharrtell.github.io/jsts/doc/api/jsts_geom_Triangle.js.html\r\n *\r\n * @function Phaser.Geom.Triangle.CircumCenter\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to get the circumcenter of.\r\n * @param {Phaser.Math.Vector2} [out] - The Vector2 object to store the position in. If not given, a new Vector2 instance is created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 object holding the coordinates of the circumcenter of the Triangle.\r\n */", "meta": { "filename": "CircumCenter.js", "lineno": 28, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Computes the circumcenter of a triangle. The circumcenter is the centre of\rthe circumcircle, the unique circle that passes through all three vertices of\rthe triangle. It is also the common intersection point of the perpendicular\rbisectors of the sides of the triangle, and is the only point which has equal\rdistance to all three vertices of the triangle.\r\rAdapted from http://bjornharrtell.github.io/jsts/doc/api/jsts_geom_Triangle.js.html", "kind": "function", "name": "CircumCenter", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to get the circumcenter of.", "name": "triangle" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "The Vector2 object to store the position in. If not given, a new Vector2 instance is created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 object holding the coordinates of the circumcenter of the Triangle." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.CircumCenter", "scope": "static", "___id": "T000002R021246", "___s": true }, { "comment": "/**\r\n * Finds the circumscribed circle (circumcircle) of a Triangle object. The circumcircle is the circle which touches all of the triangle's vertices.\r\n * \r\n * Adapted from https://gist.github.com/mutoo/5617691\r\n *\r\n * @function Phaser.Geom.Triangle.CircumCircle\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Circle} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to use as input.\r\n * @param {Phaser.Geom.Circle} [out] - An optional Circle to store the result in.\r\n *\r\n * @return {Phaser.Geom.Circle} The updated `out` Circle, or a new Circle if none was provided.\r\n */", "meta": { "filename": "CircumCircle.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Finds the circumscribed circle (circumcircle) of a Triangle object. The circumcircle is the circle which touches all of the triangle's vertices.\r\rAdapted from https://gist.github.com/mutoo/5617691", "kind": "function", "name": "CircumCircle", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Circle} O - [out,$return]", "value": "{Phaser.Geom.Circle} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to use as input.", "name": "triangle" }, { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Circle" } }, "optional": true, "description": "An optional Circle to store the result in.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Circle" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021262", "___s": true }, { "comment": "/**\r\n * Clones a Triangle object.\r\n *\r\n * @function Phaser.Geom.Triangle.Clone\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} source - The Triangle to clone.\r\n *\r\n * @return {Phaser.Geom.Triangle} A new Triangle identical to the given one but separate from it.\r\n */", "meta": { "filename": "Clone.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Clones a Triangle object.", "kind": "function", "name": "Clone", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to clone.", "name": "source" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021294", "___s": true }, { "comment": "/**\r\n * Checks if a point (as a pair of coordinates) is inside a Triangle's bounds.\r\n *\r\n * @function Phaser.Geom.Triangle.Contains\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to check.\r\n * @param {number} x - The X coordinate of the point to check.\r\n * @param {number} y - The Y coordinate of the point to check.\r\n *\r\n * @return {boolean} `true` if the point is inside the Triangle, otherwise `false`.\r\n */", "meta": { "filename": "Contains.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to check.", "name": "triangle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the point to check.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the point to check.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the point is inside the Triangle, otherwise `false`." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.Contains", "scope": "static", "___id": "T000002R021297", "___s": true }, { "comment": "/**\r\n * Filters an array of point-like objects to only those contained within a triangle.\r\n * \r\n * If `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).\r\n *\r\n * @function Phaser.Geom.Triangle.ContainsArray\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The triangle that the points are being checked in.\r\n * @param {Phaser.Math.Vector2[]} points - An array of Vector2 objects to check if they are within the triangle.\r\n * @param {boolean} [returnFirst=false] - If `true`, return an array containing only the first point found that is within the triangle.\r\n * @param {array} [out] - 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.\r\n *\r\n * @return {Phaser.Math.Vector2[]} 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.\r\n */", "meta": { "filename": "ContainsArray.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Filters an array of point-like objects to only those contained within a triangle.\r\rIf `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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The triangle that the points are being checked in.", "name": "triangle" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "An array of Vector2 objects to check if they are within the triangle.", "name": "points" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "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", "___id": "T000002R021315", "___s": true }, { "comment": "/**\r\n * Tests if a triangle contains a point.\r\n *\r\n * @function Phaser.Geom.Triangle.ContainsPoint\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The triangle.\r\n * @param {Phaser.Math.Vector2} vec - The Vector2 point to test if it's within the triangle.\r\n *\r\n * @return {boolean} `true` if the point is within the triangle, otherwise `false`.\r\n */", "meta": { "filename": "ContainsPoint.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Tests if a triangle contains a point.", "kind": "function", "name": "ContainsPoint", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The triangle.", "name": "triangle" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The Vector2 point to test if it's within the triangle.", "name": "vec" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the point is within the triangle, otherwise `false`." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.ContainsPoint", "scope": "static", "___id": "T000002R021347", "___s": true }, { "comment": "/**\r\n * Copy the values of one Triangle to a destination Triangle.\r\n *\r\n * @function Phaser.Geom.Triangle.CopyFrom\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Triangle} O - [dest,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} source - The source Triangle to copy the values from.\r\n * @param {Phaser.Geom.Triangle} dest - The destination Triangle to copy the values to.\r\n *\r\n * @return {Phaser.Geom.Triangle} The destination Triangle.\r\n */", "meta": { "filename": "CopyFrom.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Copy the values of one Triangle to a destination Triangle.", "kind": "function", "name": "CopyFrom", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Triangle} O - [dest,$return]", "value": "{Phaser.Geom.Triangle} O - [dest,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The source Triangle to copy the values from.", "name": "source" }, { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The destination Triangle to copy the values to.", "name": "dest" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The destination Triangle." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.CopyFrom", "scope": "static", "___id": "T000002R021350", "___s": true }, { "comment": "/**\r\n * Decomposes a Triangle into an array of its points.\r\n *\r\n * @function Phaser.Geom.Triangle.Decompose\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to decompose.\r\n * @param {array} [out] - An array to store the points into.\r\n *\r\n * @return {array} 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.\r\n */", "meta": { "filename": "Decompose.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Decomposes a Triangle into an array of its points.", "kind": "function", "name": "Decompose", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to decompose.", "name": "triangle" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "optional": true, "description": "An array to store the points into.", "name": "out" } ], "returns": [ { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021353", "___s": true }, { "comment": "/**\r\n * Returns true if two triangles have the same coordinates.\r\n *\r\n * @function Phaser.Geom.Triangle.Equals\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The first triangle to check.\r\n * @param {Phaser.Geom.Triangle} toCompare - The second triangle to check.\r\n *\r\n * @return {boolean} `true` if the two given triangles have the exact same coordinates, otherwise `false`.\r\n */", "meta": { "filename": "Equals.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns true if two triangles have the same coordinates.", "kind": "function", "name": "Equals", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The first triangle to check.", "name": "triangle" }, { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The second triangle to check.", "name": "toCompare" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021363", "___s": true }, { "comment": "/**\r\n * Returns a point along the perimeter of a Triangle as a Vector2, based on a normalized position value.\r\n *\r\n * The `position` parameter is a value between 0 and 1, where 0 and 1 both map to the start of\r\n * line A (the first vertex). The point is calculated by traversing the triangle's perimeter in\r\n * order: line A, then line B, then line C.\r\n *\r\n * @function Phaser.Geom.Triangle.GetPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to get the point on its perimeter from.\r\n * @param {number} position - A normalized value between 0 and 1 representing a position along the triangle's perimeter. Both 0 and 1 return the start of line A.\r\n * @param {Phaser.Math.Vector2} [out] - An optional Vector2 point to store the result in. If not given, a new Vector2 will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 point containing the coordinates of the position on the triangle's perimeter.\r\n */", "meta": { "filename": "GetPoint.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns a point along the perimeter of a Triangle as a Vector2, based on a normalized position value.\r\rThe `position` parameter is a value between 0 and 1, where 0 and 1 both map to the start of\rline A (the first vertex). The point is calculated by traversing the triangle's perimeter in\rorder: line A, then line B, then line C.", "kind": "function", "name": "GetPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to get the point on its perimeter from.", "name": "triangle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A normalized value between 0 and 1 representing a position along the triangle's perimeter. Both 0 and 1 return the start of line A.", "name": "position" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "An optional Vector2 point to store the result in. If not given, a new Vector2 will be created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 point containing the coordinates of the position on the triangle's perimeter." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.GetPoint", "scope": "static", "___id": "T000002R021368", "___s": true }, { "comment": "/**\r\n * Returns an array of evenly spaced points on the perimeter of a Triangle.\r\n *\r\n * The points are placed along the triangle's three edges in order (A, B, then C),\r\n * with their positions calculated proportionally based on the total perimeter length.\r\n *\r\n * @function Phaser.Geom.Triangle.GetPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to get the points from.\r\n * @param {number} quantity - The number of evenly spaced points to return. Set to 0 to return an arbitrary number of points based on the `stepRate`.\r\n * @param {number} stepRate - If `quantity` is 0, the distance in pixels between each returned point along the perimeter.\r\n * @param {Phaser.Math.Vector2[]} [out] - An array to which the points should be appended.\r\n *\r\n * @return {Phaser.Math.Vector2[]} The modified `out` array, or a new array if none was provided.\r\n */", "meta": { "filename": "GetPoints.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns an array of evenly spaced points on the perimeter of a Triangle.\r\rThe points are placed along the triangle's three edges in order (A, B, then C),\rwith their positions calculated proportionally based on the total perimeter length.", "kind": "function", "name": "GetPoints", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to get the points from.", "name": "triangle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "If `quantity` is 0, the distance in pixels between each returned point along the perimeter.", "name": "stepRate" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "An array to which the points should be appended.", "name": "out" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "The modified `out` array, or a new array if none was provided." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.GetPoints", "scope": "static", "___id": "T000002R021396", "___s": true }, { "comment": "/**\r\n * 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.\r\n *\r\n * @function Phaser.Geom.Triangle.InCenter\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to find the incenter of.\r\n * @param {Phaser.Math.Vector2} [out] - An optional Vector2 point in which to store the coordinates.\r\n *\r\n * @return {Phaser.Math.Vector2} The incenter of the triangle in a Vector2.\r\n */", "meta": { "filename": "InCenter.js", "lineno": 21, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to find the incenter of.", "name": "triangle" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "An optional Vector2 point in which to store the coordinates.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The incenter of the triangle in a Vector2." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.InCenter", "scope": "static", "___id": "T000002R021428", "___s": true }, { "comment": "/**\r\n * Moves each point (vertex) of a Triangle by a given offset, thus moving the entire Triangle by that offset.\r\n *\r\n * @function Phaser.Geom.Triangle.Offset\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Triangle} O - [triangle,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to move.\r\n * @param {number} x - The horizontal offset (distance) by which to move each point. Can be positive or negative.\r\n * @param {number} y - The vertical offset (distance) by which to move each point. Can be positive or negative.\r\n *\r\n * @return {Phaser.Geom.Triangle} The modified Triangle.\r\n */", "meta": { "filename": "Offset.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Triangle} O - [triangle,$return]", "value": "{Phaser.Geom.Triangle} O - [triangle,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to move.", "name": "triangle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal offset (distance) by which to move each point. Can be positive or negative.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The modified Triangle." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.Offset", "scope": "static", "___id": "T000002R021470", "___s": true }, { "comment": "/**\r\n * Gets the length of the perimeter of the given triangle.\r\n * Calculated by adding together the length of each of the three sides.\r\n *\r\n * @function Phaser.Geom.Triangle.Perimeter\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to get the length from.\r\n *\r\n * @return {number} The length of the Triangle.\r\n */", "meta": { "filename": "Perimeter.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Gets the length of the perimeter of the given triangle.\rCalculated by adding together the length of each of the three sides.", "kind": "function", "name": "Perimeter", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to get the length from.", "name": "triangle" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The length of the Triangle." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.Perimeter", "scope": "static", "___id": "T000002R021480", "___s": true }, { "comment": "/**\r\n * Returns a random Point from within the area of the given Triangle.\r\n *\r\n * @function Phaser.Geom.Triangle.Random\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [out,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to get a random point from.\r\n * @param {Phaser.Math.Vector2} [out] - The Vector2 point object to store the position in. If not given, a new Vector2 instance is created.\r\n *\r\n * @return {Phaser.Math.Vector2} A Vector2 point object holding the coordinates of a random position within the Triangle.\r\n */", "meta": { "filename": "Random.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns a random Point from within the area of the given Triangle.", "kind": "function", "name": "Random", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [out,$return]", "value": "{Phaser.Math.Vector2} O - [out,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to get a random point from.", "name": "triangle" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "The Vector2 point object to store the position in. If not given, a new Vector2 instance is created.", "name": "out" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "A Vector2 point object holding the coordinates of a random position within the Triangle." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.Random", "scope": "static", "___id": "T000002R021487", "___s": true }, { "comment": "/**\r\n * Rotates a Triangle about its incenter, which is the point at which its three angle bisectors meet.\r\n *\r\n * @function Phaser.Geom.Triangle.Rotate\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Triangle} O - [triangle,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to rotate.\r\n * @param {number} angle - The angle by which to rotate the Triangle, in radians.\r\n *\r\n * @return {Phaser.Geom.Triangle} The rotated Triangle.\r\n */", "meta": { "filename": "Rotate.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "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", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Triangle} O - [triangle,$return]", "value": "{Phaser.Geom.Triangle} O - [triangle,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to rotate.", "name": "triangle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle by which to rotate the Triangle, in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The rotated Triangle." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.Rotate", "scope": "static", "___id": "T000002R021503", "___s": true }, { "comment": "/**\r\n * Rotates a Triangle at a certain angle about a given Vector2 point.\r\n *\r\n * @function Phaser.Geom.Triangle.RotateAroundPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Triangle} O - [triangle,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to rotate.\r\n * @param {Phaser.Math.Vector2} point - The Vector2 point to rotate the Triangle around.\r\n * @param {number} angle - The angle by which to rotate the Triangle, in radians.\r\n *\r\n * @return {Phaser.Geom.Triangle} The rotated Triangle.\r\n */", "meta": { "filename": "RotateAroundPoint.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Rotates a Triangle at a certain angle about a given Vector2 point.", "kind": "function", "name": "RotateAroundPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Triangle} O - [triangle,$return]", "value": "{Phaser.Geom.Triangle} O - [triangle,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to rotate.", "name": "triangle" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "The Vector2 point to rotate the Triangle around.", "name": "point" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle by which to rotate the Triangle, in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The rotated Triangle." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.RotateAroundPoint", "scope": "static", "___id": "T000002R021508", "___s": true }, { "comment": "/**\r\n * Rotates an entire Triangle at a given angle about a specific point.\r\n *\r\n * @function Phaser.Geom.Triangle.RotateAroundXY\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Triangle} O - [triangle,$return]\r\n *\r\n * @param {Phaser.Geom.Triangle} triangle - The Triangle to rotate.\r\n * @param {number} x - The X coordinate of the point to rotate the Triangle about.\r\n * @param {number} y - The Y coordinate of the point to rotate the Triangle about.\r\n * @param {number} angle - The angle by which to rotate the Triangle, in radians.\r\n *\r\n * @return {Phaser.Geom.Triangle} The rotated Triangle.\r\n */", "meta": { "filename": "RotateAroundXY.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Rotates an entire Triangle at a given angle about a specific point.", "kind": "function", "name": "RotateAroundXY", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Triangle} O - [triangle,$return]", "value": "{Phaser.Geom.Triangle} O - [triangle,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The Triangle to rotate.", "name": "triangle" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The X coordinate of the point to rotate the Triangle about.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Y coordinate of the point to rotate the Triangle about.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle by which to rotate the Triangle, in radians.", "name": "angle" } ], "returns": [ { "type": { "names": [ "Phaser.Geom.Triangle" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Geom.Triangle" } }, "description": "The rotated Triangle." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle.RotateAroundXY", "scope": "static", "___id": "T000002R021511", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Triangle is a closed polygon defined by three vertices in 2D space, useful for hit testing,\r\n * defining spawn or trigger regions, and geometric calculations. It is a geometry object only —\r\n * not a Game Object — and cannot be rendered directly. To draw a Triangle to the screen, pass it\r\n * to a Graphics Game Object's `strokeTriangleShape` or `fillTriangleShape` method.\r\n *\r\n * The three vertices are stored as coordinate pairs (`x1`,`y1`), (`x2`,`y2`), and (`x3`,`y3`).\r\n * All coordinates default to `0` if not provided.\r\n *\r\n * @class Triangle\r\n * @memberof Phaser.Geom\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x1=0] - `x` coordinate of the first point.\r\n * @param {number} [y1=0] - `y` coordinate of the first point.\r\n * @param {number} [x2=0] - `x` coordinate of the second point.\r\n * @param {number} [y2=0] - `y` coordinate of the second point.\r\n * @param {number} [x3=0] - `x` coordinate of the third point.\r\n * @param {number} [y3=0] - `y` coordinate of the third point.\r\n */", "meta": { "filename": "Triangle.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "classdesc": "A Triangle is a closed polygon defined by three vertices in 2D space, useful for hit testing,\rdefining spawn or trigger regions, and geometric calculations. It is a geometry object only —\rnot a Game Object — and cannot be rendered directly. To draw a Triangle to the screen, pass it\rto a Graphics Game Object's `strokeTriangleShape` or `fillTriangleShape` method.\r\rThe three vertices are stored as coordinate pairs (`x1`,`y1`), (`x2`,`y2`), and (`x3`,`y3`).\rAll coordinates default to `0` if not provided.", "kind": "class", "name": "Triangle", "memberof": "Phaser.Geom", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "`x` coordinate of the first point.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "`y` coordinate of the first point.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "`x` coordinate of the second point.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "`y` coordinate of the second point.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "`x` coordinate of the third point.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "`y` coordinate of the third point.", "name": "y3" } ], "scope": "static", "longname": "Phaser.Geom.Triangle", "___id": "T000002R021535", "___s": true }, { "comment": "/**\r\n * The geometry constant type of this object: `GEOM_CONST.TRIANGLE`.\r\n * Used for fast type comparisons.\r\n *\r\n * @name Phaser.Geom.Triangle#type\r\n * @type {number}\r\n * @readonly\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Triangle.js", "lineno": 50, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "The geometry constant type of this object: `GEOM_CONST.TRIANGLE`.\rUsed for fast type comparisons.", "name": "type", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.19.0", "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#type", "scope": "instance", "kind": "member", "___id": "T000002R021544", "___s": true }, { "comment": "/**\r\n * `x` coordinate of the first point.\r\n *\r\n * @name Phaser.Geom.Triangle#x1\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Triangle.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "`x` coordinate of the first point.", "name": "x1", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#x1", "scope": "instance", "kind": "member", "___id": "T000002R021546", "___s": true }, { "comment": "/**\r\n * `y` coordinate of the first point.\r\n *\r\n * @name Phaser.Geom.Triangle#y1\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Triangle.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "`y` coordinate of the first point.", "name": "y1", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#y1", "scope": "instance", "kind": "member", "___id": "T000002R021548", "___s": true }, { "comment": "/**\r\n * `x` coordinate of the second point.\r\n *\r\n * @name Phaser.Geom.Triangle#x2\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Triangle.js", "lineno": 81, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "`x` coordinate of the second point.", "name": "x2", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#x2", "scope": "instance", "kind": "member", "___id": "T000002R021550", "___s": true }, { "comment": "/**\r\n * `y` coordinate of the second point.\r\n *\r\n * @name Phaser.Geom.Triangle#y2\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Triangle.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "`y` coordinate of the second point.", "name": "y2", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#y2", "scope": "instance", "kind": "member", "___id": "T000002R021552", "___s": true }, { "comment": "/**\r\n * `x` coordinate of the third point.\r\n *\r\n * @name Phaser.Geom.Triangle#x3\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Triangle.js", "lineno": 101, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "`x` coordinate of the third point.", "name": "x3", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#x3", "scope": "instance", "kind": "member", "___id": "T000002R021554", "___s": true }, { "comment": "/**\r\n * `y` coordinate of the third point.\r\n *\r\n * @name Phaser.Geom.Triangle#y3\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Triangle.js", "lineno": 111, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "`y` coordinate of the third point.", "name": "y3", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#y3", "scope": "instance", "kind": "member", "___id": "T000002R021556", "___s": true }, { "comment": "/**\r\n * Checks whether a given point lies within the triangle.\r\n *\r\n * @method Phaser.Geom.Triangle#contains\r\n * @since 3.0.0\r\n *\r\n * @param {number} x - The x coordinate of the point to check.\r\n * @param {number} y - The y coordinate of the point to check.\r\n *\r\n * @return {boolean} `true` if the coordinate pair is within the triangle, otherwise `false`.\r\n */", "meta": { "filename": "Triangle.js", "lineno": 122, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Checks whether a given point lies within the triangle.", "kind": "function", "name": "contains", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the point to check.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the point to check.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the coordinate pair is within the triangle, otherwise `false`." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#contains", "scope": "instance", "___id": "T000002R021558", "___s": true }, { "comment": "/**\r\n * Returns a point at a given normalized position along the perimeter of the triangle.\r\n *\r\n * @method Phaser.Geom.Triangle#getPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [output,$return]\r\n *\r\n * @param {number} position - Position as float within `0` and `1`. `0` equals the first point.\r\n * @param {Phaser.Math.Vector2} [output] - Optional Vector2 point that the calculated point will be written to.\r\n *\r\n * @return {Phaser.Math.Vector2} Calculated Vector2 that represents the requested position. It is the same as `output` when this parameter has been given.\r\n */", "meta": { "filename": "Triangle.js", "lineno": 138, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns a point at a given normalized position along the perimeter of the triangle.", "kind": "function", "name": "getPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [output,$return]", "value": "{Phaser.Math.Vector2} O - [output,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "Position as float within `0` and `1`. `0` equals the first point.", "name": "position" }, { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "Optional Vector2 point that the calculated point will be written to.", "name": "output" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "Calculated Vector2 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", "___id": "T000002R021560", "___s": true }, { "comment": "/**\r\n * Calculates a list of evenly distributed points along the perimeter of the triangle. Either pass the number of points to generate (`quantity`) or the distance between consecutive points (`stepRate`).\r\n *\r\n * @method Phaser.Geom.Triangle#getPoints\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2[]} O - [output,$return]\r\n *\r\n * @param {number} quantity - Number of points to be generated. Can be falsey when `stepRate` should be used. All points have the same distance along the triangle.\r\n * @param {number} [stepRate] - Distance between two points. Will only be used when `quantity` is falsey.\r\n * @param {Phaser.Math.Vector2[]} [output] - Optional array of Vector2 points for writing the calculated points into. Otherwise a new array will be created.\r\n *\r\n * @return {Phaser.Math.Vector2[]} Returns a list of calculated `Vector2` instances or the filled array passed as parameter `output`.\r\n */", "meta": { "filename": "Triangle.js", "lineno": 156, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Calculates a list of evenly distributed points along the perimeter of the triangle. Either pass the number of points to generate (`quantity`) or the distance between consecutive points (`stepRate`).", "kind": "function", "name": "getPoints", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2[]} O - [output,$return]", "value": "{Phaser.Math.Vector2[]} O - [output,$return]" } ], "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "description": "Distance between two points. Will only be used when `quantity` is falsey.", "name": "stepRate" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "optional": true, "description": "Optional array of Vector2 points for writing the calculated points into. Otherwise a new array will be created.", "name": "output" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Math.Vector2", "type": "NameExpression" } ] } }, "description": "Returns a list of calculated `Vector2` instances or the filled array passed as parameter `output`." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#getPoints", "scope": "instance", "___id": "T000002R021562", "___s": true }, { "comment": "/**\r\n * Returns a random point from within the area of the triangle.\r\n *\r\n * @method Phaser.Geom.Triangle#getRandomPoint\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Math.Vector2} O - [point,$return]\r\n *\r\n * @param {Phaser.Math.Vector2} [vec] - Optional Vector2 point that will be modified. Otherwise a new one will be created.\r\n *\r\n * @return {Phaser.Math.Vector2} Random Vector2. When parameter `vec` has been provided it will be returned.\r\n */", "meta": { "filename": "Triangle.js", "lineno": 175, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns a random point from within the area of the triangle.", "kind": "function", "name": "getRandomPoint", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Math.Vector2} O - [point,$return]", "value": "{Phaser.Math.Vector2} O - [point,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "optional": true, "description": "Optional Vector2 point that will be modified. Otherwise a new one will be created.", "name": "vec" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "description": "Random Vector2. When parameter `vec` has been provided it will be returned." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#getRandomPoint", "scope": "instance", "___id": "T000002R021564", "___s": true }, { "comment": "/**\r\n * Sets all three points of the triangle. Leaving out any coordinate sets it to be `0`.\r\n *\r\n * @method Phaser.Geom.Triangle#setTo\r\n * @since 3.0.0\r\n *\r\n * @param {number} [x1=0] - `x` coordinate of the first point.\r\n * @param {number} [y1=0] - `y` coordinate of the first point.\r\n * @param {number} [x2=0] - `x` coordinate of the second point.\r\n * @param {number} [y2=0] - `y` coordinate of the second point.\r\n * @param {number} [x3=0] - `x` coordinate of the third point.\r\n * @param {number} [y3=0] - `y` coordinate of the third point.\r\n *\r\n * @return {this} This Triangle object.\r\n */", "meta": { "filename": "Triangle.js", "lineno": 192, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "`x` coordinate of the first point.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "`y` coordinate of the first point.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "`x` coordinate of the second point.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "`y` coordinate of the second point.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "`x` coordinate of the third point.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 0, "description": "`y` coordinate of the third point.", "name": "y3" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Triangle object." } ], "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#setTo", "scope": "instance", "___id": "T000002R021566", "___s": true }, { "comment": "/**\r\n * Returns a Line object that corresponds to Line A of this Triangle, running from vertex 1 (`x1`, `y1`) to vertex 2 (`x2`, `y2`).\r\n *\r\n * @method Phaser.Geom.Triangle#getLineA\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Line} O - [line,$return]\r\n *\r\n * @param {Phaser.Geom.Line} [line] - A Line object to set the results in. If `undefined` a new Line will be created.\r\n *\r\n * @return {Phaser.Geom.Line} A Line object that corresponds to line A of this Triangle.\r\n */", "meta": { "filename": "Triangle.js", "lineno": 228, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns a Line object that corresponds to Line A of this Triangle, running from vertex 1 (`x1`, `y1`) to vertex 2 (`x2`, `y2`).", "kind": "function", "name": "getLineA", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Line} O - [line,$return]", "value": "{Phaser.Geom.Line} O - [line,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021580", "___s": true }, { "comment": "/**\r\n * Returns a Line object that corresponds to Line B of this Triangle, running from vertex 2 (`x2`, `y2`) to vertex 3 (`x3`, `y3`).\r\n *\r\n * @method Phaser.Geom.Triangle#getLineB\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Line} O - [line,$return]\r\n *\r\n * @param {Phaser.Geom.Line} [line] - A Line object to set the results in. If `undefined` a new Line will be created.\r\n *\r\n * @return {Phaser.Geom.Line} A Line object that corresponds to line B of this Triangle.\r\n */", "meta": { "filename": "Triangle.js", "lineno": 249, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns a Line object that corresponds to Line B of this Triangle, running from vertex 2 (`x2`, `y2`) to vertex 3 (`x3`, `y3`).", "kind": "function", "name": "getLineB", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Line} O - [line,$return]", "value": "{Phaser.Geom.Line} O - [line,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021583", "___s": true }, { "comment": "/**\r\n * Returns a Line object that corresponds to Line C of this Triangle, running from vertex 3 (`x3`, `y3`) back to vertex 1 (`x1`, `y1`), closing the shape.\r\n *\r\n * @method Phaser.Geom.Triangle#getLineC\r\n * @since 3.0.0\r\n *\r\n * @generic {Phaser.Geom.Line} O - [line,$return]\r\n *\r\n * @param {Phaser.Geom.Line} [line] - A Line object to set the results in. If `undefined` a new Line will be created.\r\n *\r\n * @return {Phaser.Geom.Line} A Line object that corresponds to line C of this Triangle.\r\n */", "meta": { "filename": "Triangle.js", "lineno": 270, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Returns a Line object that corresponds to Line C of this Triangle, running from vertex 3 (`x3`, `y3`) back to vertex 1 (`x1`, `y1`), closing the shape.", "kind": "function", "name": "getLineC", "since": "3.0.0", "tags": [ { "originalTitle": "generic", "title": "generic", "text": "{Phaser.Geom.Line} O - [line,$return]", "value": "{Phaser.Geom.Line} O - [line,$return]" } ], "params": [ { "type": { "names": [ "Phaser.Geom.Line" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021586", "___s": true }, { "comment": "/**\r\n * Left most X coordinate of the triangle. Setting it moves the triangle on the X axis accordingly.\r\n *\r\n * @name Phaser.Geom.Triangle#left\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Triangle.js", "lineno": 291, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Left most X coordinate of the triangle. Setting it moves the triangle on the X axis accordingly.", "name": "left", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#left", "scope": "instance", "kind": "member", "___id": "T000002R021589", "___s": true }, { "comment": "/**\r\n * Right most X coordinate of the triangle. Setting it moves the triangle on the X axis accordingly.\r\n *\r\n * @name Phaser.Geom.Triangle#right\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Triangle.js", "lineno": 329, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Right most X coordinate of the triangle. Setting it moves the triangle on the X axis accordingly.", "name": "right", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#right", "scope": "instance", "kind": "member", "___id": "T000002R021600", "___s": true }, { "comment": "/**\r\n * Top most Y coordinate of the triangle. Setting it moves the triangle on the Y axis accordingly.\r\n *\r\n * @name Phaser.Geom.Triangle#top\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Triangle.js", "lineno": 367, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Top most Y coordinate of the triangle. Setting it moves the triangle on the Y axis accordingly.", "name": "top", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#top", "scope": "instance", "kind": "member", "___id": "T000002R021611", "___s": true }, { "comment": "/**\r\n * Bottom most Y coordinate of the triangle. Setting it moves the triangle on the Y axis accordingly.\r\n *\r\n * @name Phaser.Geom.Triangle#bottom\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Triangle.js", "lineno": 405, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\geom\\triangle", "code": {} }, "description": "Bottom most Y coordinate of the triangle. Setting it moves the triangle on the Y axis accordingly.", "name": "bottom", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Geom.Triangle", "longname": "Phaser.Geom.Triangle#bottom", "scope": "instance", "kind": "member", "___id": "T000002R021622", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Geom\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\geom\\typedefs", "code": {} }, "kind": "namespace", "name": "Geom", "memberof": "Phaser.Types", "longname": "Phaser.Types.Geom", "scope": "static", "___id": "T000002R021634", "___s": true }, { "comment": "/**\r\n * The mouse pointer button has been pressed down.\r\n *\r\n * @name Phaser.Input.MOUSE_DOWN\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "const.js", "lineno": 9, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The mouse pointer button has been pressed down.", "name": "MOUSE_DOWN", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Input", "longname": "Phaser.Input.MOUSE_DOWN", "scope": "static", "kind": "member", "___id": "T000002R021636", "___s": true }, { "comment": "/**\r\n * The mouse pointer is being moved.\r\n *\r\n * @name Phaser.Input.MOUSE_MOVE\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "const.js", "lineno": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The mouse pointer is being moved.", "name": "MOUSE_MOVE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Input", "longname": "Phaser.Input.MOUSE_MOVE", "scope": "static", "kind": "member", "___id": "T000002R021638", "___s": true }, { "comment": "/**\r\n * The mouse pointer is released.\r\n *\r\n * @name Phaser.Input.MOUSE_UP\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "const.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The mouse pointer is released.", "name": "MOUSE_UP", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Input", "longname": "Phaser.Input.MOUSE_UP", "scope": "static", "kind": "member", "___id": "T000002R021640", "___s": true }, { "comment": "/**\r\n * A touch pointer has been started.\r\n *\r\n * @name Phaser.Input.TOUCH_START\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "const.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A touch pointer has been started.", "name": "TOUCH_START", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Input", "longname": "Phaser.Input.TOUCH_START", "scope": "static", "kind": "member", "___id": "T000002R021642", "___s": true }, { "comment": "/**\r\n * A touch pointer has been moved.\r\n *\r\n * @name Phaser.Input.TOUCH_MOVE\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "const.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A touch pointer has been moved.", "name": "TOUCH_MOVE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Input", "longname": "Phaser.Input.TOUCH_MOVE", "scope": "static", "kind": "member", "___id": "T000002R021644", "___s": true }, { "comment": "/**\r\n * A touch pointer has ended.\r\n *\r\n * @name Phaser.Input.TOUCH_END\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "const.js", "lineno": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A touch pointer has ended.", "name": "TOUCH_END", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Input", "longname": "Phaser.Input.TOUCH_END", "scope": "static", "kind": "member", "___id": "T000002R021646", "___s": true }, { "comment": "/**\r\n * The pointer lock has changed.\r\n *\r\n * @name Phaser.Input.POINTER_LOCK_CHANGE\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "const.js", "lineno": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The pointer lock has changed.", "name": "POINTER_LOCK_CHANGE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Input", "longname": "Phaser.Input.POINTER_LOCK_CHANGE", "scope": "static", "kind": "member", "___id": "T000002R021648", "___s": true }, { "comment": "/**\r\n * A touch pointer has been cancelled by the browser.\r\n *\r\n * @name Phaser.Input.TOUCH_CANCEL\r\n * @type {number}\r\n * @since 3.15.0\r\n */", "meta": { "filename": "const.js", "lineno": 72, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A touch pointer has been cancelled by the browser.", "name": "TOUCH_CANCEL", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.15.0", "memberof": "Phaser.Input", "longname": "Phaser.Input.TOUCH_CANCEL", "scope": "static", "kind": "member", "___id": "T000002R021650", "___s": true }, { "comment": "/**\r\n * The mouse wheel has changed.\r\n *\r\n * @name Phaser.Input.MOUSE_WHEEL\r\n * @type {number}\r\n * @since 3.18.0\r\n */", "meta": { "filename": "const.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The mouse wheel has changed.", "name": "MOUSE_WHEEL", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.18.0", "memberof": "Phaser.Input", "longname": "Phaser.Input.MOUSE_WHEEL", "scope": "static", "kind": "member", "___id": "T000002R021652", "___s": true }, { "comment": "/**\r\n * Creates a new Interactive Object.\r\n *\r\n * An Interactive Object is a plain data object that stores all of the input-related state for\r\n * a Game Object. This includes its hit area geometry, drag state, local pointer coordinates,\r\n * and references to the camera and any drop zone target. It is not a class instance, but a\r\n * plain object literal returned by this function.\r\n *\r\n * This is called automatically by the Input Manager when you enable a Game Object for input.\r\n *\r\n * The resulting Interactive Object is mapped to the Game Object's `input` property.\r\n *\r\n * @function Phaser.Input.CreateInteractiveObject\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to which this Interactive Object is bound.\r\n * @param {any} hitArea - The hit area for this Interactive Object. Typically a geometry shape, like a Rectangle or Circle.\r\n * @param {Phaser.Types.Input.HitAreaCallback} hitAreaCallback - The 'contains' check callback that the hit area shape will use for all hit tests.\r\n *\r\n * @return {Phaser.Types.Input.InteractiveObject} The new Interactive Object.\r\n */", "meta": { "filename": "CreateInteractiveObject.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Creates a new Interactive Object.\r\rAn Interactive Object is a plain data object that stores all of the input-related state for\ra Game Object. This includes its hit area geometry, drag state, local pointer coordinates,\rand references to the camera and any drop zone target. It is not a class instance, but a\rplain object literal returned by this function.\r\rThis is called automatically by the Input Manager when you enable a Game Object for input.\r\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to which this Interactive Object is bound.", "name": "gameObject" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.InteractiveObject" } }, "description": "The new Interactive Object." } ], "memberof": "Phaser.Input", "longname": "Phaser.Input.CreateInteractiveObject", "scope": "static", "___id": "T000002R021655", "___s": true }, { "comment": "/**\r\n * Creates a new Pixel Perfect Handler function.\r\n *\r\n * Pixel perfect hit detection tests the alpha value of the specific pixel at the point\r\n * of interaction on a Game Object's texture, rather than relying solely on its bounding\r\n * box or hit area geometry. This allows fully transparent regions of a sprite to be\r\n * correctly ignored during pointer and overlap checks, at the cost of a texture lookup\r\n * per test.\r\n *\r\n * Access via `InputPlugin.makePixelPerfect` rather than calling it directly.\r\n *\r\n * @function Phaser.Input.CreatePixelPerfectHandler\r\n * @since 3.10.0\r\n *\r\n * @param {Phaser.Textures.TextureManager} textureManager - A reference to the Texture Manager.\r\n * @param {number} alphaTolerance - The alpha level that the pixel must be at or above to be counted as a successful interaction.\r\n *\r\n * @return {function} The new Pixel Perfect Handler function.\r\n */", "meta": { "filename": "CreatePixelPerfectHandler.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Creates a new Pixel Perfect Handler function.\r\rPixel perfect hit detection tests the alpha value of the specific pixel at the point\rof interaction on a Game Object's texture, rather than relying solely on its bounding\rbox or hit area geometry. This allows fully transparent regions of a sprite to be\rcorrectly ignored during pointer and overlap checks, at the cost of a texture lookup\rper test.\r\rAccess via `InputPlugin.makePixelPerfect` rather than calling it directly.", "kind": "function", "name": "CreatePixelPerfectHandler", "since": "3.10.0", "params": [ { "type": { "names": [ "Phaser.Textures.TextureManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } }, "description": "A reference to the Texture Manager.", "name": "textureManager" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The alpha level that the pixel must be at or above to be counted as a successful interaction.", "name": "alphaTolerance" } ], "returns": [ { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The new Pixel Perfect Handler function." } ], "memberof": "Phaser.Input", "longname": "Phaser.Input.CreatePixelPerfectHandler", "scope": "static", "___id": "T000002R021679", "___s": true }, { "comment": "/**\r\n * The Input Plugin Boot Event.\r\n *\r\n * This internal event is dispatched by the Input Plugin when it boots, signalling to all of its systems to create themselves.\r\n *\r\n * @event Phaser.Input.Events#BOOT\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "BOOT_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Input Plugin Boot Event.\r\rThis internal event is dispatched by the Input Plugin when it boots, signalling to all of its systems to create themselves.", "kind": "event", "name": "BOOT", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Input.Events", "longname": "Phaser.Input.Events#event:BOOT", "scope": "instance", "___id": "T000002R021683", "___s": true }, { "comment": "/**\r\n * The Input Plugin Destroy Event.\r\n *\r\n * This internal event is dispatched by the Input Plugin when it is destroyed, signalling to all of its systems to destroy themselves.\r\n *\r\n * @event Phaser.Input.Events#DESTROY\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "DESTROY_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Input Plugin Destroy Event.\r\rThis 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Input.Events", "longname": "Phaser.Input.Events#event:DESTROY", "scope": "instance", "___id": "T000002R021685", "___s": true }, { "comment": "/**\r\n * The Pointer Drag End Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer stops dragging a Game Object.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('dragend', listener)`.\r\n *\r\n * To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_END]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_END} event instead.\r\n *\r\n * @event Phaser.Input.Events#DRAG_END\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The interactive Game Object that this pointer stopped dragging.\r\n * @param {boolean} dropped - Whether the Game Object was dropped onto a target.\r\n */", "meta": { "filename": "DRAG_END_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Drag End Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer stops dragging a Game Object.\r\rListen to this event from within a Scene using: `this.input.on('dragend', listener)`.\r\rTo 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The interactive Game Object that this pointer stopped dragging.", "name": "gameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the Game Object was dropped onto a target.", "name": "dropped" } ], "memberof": "Phaser.Input.Events", "longname": "Phaser.Input.Events#event:DRAG_END", "scope": "instance", "___id": "T000002R021687", "___s": true }, { "comment": "/**\r\n * The Pointer Drag Enter Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer drags a Game Object into a Drag Target.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('dragenter', listener)`.\r\n *\r\n * A Pointer can only drag a single Game Object at once.\r\n *\r\n * To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_ENTER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_ENTER} event instead.\r\n *\r\n * @event Phaser.Input.Events#DRAG_ENTER\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The interactive Game Object that this pointer is dragging.\r\n * @param {Phaser.GameObjects.GameObject} target - The drag target that this pointer has moved into.\r\n */", "meta": { "filename": "DRAG_ENTER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Drag Enter Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer drags a Game Object into a Drag Target.\r\rListen to this event from within a Scene using: `this.input.on('dragenter', listener)`.\r\rA Pointer can only drag a single Game Object at once.\r\rTo 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The interactive Game Object that this pointer is dragging.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021689", "___s": true }, { "comment": "/**\r\n * The Pointer Drag Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer moves while dragging a Game Object.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('drag', listener)`.\r\n *\r\n * A Pointer can only drag a single Game Object at once.\r\n *\r\n * To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG} event instead.\r\n *\r\n * @event Phaser.Input.Events#DRAG\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The interactive Game Object that this pointer is dragging.\r\n * @param {number} dragX - The x coordinate where the Pointer is currently dragging the Game Object, in world space.\r\n * @param {number} dragY - The y coordinate where the Pointer is currently dragging the Game Object, in world space.\r\n */", "meta": { "filename": "DRAG_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Drag Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves while dragging a Game Object.\r\rListen to this event from within a Scene using: `this.input.on('drag', listener)`.\r\rA Pointer can only drag a single Game Object at once.\r\rTo 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The interactive Game Object that this pointer is dragging.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate where the Pointer is currently dragging the Game Object, in world space.", "name": "dragX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021691", "___s": true }, { "comment": "/**\r\n * The Pointer Drag Leave Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer drags a Game Object out of a Drag Target.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('dragleave', listener)`.\r\n *\r\n * A Pointer can only drag a single Game Object at once.\r\n *\r\n * To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_LEAVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_LEAVE} event instead.\r\n *\r\n * @event Phaser.Input.Events#DRAG_LEAVE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The interactive Game Object that this pointer is dragging.\r\n * @param {Phaser.GameObjects.GameObject} target - The drag target that this pointer has left.\r\n */", "meta": { "filename": "DRAG_LEAVE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Drag Leave Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer drags a Game Object out of a Drag Target.\r\rListen to this event from within a Scene using: `this.input.on('dragleave', listener)`.\r\rA Pointer can only drag a single Game Object at once.\r\rTo 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The interactive Game Object that this pointer is dragging.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021693", "___s": true }, { "comment": "/**\r\n * The Pointer Drag Over Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer drags a Game Object over a Drag Target.\r\n *\r\n * When the Game Object first enters the drag target it will emit a `dragenter` event. If it then moves while within\r\n * the drag target, it will emit this event instead.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('dragover', listener)`.\r\n *\r\n * A Pointer can only drag a single Game Object at once.\r\n *\r\n * To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_OVER} event instead.\r\n *\r\n * @event Phaser.Input.Events#DRAG_OVER\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The interactive Game Object that this pointer is dragging.\r\n * @param {Phaser.GameObjects.GameObject} target - The drag target that this pointer has moved over.\r\n */", "meta": { "filename": "DRAG_OVER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Drag Over Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer drags a Game Object over a Drag Target.\r\rWhen the Game Object first enters the drag target it will emit a `dragenter` event. If it then moves while within\rthe drag target, it will emit this event instead.\r\rListen to this event from within a Scene using: `this.input.on('dragover', listener)`.\r\rA Pointer can only drag a single Game Object at once.\r\rTo 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The interactive Game Object that this pointer is dragging.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021695", "___s": true }, { "comment": "/**\r\n * The Pointer Drag Start Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer starts to drag any Game Object.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('dragstart', listener)`.\r\n *\r\n * A Pointer can only drag a single Game Object at once.\r\n *\r\n * To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DRAG_START]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DRAG_START} event instead.\r\n *\r\n * @event Phaser.Input.Events#DRAG_START\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The interactive Game Object that this pointer is dragging.\r\n */", "meta": { "filename": "DRAG_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Drag Start Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer starts to drag any Game Object.\r\rListen to this event from within a Scene using: `this.input.on('dragstart', listener)`.\r\rA Pointer can only drag a single Game Object at once.\r\rTo 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021697", "___s": true }, { "comment": "/**\r\n * The Pointer Drop Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer drops a Game Object on a Drag Target.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('drop', listener)`.\r\n *\r\n * To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_DROP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DROP} event instead.\r\n *\r\n * @event Phaser.Input.Events#DROP\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The interactive Game Object that this pointer was dragging.\r\n * @param {Phaser.GameObjects.GameObject} target - The Drag Target the `gameObject` has been dropped on.\r\n */", "meta": { "filename": "DROP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Drop Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer drops a Game Object on a Drag Target.\r\rListen to this event from within a Scene using: `this.input.on('drop', listener)`.\r\rTo 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The interactive Game Object that this pointer was dragging.", "name": "gameObject" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021699", "___s": true }, { "comment": "/**\r\n * The Game Object Down Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer is pressed down on _any_ interactive Game Object.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('gameobjectdown', listener)`.\r\n *\r\n * To receive this event, the Game Objects must have been set as interactive.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN} event instead.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\r\n * 2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\r\n * 3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_DOWN\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object the pointer was pressed down on.\r\n * @param {Phaser.Types.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.\r\n */", "meta": { "filename": "GAMEOBJECT_DOWN_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Down Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is pressed down on _any_ interactive Game Object.\r\rListen to this event from within a Scene using: `this.input.on('gameobjectdown', listener)`.\r\rTo receive this event, the Game Objects must have been set as interactive.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\rTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN} event instead.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\r2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\r3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "GAMEOBJECT_DOWN", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object the pointer was pressed down on.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Types.Input.EventData" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021701", "___s": true }, { "comment": "/**\r\n * The Game Object Drag End Event.\r\n *\r\n * This event is dispatched by an interactive Game Object if a pointer stops dragging it.\r\n *\r\n * Listen to this event from a Game Object using: `gameObject.on('dragend', listener)`.\r\n * Note that the scope of the listener is automatically set to be the Game Object instance itself.\r\n *\r\n * To receive this event, the Game Object must have been set as interactive and enabled for drag.\r\n * See [GameObject.setInteractive](Phaser.GameObjects.GameObject#setInteractive) for more details.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_DRAG_END\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {number} dragX - The x coordinate where the Pointer stopped dragging the Game Object, in world space.\r\n * @param {number} dragY - The y coordinate where the Pointer stopped dragging the Game Object, in world space.\r\n * @param {boolean} dropped - Whether the Game Object was dropped onto a target.\r\n */", "meta": { "filename": "GAMEOBJECT_DRAG_END_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Drag End Event.\r\rThis event is dispatched by an interactive Game Object if a pointer stops dragging it.\r\rListen to this event from a Game Object using: `gameObject.on('dragend', listener)`.\rNote that the scope of the listener is automatically set to be the Game Object instance itself.\r\rTo receive this event, the Game Object must have been set as interactive and enabled for drag.\rSee [GameObject.setInteractive](Phaser.GameObjects.GameObject#setInteractive) for more details.", "kind": "event", "name": "GAMEOBJECT_DRAG_END", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate where the Pointer stopped dragging the Game Object, in world space.", "name": "dragX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate where the Pointer stopped dragging the Game Object, in world space.", "name": "dragY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Whether the Game Object was dropped onto a target.", "name": "dropped" } ], "memberof": "Phaser.Input.Events", "longname": "Phaser.Input.Events#event:GAMEOBJECT_DRAG_END", "scope": "instance", "___id": "T000002R021703", "___s": true }, { "comment": "/**\r\n * The Game Object Drag Enter Event.\r\n *\r\n * This event is dispatched by an interactive Game Object if a pointer drags it into a drag target.\r\n *\r\n * Listen to this event from a Game Object using: `gameObject.on('dragenter', listener)`.\r\n * Note that the scope of the listener is automatically set to be the Game Object instance itself.\r\n *\r\n * To receive this event, the Game Object must have been set as interactive and enabled for drag.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_DRAG_ENTER\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} target - The drag target that this pointer has moved into.\r\n */", "meta": { "filename": "GAMEOBJECT_DRAG_ENTER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Drag Enter Event.\r\rThis event is dispatched by an interactive Game Object if a pointer drags it into a drag target.\r\rListen to this event from a Game Object using: `gameObject.on('dragenter', listener)`.\rNote that the scope of the listener is automatically set to be the Game Object instance itself.\r\rTo receive this event, the Game Object must have been set as interactive and enabled for drag.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.", "kind": "event", "name": "GAMEOBJECT_DRAG_ENTER", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021705", "___s": true }, { "comment": "/**\r\n * The Game Object Drag Event.\r\n *\r\n * This event is dispatched by an interactive Game Object if a pointer moves while dragging it.\r\n *\r\n * Listen to this event from a Game Object using: `gameObject.on('drag', listener)`.\r\n * Note that the scope of the listener is automatically set to be the Game Object instance itself.\r\n *\r\n * To receive this event, the Game Object must have been set as interactive and enabled for drag.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_DRAG\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {number} dragX - The x coordinate where the Pointer is currently dragging the Game Object, in world space.\r\n * @param {number} dragY - The y coordinate where the Pointer is currently dragging the Game Object, in world space.\r\n */", "meta": { "filename": "GAMEOBJECT_DRAG_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Drag Event.\r\rThis event is dispatched by an interactive Game Object if a pointer moves while dragging it.\r\rListen to this event from a Game Object using: `gameObject.on('drag', listener)`.\rNote that the scope of the listener is automatically set to be the Game Object instance itself.\r\rTo receive this event, the Game Object must have been set as interactive and enabled for drag.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.", "kind": "event", "name": "GAMEOBJECT_DRAG", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate where the Pointer is currently dragging the Game Object, in world space.", "name": "dragX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021707", "___s": true }, { "comment": "/**\r\n * The Game Object Drag Leave Event.\r\n *\r\n * This event is dispatched by an interactive Game Object if a pointer drags it out of a drag target.\r\n *\r\n * Listen to this event from a Game Object using: `gameObject.on('dragleave', listener)`.\r\n * Note that the scope of the listener is automatically set to be the Game Object instance itself.\r\n *\r\n * To receive this event, the Game Object must have been set as interactive and enabled for drag.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_DRAG_LEAVE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} target - The drag target that this pointer has left.\r\n */", "meta": { "filename": "GAMEOBJECT_DRAG_LEAVE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Drag Leave Event.\r\rThis event is dispatched by an interactive Game Object if a pointer drags it out of a drag target.\r\rListen to this event from a Game Object using: `gameObject.on('dragleave', listener)`.\rNote that the scope of the listener is automatically set to be the Game Object instance itself.\r\rTo receive this event, the Game Object must have been set as interactive and enabled for drag.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.", "kind": "event", "name": "GAMEOBJECT_DRAG_LEAVE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021709", "___s": true }, { "comment": "/**\r\n * The Game Object Drag Over Event.\r\n *\r\n * This event is dispatched by an interactive Game Object if a pointer drags it over a drag target.\r\n *\r\n * When the Game Object first enters the drag target it will emit a `dragenter` event. If it then moves while within\r\n * the drag target, it will emit this event instead.\r\n *\r\n * Listen to this event from a Game Object using: `gameObject.on('dragover', listener)`.\r\n * Note that the scope of the listener is automatically set to be the Game Object instance itself.\r\n *\r\n * To receive this event, the Game Object must have been set as interactive and enabled for drag.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_DRAG_OVER\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} target - The drag target that this pointer has moved over.\r\n */", "meta": { "filename": "GAMEOBJECT_DRAG_OVER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Drag Over Event.\r\rThis event is dispatched by an interactive Game Object if a pointer drags it over a drag target.\r\rWhen the Game Object first enters the drag target it will emit a `dragenter` event. If it then moves while within\rthe drag target, it will emit this event instead.\r\rListen to this event from a Game Object using: `gameObject.on('dragover', listener)`.\rNote that the scope of the listener is automatically set to be the Game Object instance itself.\r\rTo receive this event, the Game Object must have been set as interactive and enabled for drag.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.", "kind": "event", "name": "GAMEOBJECT_DRAG_OVER", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021711", "___s": true }, { "comment": "/**\r\n * The Game Object Drag Start Event.\r\n *\r\n * This event is dispatched by an interactive Game Object if a pointer starts to drag it.\r\n *\r\n * Listen to this event from a Game Object using: `gameObject.on('dragstart', listener)`.\r\n * Note that the scope of the listener is automatically set to be the Game Object instance itself.\r\n *\r\n * To receive this event, the Game Object must have been set as interactive and enabled for drag.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * There are lots of useful drag related properties that are set within the Game Object when dragging occurs.\r\n * For example, `gameObject.input.dragStartX`, `dragStartY` and so on.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_DRAG_START\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {number} dragX - The x coordinate where the Pointer is currently dragging the Game Object, in world space.\r\n * @param {number} dragY - The y coordinate where the Pointer is currently dragging the Game Object, in world space.\r\n */", "meta": { "filename": "GAMEOBJECT_DRAG_START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Drag Start Event.\r\rThis event is dispatched by an interactive Game Object if a pointer starts to drag it.\r\rListen to this event from a Game Object using: `gameObject.on('dragstart', listener)`.\rNote that the scope of the listener is automatically set to be the Game Object instance itself.\r\rTo receive this event, the Game Object must have been set as interactive and enabled for drag.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\rThere are lots of useful drag related properties that are set within the Game Object when dragging occurs.\rFor example, `gameObject.input.dragStartX`, `dragStartY` and so on.", "kind": "event", "name": "GAMEOBJECT_DRAG_START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate where the Pointer is currently dragging the Game Object, in world space.", "name": "dragX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021713", "___s": true }, { "comment": "/**\r\n * The Game Object Drop Event.\r\n *\r\n * This event is dispatched by an interactive Game Object if a pointer drops it on a Drag Target.\r\n *\r\n * Listen to this event from a Game Object using: `gameObject.on('drop', listener)`.\r\n * Note that the scope of the listener is automatically set to be the Game Object instance itself.\r\n *\r\n * To receive this event, the Game Object must have been set as interactive and enabled for drag.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_DROP\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} target - The Drag Target the `gameObject` has been dropped on.\r\n */", "meta": { "filename": "GAMEOBJECT_DROP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Drop Event.\r\rThis event is dispatched by an interactive Game Object if a pointer drops it on a Drag Target.\r\rListen to this event from a Game Object using: `gameObject.on('drop', listener)`.\rNote that the scope of the listener is automatically set to be the Game Object instance itself.\r\rTo receive this event, the Game Object must have been set as interactive and enabled for drag.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.", "kind": "event", "name": "GAMEOBJECT_DROP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021715", "___s": true }, { "comment": "/**\r\n * The Game Object Move Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer is moved across _any_ interactive Game Object.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('gameobjectmove', listener)`.\r\n *\r\n * To receive this event, the Game Objects must have been set as interactive.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE} event instead.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE}\r\n * 2. [GAMEOBJECT_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_MOVE}\r\n * 3. [POINTER_MOVE]{@linkcode Phaser.Input.Events#event:POINTER_MOVE}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_MOVE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object the pointer was moved on.\r\n * @param {Phaser.Types.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.\r\n */", "meta": { "filename": "GAMEOBJECT_MOVE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Move Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is moved across _any_ interactive Game Object.\r\rListen to this event from within a Scene using: `this.input.on('gameobjectmove', listener)`.\r\rTo receive this event, the Game Objects must have been set as interactive.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\rTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE} event instead.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE}\r2. [GAMEOBJECT_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_MOVE}\r3. [POINTER_MOVE]{@linkcode Phaser.Input.Events#event:POINTER_MOVE}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "GAMEOBJECT_MOVE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object the pointer was moved on.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Types.Input.EventData" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021717", "___s": true }, { "comment": "/**\r\n * The Game Object Out Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer moves out of _any_ interactive Game Object.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('gameobjectout', listener)`.\r\n *\r\n * To receive this event, the Game Objects must have been set as interactive.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT} event instead.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT}\r\n * 2. [GAMEOBJECT_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OUT}\r\n * 3. [POINTER_OUT]{@linkcode Phaser.Input.Events#event:POINTER_OUT}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * If the pointer leaves the game canvas itself, it will not trigger this event. To handle those cases,\r\n * please listen for the [GAME_OUT]{@linkcode Phaser.Input.Events#event:GAME_OUT} event.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_OUT\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object the pointer moved out of.\r\n * @param {Phaser.Types.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.\r\n */", "meta": { "filename": "GAMEOBJECT_OUT_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Out Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves out of _any_ interactive Game Object.\r\rListen to this event from within a Scene using: `this.input.on('gameobjectout', listener)`.\r\rTo receive this event, the Game Objects must have been set as interactive.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\rTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT} event instead.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT}\r2. [GAMEOBJECT_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OUT}\r3. [POINTER_OUT]{@linkcode Phaser.Input.Events#event:POINTER_OUT}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.\r\rIf the pointer leaves the game canvas itself, it will not trigger this event. To handle those cases,\rplease listen for the [GAME_OUT]{@linkcode Phaser.Input.Events#event:GAME_OUT} event.", "kind": "event", "name": "GAMEOBJECT_OUT", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object the pointer moved out of.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Types.Input.EventData" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021719", "___s": true }, { "comment": "/**\r\n * The Game Object Over Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer moves over _any_ interactive Game Object.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('gameobjectover', listener)`.\r\n *\r\n * To receive this event, the Game Objects must have been set as interactive.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER} event instead.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER}\r\n * 2. [GAMEOBJECT_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OVER}\r\n * 3. [POINTER_OVER]{@linkcode Phaser.Input.Events#event:POINTER_OVER}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_OVER\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object the pointer moved over.\r\n * @param {Phaser.Types.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.\r\n */", "meta": { "filename": "GAMEOBJECT_OVER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Over Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves over _any_ interactive Game Object.\r\rListen to this event from within a Scene using: `this.input.on('gameobjectover', listener)`.\r\rTo receive this event, the Game Objects must have been set as interactive.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\rTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER} event instead.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER}\r2. [GAMEOBJECT_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OVER}\r3. [POINTER_OVER]{@linkcode Phaser.Input.Events#event:POINTER_OVER}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "GAMEOBJECT_OVER", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object the pointer moved over.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Types.Input.EventData" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021721", "___s": true }, { "comment": "/**\r\n * The Game Object Pointer Down Event.\r\n *\r\n * This event is dispatched by an interactive Game Object if a pointer is pressed down on it.\r\n *\r\n * Listen to this event from a Game Object using: `gameObject.on('pointerdown', listener)`.\r\n * Note that the scope of the listener is automatically set to be the Game Object instance itself.\r\n *\r\n * To receive this event, the Game Object must have been set as interactive.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\r\n * 2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\r\n * 3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_POINTER_DOWN\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {number} localX - The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.\r\n * @param {number} localY - The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.\r\n * @param {Phaser.Types.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.\r\n */", "meta": { "filename": "GAMEOBJECT_POINTER_DOWN_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Pointer Down Event.\r\rThis event is dispatched by an interactive Game Object if a pointer is pressed down on it.\r\rListen to this event from a Game Object using: `gameObject.on('pointerdown', listener)`.\rNote that the scope of the listener is automatically set to be the Game Object instance itself.\r\rTo receive this event, the Game Object must have been set as interactive.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\r2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\r3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "GAMEOBJECT_POINTER_DOWN", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021723", "___s": true }, { "comment": "/**\r\n * The Game Object Pointer Move Event.\r\n *\r\n * This event is dispatched by an interactive Game Object if a pointer is moved while over it.\r\n *\r\n * Listen to this event from a Game Object using: `gameObject.on('pointermove', listener)`.\r\n * Note that the scope of the listener is automatically set to be the Game Object instance itself.\r\n *\r\n * To receive this event, the Game Object must have been set as interactive.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE}\r\n * 2. [GAMEOBJECT_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_MOVE}\r\n * 3. [POINTER_MOVE]{@linkcode Phaser.Input.Events#event:POINTER_MOVE}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_POINTER_MOVE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {number} localX - The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.\r\n * @param {number} localY - The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.\r\n * @param {Phaser.Types.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.\r\n */", "meta": { "filename": "GAMEOBJECT_POINTER_MOVE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Pointer Move Event.\r\rThis event is dispatched by an interactive Game Object if a pointer is moved while over it.\r\rListen to this event from a Game Object using: `gameObject.on('pointermove', listener)`.\rNote that the scope of the listener is automatically set to be the Game Object instance itself.\r\rTo receive this event, the Game Object must have been set as interactive.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE}\r2. [GAMEOBJECT_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_MOVE}\r3. [POINTER_MOVE]{@linkcode Phaser.Input.Events#event:POINTER_MOVE}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "GAMEOBJECT_POINTER_MOVE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021725", "___s": true }, { "comment": "/**\r\n * The Game Object Pointer Out Event.\r\n *\r\n * This event is dispatched by an interactive Game Object if a pointer moves out of it.\r\n *\r\n * Listen to this event from a Game Object using: `gameObject.on('pointerout', listener)`.\r\n * Note that the scope of the listener is automatically set to be the Game Object instance itself.\r\n *\r\n * To receive this event, the Game Object must have been set as interactive.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT}\r\n * 2. [GAMEOBJECT_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OUT}\r\n * 3. [POINTER_OUT]{@linkcode Phaser.Input.Events#event:POINTER_OUT}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * If the pointer leaves the game canvas itself, it will not trigger this event. To handle those cases,\r\n * please listen for the [GAME_OUT]{@linkcode Phaser.Input.Events#event:GAME_OUT} event.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_POINTER_OUT\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.Types.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.\r\n */", "meta": { "filename": "GAMEOBJECT_POINTER_OUT_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Pointer Out Event.\r\rThis event is dispatched by an interactive Game Object if a pointer moves out of it.\r\rListen to this event from a Game Object using: `gameObject.on('pointerout', listener)`.\rNote that the scope of the listener is automatically set to be the Game Object instance itself.\r\rTo receive this event, the Game Object must have been set as interactive.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT}\r2. [GAMEOBJECT_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OUT}\r3. [POINTER_OUT]{@linkcode Phaser.Input.Events#event:POINTER_OUT}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.\r\rIf the pointer leaves the game canvas itself, it will not trigger this event. To handle those cases,\rplease listen for the [GAME_OUT]{@linkcode Phaser.Input.Events#event:GAME_OUT} event.", "kind": "event", "name": "GAMEOBJECT_POINTER_OUT", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.Types.Input.EventData" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021727", "___s": true }, { "comment": "/**\r\n * The Game Object Pointer Over Event.\r\n *\r\n * This event is dispatched by an interactive Game Object if a pointer moves over it.\r\n *\r\n * Listen to this event from a Game Object using: `gameObject.on('pointerover', listener)`.\r\n * Note that the scope of the listener is automatically set to be the Game Object instance itself.\r\n *\r\n * To receive this event, the Game Object must have been set as interactive.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER}\r\n * 2. [GAMEOBJECT_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OVER}\r\n * 3. [POINTER_OVER]{@linkcode Phaser.Input.Events#event:POINTER_OVER}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_POINTER_OVER\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {number} localX - The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.\r\n * @param {number} localY - The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.\r\n * @param {Phaser.Types.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.\r\n */", "meta": { "filename": "GAMEOBJECT_POINTER_OVER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Pointer Over Event.\r\rThis event is dispatched by an interactive Game Object if a pointer moves over it.\r\rListen to this event from a Game Object using: `gameObject.on('pointerover', listener)`.\rNote that the scope of the listener is automatically set to be the Game Object instance itself.\r\rTo receive this event, the Game Object must have been set as interactive.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER}\r2. [GAMEOBJECT_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OVER}\r3. [POINTER_OVER]{@linkcode Phaser.Input.Events#event:POINTER_OVER}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "GAMEOBJECT_POINTER_OVER", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021729", "___s": true }, { "comment": "/**\r\n * The Game Object Pointer Up Event.\r\n *\r\n * This event is dispatched by an interactive Game Object if a pointer is released while over it.\r\n *\r\n * Listen to this event from a Game Object using: `gameObject.on('pointerup', listener)`.\r\n * Note that the scope of the listener is automatically set to be the Game Object instance itself.\r\n *\r\n * To receive this event, the Game Object must have been set as interactive.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\r\n * 2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\r\n * 3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_POINTER_UP\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {number} localX - The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.\r\n * @param {number} localY - The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.\r\n * @param {Phaser.Types.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.\r\n */", "meta": { "filename": "GAMEOBJECT_POINTER_UP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Pointer Up Event.\r\rThis event is dispatched by an interactive Game Object if a pointer is released while over it.\r\rListen to this event from a Game Object using: `gameObject.on('pointerup', listener)`.\rNote that the scope of the listener is automatically set to be the Game Object instance itself.\r\rTo receive this event, the Game Object must have been set as interactive.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\r2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\r3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "GAMEOBJECT_POINTER_UP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021731", "___s": true }, { "comment": "/**\r\n * The Game Object Pointer Wheel Event.\r\n *\r\n * This event is dispatched by an interactive Game Object if a pointer has its wheel moved while over it.\r\n *\r\n * Listen to this event from a Game Object using: `gameObject.on('wheel', listener)`.\r\n * Note that the scope of the listener is automatically set to be the Game Object instance itself.\r\n *\r\n * To receive this event, the Game Object must have been set as interactive.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL}\r\n * 2. [GAMEOBJECT_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_WHEEL}\r\n * 3. [POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:POINTER_WHEEL}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_POINTER_WHEEL\r\n * @type {string}\r\n * @since 3.18.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {number} deltaX - The horizontal scroll amount that occurred due to the user moving a mouse wheel or similar input device.\r\n * @param {number} deltaY - 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.\r\n * @param {number} deltaZ - The z-axis scroll amount that occurred due to the user moving a mouse wheel or similar input device.\r\n * @param {Phaser.Types.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.\r\n */", "meta": { "filename": "GAMEOBJECT_POINTER_WHEEL_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Pointer Wheel Event.\r\rThis event is dispatched by an interactive Game Object if a pointer has its wheel moved while over it.\r\rListen to this event from a Game Object using: `gameObject.on('wheel', listener)`.\rNote that the scope of the listener is automatically set to be the Game Object instance itself.\r\rTo receive this event, the Game Object must have been set as interactive.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL}\r2. [GAMEOBJECT_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_WHEEL}\r3. [POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:POINTER_WHEEL}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "GAMEOBJECT_POINTER_WHEEL", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.18.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021733", "___s": true }, { "comment": "/**\r\n * The Game Object Up Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer is released while over _any_ interactive Game Object.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('gameobjectup', listener)`.\r\n *\r\n * To receive this event, the Game Objects must have been set as interactive.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP} event instead.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\r\n * 2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\r\n * 3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_UP\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object the pointer was over when released.\r\n * @param {Phaser.Types.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.\r\n */", "meta": { "filename": "GAMEOBJECT_UP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Up Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is released while over _any_ interactive Game Object.\r\rListen to this event from within a Scene using: `this.input.on('gameobjectup', listener)`.\r\rTo receive this event, the Game Objects must have been set as interactive.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\rTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP} event instead.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\r2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\r3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "GAMEOBJECT_UP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object the pointer was over when released.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Types.Input.EventData" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021735", "___s": true }, { "comment": "/**\r\n * The Game Object Wheel Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer has its wheel moved while over _any_ interactive Game Object.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('gameobjectwheel', listener)`.\r\n *\r\n * To receive this event, the Game Objects must have been set as interactive.\r\n * See [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\n *\r\n * To listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL} event instead.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL}\r\n * 2. [GAMEOBJECT_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_WHEEL}\r\n * 3. [POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:POINTER_WHEEL}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#GAMEOBJECT_WHEEL\r\n * @type {string}\r\n * @since 3.18.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object the pointer was over when the wheel changed.\r\n * @param {number} deltaX - The horizontal scroll amount that occurred due to the user moving a mouse wheel or similar input device.\r\n * @param {number} deltaY - 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.\r\n * @param {number} deltaZ - The z-axis scroll amount that occurred due to the user moving a mouse wheel or similar input device.\r\n * @param {Phaser.Types.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.\r\n */", "meta": { "filename": "GAMEOBJECT_WHEEL_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Game Object Wheel Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer has its wheel moved while over _any_ interactive Game Object.\r\rListen to this event from within a Scene using: `this.input.on('gameobjectwheel', listener)`.\r\rTo receive this event, the Game Objects must have been set as interactive.\rSee [GameObject.setInteractive]{@link Phaser.GameObjects.GameObject#setInteractive} for more details.\r\rTo listen for this event from a _specific_ Game Object, use the [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL} event instead.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL}\r2. [GAMEOBJECT_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_WHEEL}\r3. [POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:POINTER_WHEEL}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "GAMEOBJECT_WHEEL", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.18.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object the pointer was over when the wheel changed.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021737", "___s": true }, { "comment": "/**\r\n * The Input Plugin Game Out Event.\r\n *\r\n * This event is dispatched by the Input Plugin if the active pointer leaves the game canvas and is now\r\n * outside of it, elsewhere on the web page.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('gameout', listener)`.\r\n *\r\n * @event Phaser.Input.Events#GAME_OUT\r\n * @type {string}\r\n * @since 3.16.1\r\n *\r\n * @param {number} time - The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.\r\n * @param {(MouseEvent|TouchEvent)} event - The DOM Event that triggered the canvas out.\r\n */", "meta": { "filename": "GAME_OUT_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Input Plugin Game Out Event.\r\rThis event is dispatched by the Input Plugin if the active pointer leaves the game canvas and is now\routside of it, elsewhere on the web page.\r\rListen to this event from within a Scene using: `this.input.on('gameout', listener)`.", "kind": "event", "name": "GAME_OUT", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.1", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "MouseEvent" }, { "type": "NameExpression", "name": "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", "___id": "T000002R021739", "___s": true }, { "comment": "/**\r\n * The Input Plugin Game Over Event.\r\n *\r\n * This event is dispatched by the Input Plugin if the active pointer enters the game canvas and is now\r\n * over it, having previously been elsewhere on the web page.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('gameover', listener)`.\r\n *\r\n * @event Phaser.Input.Events#GAME_OVER\r\n * @type {string}\r\n * @since 3.16.1\r\n *\r\n * @param {number} time - The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.\r\n * @param {(MouseEvent|TouchEvent)} event - The DOM Event that triggered the canvas over.\r\n */", "meta": { "filename": "GAME_OVER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Input Plugin Game Over Event.\r\rThis event is dispatched by the Input Plugin if the active pointer enters the game canvas and is now\rover it, having previously been elsewhere on the web page.\r\rListen to this event from within a Scene using: `this.input.on('gameover', listener)`.", "kind": "event", "name": "GAME_OVER", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.1", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "MouseEvent" }, { "type": "NameExpression", "name": "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", "___id": "T000002R021741", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Input.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Input", "longname": "Phaser.Input.Events", "scope": "static", "___id": "T000002R021743", "___s": true }, { "comment": "/**\r\n * The Input Manager Boot Event.\r\n *\r\n * This internal event is dispatched by the Input Manager when it boots.\r\n *\r\n * @event Phaser.Input.Events#MANAGER_BOOT\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MANAGER_BOOT_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Input Manager Boot Event.\r\rThis internal event is dispatched by the Input Manager when it boots.", "kind": "event", "name": "MANAGER_BOOT", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Input.Events", "longname": "Phaser.Input.Events#event:MANAGER_BOOT", "scope": "instance", "___id": "T000002R021791", "___s": true }, { "comment": "/**\r\n * The Input Manager Process Event.\r\n *\r\n * This internal event is dispatched by the Input Manager when not using the legacy queue system,\r\n * and it wants the Input Plugins to update themselves.\r\n *\r\n * @event Phaser.Input.Events#MANAGER_PROCESS\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.\r\n * @param {number} delta - The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.\r\n */", "meta": { "filename": "MANAGER_PROCESS_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Input Manager Process Event.\r\rThis internal event is dispatched by the Input Manager when not using the legacy queue system,\rand it wants the Input Plugins to update themselves.", "kind": "event", "name": "MANAGER_PROCESS", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021793", "___s": true }, { "comment": "/**\r\n * The Input Manager Update Event.\r\n *\r\n * This internal event is dispatched by the Input Manager as part of its update step.\r\n *\r\n * @event Phaser.Input.Events#MANAGER_UPDATE\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MANAGER_UPDATE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Input Manager Update Event.\r\rThis internal event is dispatched by the Input Manager as part of its update step.", "kind": "event", "name": "MANAGER_UPDATE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Input.Events", "longname": "Phaser.Input.Events#event:MANAGER_UPDATE", "scope": "instance", "___id": "T000002R021795", "___s": true }, { "comment": "/**\r\n * The Input Manager Pointer Lock Change Event.\r\n *\r\n * This event is dispatched by the Input Manager when it is processing a native Pointer Lock Change DOM Event.\r\n *\r\n * @event Phaser.Input.Events#POINTERLOCK_CHANGE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Event} event - The native DOM Event.\r\n * @param {boolean} locked - The locked state of the Mouse Pointer.\r\n */", "meta": { "filename": "POINTERLOCK_CHANGE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Input Manager Pointer Lock Change Event.\r\rThis event is dispatched by the Input Manager when it is processing a native Pointer Lock Change DOM Event.", "kind": "event", "name": "POINTERLOCK_CHANGE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Event" ], "parsedType": { "type": "NameExpression", "name": "Event" } }, "description": "The native DOM Event.", "name": "event" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "The locked state of the Mouse Pointer.", "name": "locked" } ], "memberof": "Phaser.Input.Events", "longname": "Phaser.Input.Events#event:POINTERLOCK_CHANGE", "scope": "instance", "___id": "T000002R021797", "___s": true }, { "comment": "/**\r\n * The Pointer Down Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer is pressed down anywhere.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('pointerdown', listener)`.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\r\n * 2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\r\n * 3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#POINTER_DOWN\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject[]} currentlyOver - An array containing all interactive Game Objects that the pointer was over when the event was created.\r\n */", "meta": { "filename": "POINTER_DOWN_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Down Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is pressed down anywhere.\r\rListen to this event from within a Scene using: `this.input.on('pointerdown', listener)`.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\r2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\r3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "POINTER_DOWN", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "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", "___id": "T000002R021799", "___s": true }, { "comment": "/**\r\n * The Pointer Down Outside Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer is pressed down anywhere outside of the game canvas.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('pointerdownoutside', listener)`.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\r\n * 2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\r\n * 3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#POINTER_DOWN_OUTSIDE\r\n * @type {string}\r\n * @since 3.16.1\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n */", "meta": { "filename": "POINTER_DOWN_OUTSIDE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Down Outside Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is pressed down anywhere outside of the game canvas.\r\rListen to this event from within a Scene using: `this.input.on('pointerdownoutside', listener)`.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN}\r2. [GAMEOBJECT_DOWN]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_DOWN}\r3. [POINTER_DOWN]{@linkcode Phaser.Input.Events#event:POINTER_DOWN} or [POINTER_DOWN_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "POINTER_DOWN_OUTSIDE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.1", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021801", "___s": true }, { "comment": "/**\r\n * The Pointer Move Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer is moved anywhere.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('pointermove', listener)`.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE}\r\n * 2. [GAMEOBJECT_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_MOVE}\r\n * 3. [POINTER_MOVE]{@linkcode Phaser.Input.Events#event:POINTER_MOVE}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#POINTER_MOVE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject[]} currentlyOver - An array containing all interactive Game Objects that the pointer was over when the event was created.\r\n */", "meta": { "filename": "POINTER_MOVE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Move Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is moved anywhere.\r\rListen to this event from within a Scene using: `this.input.on('pointermove', listener)`.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE}\r2. [GAMEOBJECT_MOVE]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_MOVE}\r3. [POINTER_MOVE]{@linkcode Phaser.Input.Events#event:POINTER_MOVE}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "POINTER_MOVE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "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", "___id": "T000002R021803", "___s": true }, { "comment": "/**\r\n * The Pointer Out Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer moves out of any interactive Game Object.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('pointerout', listener)`.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT}\r\n * 2. [GAMEOBJECT_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OUT}\r\n * 3. [POINTER_OUT]{@linkcode Phaser.Input.Events#event:POINTER_OUT}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * If the pointer leaves the game canvas itself, it will not trigger this event. To handle those cases,\r\n * please listen for the [GAME_OUT]{@linkcode Phaser.Input.Events#event:GAME_OUT} event.\r\n *\r\n * @event Phaser.Input.Events#POINTER_OUT\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject[]} justOut - An array containing all interactive Game Objects that the pointer moved out of when the event was created.\r\n */", "meta": { "filename": "POINTER_OUT_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Out Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves out of any interactive Game Object.\r\rListen to this event from within a Scene using: `this.input.on('pointerout', listener)`.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT}\r2. [GAMEOBJECT_OUT]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OUT}\r3. [POINTER_OUT]{@linkcode Phaser.Input.Events#event:POINTER_OUT}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.\r\rIf the pointer leaves the game canvas itself, it will not trigger this event. To handle those cases,\rplease listen for the [GAME_OUT]{@linkcode Phaser.Input.Events#event:GAME_OUT} event.", "kind": "event", "name": "POINTER_OUT", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "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", "___id": "T000002R021805", "___s": true }, { "comment": "/**\r\n * The Pointer Over Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer moves over any interactive Game Object.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('pointerover', listener)`.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER}\r\n * 2. [GAMEOBJECT_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OVER}\r\n * 3. [POINTER_OVER]{@linkcode Phaser.Input.Events#event:POINTER_OVER}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#POINTER_OVER\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject[]} justOver - An array containing all interactive Game Objects that the pointer moved over when the event was created.\r\n */", "meta": { "filename": "POINTER_OVER_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Over Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer moves over any interactive Game Object.\r\rListen to this event from within a Scene using: `this.input.on('pointerover', listener)`.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER}\r2. [GAMEOBJECT_OVER]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_OVER}\r3. [POINTER_OVER]{@linkcode Phaser.Input.Events#event:POINTER_OVER}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "POINTER_OVER", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "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", "___id": "T000002R021807", "___s": true }, { "comment": "/**\r\n * The Pointer Up Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer is released anywhere.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('pointerup', listener)`.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\r\n * 2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\r\n * 3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#POINTER_UP\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject[]} currentlyOver - An array containing all interactive Game Objects that the pointer was over when the event was created.\r\n */", "meta": { "filename": "POINTER_UP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Up Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is released anywhere.\r\rListen to this event from within a Scene using: `this.input.on('pointerup', listener)`.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\r2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\r3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "POINTER_UP", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "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", "___id": "T000002R021809", "___s": true }, { "comment": "/**\r\n * The Pointer Up Outside Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer is released anywhere outside of the game canvas.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('pointerupoutside', listener)`.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\r\n * 2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\r\n * 3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#POINTER_UP_OUTSIDE\r\n * @type {string}\r\n * @since 3.16.1\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n */", "meta": { "filename": "POINTER_UP_OUTSIDE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Up Outside Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer is released anywhere outside of the game canvas.\r\rListen to this event from within a Scene using: `this.input.on('pointerupoutside', listener)`.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP}\r2. [GAMEOBJECT_UP]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_UP}\r3. [POINTER_UP]{@linkcode Phaser.Input.Events#event:POINTER_UP} or [POINTER_UP_OUTSIDE]{@linkcode Phaser.Input.Events#event:POINTER_UP_OUTSIDE}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "POINTER_UP_OUTSIDE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.16.1", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021811", "___s": true }, { "comment": "/**\r\n * The Pointer Wheel Input Event.\r\n *\r\n * This event is dispatched by the Input Plugin belonging to a Scene if a pointer has its wheel updated.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.on('wheel', listener)`.\r\n *\r\n * The event hierarchy is as follows:\r\n *\r\n * 1. [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL}\r\n * 2. [GAMEOBJECT_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_WHEEL}\r\n * 3. [POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:POINTER_WHEEL}\r\n *\r\n * With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\r\n * the propagation of this event.\r\n *\r\n * @event Phaser.Input.Events#POINTER_WHEEL\r\n * @type {string}\r\n * @since 3.18.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.\r\n * @param {Phaser.GameObjects.GameObject[]} currentlyOver - An array containing all interactive Game Objects that the pointer was over when the event was created.\r\n * @param {number} deltaX - The horizontal scroll amount that occurred due to the user moving a mouse wheel or similar input device.\r\n * @param {number} deltaY - 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.\r\n * @param {number} deltaZ - The z-axis scroll amount that occurred due to the user moving a mouse wheel or similar input device.\r\n */", "meta": { "filename": "POINTER_WHEEL_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Pointer Wheel Input Event.\r\rThis event is dispatched by the Input Plugin belonging to a Scene if a pointer has its wheel updated.\r\rListen to this event from within a Scene using: `this.input.on('wheel', listener)`.\r\rThe event hierarchy is as follows:\r\r1. [GAMEOBJECT_POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL}\r2. [GAMEOBJECT_WHEEL]{@linkcode Phaser.Input.Events#event:GAMEOBJECT_WHEEL}\r3. [POINTER_WHEEL]{@linkcode Phaser.Input.Events#event:POINTER_WHEEL}\r\rWith the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop\rthe propagation of this event.", "kind": "event", "name": "POINTER_WHEEL", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.18.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer responsible for triggering this event.", "name": "pointer" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "An array containing all interactive Game Objects that the pointer was over when the event was created.", "name": "currentlyOver" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021813", "___s": true }, { "comment": "/**\r\n * The Input Plugin Pre-Update Event.\r\n *\r\n * This internal event is dispatched by the Input Plugin at the start of its `preUpdate` method.\r\n * This hook is designed specifically for input plugins, but can also be listened to from user-land code.\r\n *\r\n * @event Phaser.Input.Events#PRE_UPDATE\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "PRE_UPDATE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Input Plugin Pre-Update Event.\r\rThis internal event is dispatched by the Input Plugin at the start of its `preUpdate` method.\rThis hook is designed specifically for input plugins, but can also be listened to from user-land code.", "kind": "event", "name": "PRE_UPDATE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Input.Events", "longname": "Phaser.Input.Events#event:PRE_UPDATE", "scope": "instance", "___id": "T000002R021815", "___s": true }, { "comment": "/**\r\n * The Input Plugin Shutdown Event.\r\n *\r\n * This internal event is dispatched by the Input Plugin when it shuts down, signalling to all of its systems to shut themselves down.\r\n *\r\n * @event Phaser.Input.Events#SHUTDOWN\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SHUTDOWN_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Input Plugin Shutdown Event.\r\rThis 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Input.Events", "longname": "Phaser.Input.Events#event:SHUTDOWN", "scope": "instance", "___id": "T000002R021817", "___s": true }, { "comment": "/**\r\n * The Input Plugin Start Event.\r\n *\r\n * This internal event is dispatched by the Input Plugin when it has finished setting-up,\r\n * signalling to all of its internal systems to start.\r\n *\r\n * @event Phaser.Input.Events#START\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Input Plugin Start Event.\r\rThis internal event is dispatched by the Input Plugin when it has finished setting-up,\rsignalling to all of its internal systems to start.", "kind": "event", "name": "START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Input.Events", "longname": "Phaser.Input.Events#event:START", "scope": "instance", "___id": "T000002R021819", "___s": true }, { "comment": "/**\r\n * The Input Plugin Update Event.\r\n *\r\n * This internal event is dispatched by the Input Plugin at the start of its `update` method.\r\n * This hook is designed specifically for input plugins, but can also be listened to from user-land code.\r\n *\r\n * @event Phaser.Input.Events#UPDATE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {number} time - The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.\r\n * @param {number} delta - The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.\r\n */", "meta": { "filename": "UPDATE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\events", "code": {} }, "description": "The Input Plugin Update Event.\r\rThis internal event is dispatched by the Input Plugin at the start of its `update` method.\rThis hook is designed specifically for input plugins, but can also be listened to from user-land code.", "kind": "event", "name": "UPDATE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021821", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Represents a single axis on a Gamepad controller, such as one direction of an analog stick.\r\n * Each axis has a `value` property ranging from -1 to 1 (with 0 as dead center), and a\r\n * configurable `threshold` below which the value is treated as zero by `getValue()`. Axis\r\n * objects are created automatically by the Gamepad as they are needed.\r\n *\r\n * @class Axis\r\n * @memberof Phaser.Input.Gamepad\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Gamepad.Gamepad} pad - A reference to the Gamepad that this Axis belongs to.\r\n * @param {number} index - The index of this Axis.\r\n */", "meta": { "filename": "Axis.js", "lineno": 9, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "classdesc": "Represents a single axis on a Gamepad controller, such as one direction of an analog stick.\rEach axis has a `value` property ranging from -1 to 1 (with 0 as dead center), and a\rconfigurable `threshold` below which the value is treated as zero by `getValue()`. Axis\robjects 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad.Gamepad" } }, "description": "A reference to the Gamepad that this Axis belongs to.", "name": "pad" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of this Axis.", "name": "index" } ], "scope": "static", "longname": "Phaser.Input.Gamepad.Axis", "___id": "T000002R021824", "___s": true }, { "comment": "/**\r\n * A reference to the Gamepad that this Axis belongs to.\r\n *\r\n * @name Phaser.Input.Gamepad.Axis#pad\r\n * @type {Phaser.Input.Gamepad.Gamepad}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Axis.js", "lineno": 30, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A reference to the Gamepad that this Axis belongs to.", "name": "pad", "type": { "names": [ "Phaser.Input.Gamepad.Gamepad" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad.Gamepad" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Axis", "longname": "Phaser.Input.Gamepad.Axis#pad", "scope": "instance", "kind": "member", "___id": "T000002R021827", "___s": true }, { "comment": "/**\r\n * An event emitter to use to emit the axis events.\r\n *\r\n * @name Phaser.Input.Gamepad.Axis#events\r\n * @type {Phaser.Events.EventEmitter}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Axis.js", "lineno": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "An event emitter to use to emit the axis events.", "name": "events", "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Axis", "longname": "Phaser.Input.Gamepad.Axis#events", "scope": "instance", "kind": "member", "___id": "T000002R021829", "___s": true }, { "comment": "/**\r\n * The index of this Axis.\r\n *\r\n * @name Phaser.Input.Gamepad.Axis#index\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Axis.js", "lineno": 48, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "The index of this Axis.", "name": "index", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Axis", "longname": "Phaser.Input.Gamepad.Axis#index", "scope": "instance", "kind": "member", "___id": "T000002R021831", "___s": true }, { "comment": "/**\r\n * The raw axis value, between -1 and 1 with 0 being dead center.\r\n * Use the method `getValue` to get a normalized value with the threshold applied.\r\n *\r\n * @name Phaser.Input.Gamepad.Axis#value\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Axis.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "The raw axis value, between -1 and 1 with 0 being dead center.\rUse the method `getValue` to get a normalized value with the threshold applied.", "name": "value", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Axis", "longname": "Phaser.Input.Gamepad.Axis#value", "scope": "instance", "kind": "member", "___id": "T000002R021833", "___s": true }, { "comment": "/**\r\n * Movement tolerance threshold below which axis values are ignored in `getValue`.\r\n *\r\n * @name Phaser.Input.Gamepad.Axis#threshold\r\n * @type {number}\r\n * @default 0.1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Axis.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Movement tolerance threshold below which axis values are ignored in `getValue`.", "name": "threshold", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.1", "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Axis", "longname": "Phaser.Input.Gamepad.Axis#threshold", "scope": "instance", "kind": "member", "___id": "T000002R021835", "___s": true }, { "comment": "/**\r\n * Returns the axis value after applying the dead zone threshold. If the absolute value\r\n * of the axis is less than `threshold`, zero is returned instead, preventing minor stick\r\n * drift from registering as intentional input. Otherwise the raw `value` is returned.\r\n *\r\n * @method Phaser.Input.Gamepad.Axis#getValue\r\n * @since 3.0.0\r\n *\r\n * @return {number} The axis value, adjusted for the movement threshold.\r\n */", "meta": { "filename": "Axis.js", "lineno": 94, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Returns the axis value after applying the dead zone threshold. If the absolute value\rof the axis is less than `threshold`, zero is returned instead, preventing minor stick\rdrift from registering as intentional input. Otherwise the raw `value` is returned.", "kind": "function", "name": "getValue", "since": "3.0.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The axis value, adjusted for the movement threshold." } ], "memberof": "Phaser.Input.Gamepad.Axis", "longname": "Phaser.Input.Gamepad.Axis#getValue", "scope": "instance", "___id": "T000002R021840", "___s": true }, { "comment": "/**\r\n * Destroys this Axis instance and releases external references it holds.\r\n *\r\n * @method Phaser.Input.Gamepad.Axis#destroy\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Axis.js", "lineno": 109, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "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", "___id": "T000002R021842", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Represents a single button on a Gamepad controller. Each Button has a `value` between 0 and 1\r\n * (supporting analog pressure for triggers) and a `pressed` boolean state. When the value exceeds\r\n * the configurable `threshold`, the button emits `BUTTON_DOWN` and `GAMEPAD_BUTTON_DOWN` events.\r\n * Button objects are created automatically by the Gamepad as they are needed.\r\n *\r\n * @class Button\r\n * @memberof Phaser.Input.Gamepad\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Gamepad.Gamepad} pad - A reference to the Gamepad that this Button belongs to.\r\n * @param {number} index - The index of this Button.\r\n * @param {boolean} [isPressed=false] - Whether or not the button is already being pressed at creation time. This prevents the Button from emitting spurious 'down' events at first update.\r\n */", "meta": { "filename": "Button.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "classdesc": "Represents a single button on a Gamepad controller. Each Button has a `value` between 0 and 1\r(supporting analog pressure for triggers) and a `pressed` boolean state. When the value exceeds\rthe configurable `threshold`, the button emits `BUTTON_DOWN` and `GAMEPAD_BUTTON_DOWN` events.\rButton 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad.Gamepad" } }, "description": "A reference to the Gamepad that this Button belongs to.", "name": "pad" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of this Button.", "name": "index" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Whether or not the button is already being pressed at creation time. This prevents the Button from emitting spurious 'down' events at first update.", "name": "isPressed" } ], "scope": "static", "longname": "Phaser.Input.Gamepad.Button", "___id": "T000002R021849", "___s": true }, { "comment": "/**\r\n * A reference to the Gamepad that this Button belongs to.\r\n *\r\n * @name Phaser.Input.Gamepad.Button#pad\r\n * @type {Phaser.Input.Gamepad.Gamepad}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Button.js", "lineno": 34, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A reference to the Gamepad that this Button belongs to.", "name": "pad", "type": { "names": [ "Phaser.Input.Gamepad.Gamepad" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad.Gamepad" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Button", "longname": "Phaser.Input.Gamepad.Button#pad", "scope": "instance", "kind": "member", "___id": "T000002R021853", "___s": true }, { "comment": "/**\r\n * An event emitter to use to emit the button events.\r\n *\r\n * @name Phaser.Input.Gamepad.Button#events\r\n * @type {Phaser.Events.EventEmitter}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Button.js", "lineno": 43, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "An event emitter to use to emit the button events.", "name": "events", "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Button", "longname": "Phaser.Input.Gamepad.Button#events", "scope": "instance", "kind": "member", "___id": "T000002R021855", "___s": true }, { "comment": "/**\r\n * The index of this Button.\r\n *\r\n * @name Phaser.Input.Gamepad.Button#index\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Button.js", "lineno": 52, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "The index of this Button.", "name": "index", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Button", "longname": "Phaser.Input.Gamepad.Button#index", "scope": "instance", "kind": "member", "___id": "T000002R021857", "___s": true }, { "comment": "/**\r\n * The current value of the button, between 0 (fully released) and 1 (fully pressed).\r\n * For analog buttons like triggers, this reflects the pressure applied.\r\n *\r\n * @name Phaser.Input.Gamepad.Button#value\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Button.js", "lineno": 61, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "The current value of the button, between 0 (fully released) and 1 (fully pressed).\rFor analog buttons like triggers, this reflects the pressure applied.", "name": "value", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Button", "longname": "Phaser.Input.Gamepad.Button#value", "scope": "instance", "kind": "member", "___id": "T000002R021859", "___s": true }, { "comment": "/**\r\n * The minimum value the button must reach before it is considered as being pressed.\r\n * The value is between 0 and 1. The default of 1 requires the button to be fully pressed.\r\n * For analog buttons such as triggers, you can lower this threshold to detect partial presses.\r\n *\r\n * @name Phaser.Input.Gamepad.Button#threshold\r\n * @type {number}\r\n * @default 1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Button.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "The minimum value the button must reach before it is considered as being pressed.\rThe value is between 0 and 1. The default of 1 requires the button to be fully pressed.\rFor analog buttons such as triggers, you can lower this threshold to detect partial presses.", "name": "threshold", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "1", "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Button", "longname": "Phaser.Input.Gamepad.Button#threshold", "scope": "instance", "kind": "member", "___id": "T000002R021861", "___s": true }, { "comment": "/**\r\n * Is the Button being pressed down or not?\r\n *\r\n * @name Phaser.Input.Gamepad.Button#pressed\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Button.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Is the Button being pressed down or not?", "name": "pressed", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Button", "longname": "Phaser.Input.Gamepad.Button#pressed", "scope": "instance", "kind": "member", "___id": "T000002R021863", "___s": true }, { "comment": "/**\r\n * Destroys this Button instance and releases external references it holds.\r\n *\r\n * @method Phaser.Input.Gamepad.Button#destroy\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Button.js", "lineno": 133, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "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", "___id": "T000002R021872", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Input.Gamepad.Configs\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "kind": "namespace", "name": "Configs", "memberof": "Phaser.Input.Gamepad", "longname": "Phaser.Input.Gamepad.Configs", "scope": "static", "___id": "T000002R021877", "___s": true }, { "comment": "/**\r\n * Button index constants for the Tatar SNES USB Controller gamepad\r\n * (USB Gamepad, STANDARD GAMEPAD Vendor: 0079 Product: 0011).\r\n *\r\n * Use these constants with Phaser's Gamepad input system to identify specific\r\n * buttons on this controller by their standard gamepad API index. For example,\r\n * pass `Phaser.Input.Gamepad.Configs.SNES_USB.B` as the button index when\r\n * checking button state on a connected gamepad of this type.\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.SNES_USB\r\n * @namespace\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SNES_USB_Controller.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Button index constants for the Tatar SNES USB Controller gamepad\r(USB Gamepad, STANDARD GAMEPAD Vendor: 0079 Product: 0011).\r\rUse these constants with Phaser's Gamepad input system to identify specific\rbuttons on this controller by their standard gamepad API index. For example,\rpass `Phaser.Input.Gamepad.Configs.SNES_USB.B` as the button index when\rchecking button state on a connected gamepad of this type.", "name": "SNES_USB", "kind": "namespace", "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs", "longname": "Phaser.Input.Gamepad.Configs.SNES_USB", "scope": "static", "___id": "T000002R021882", "___s": true }, { "comment": "/**\r\n * D-Pad up\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.SNES_USB.UP\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SNES_USB_Controller.js", "lineno": 22, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "D-Pad up", "name": "UP", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.SNES_USB", "longname": "Phaser.Input.Gamepad.Configs.SNES_USB.UP", "scope": "static", "___id": "T000002R021884", "___s": true }, { "comment": "/**\r\n * D-Pad down\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.SNES_USB.DOWN\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SNES_USB_Controller.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "D-Pad down", "name": "DOWN", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.SNES_USB", "longname": "Phaser.Input.Gamepad.Configs.SNES_USB.DOWN", "scope": "static", "___id": "T000002R021886", "___s": true }, { "comment": "/**\r\n * D-Pad left\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.SNES_USB.LEFT\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SNES_USB_Controller.js", "lineno": 42, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "D-Pad left", "name": "LEFT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.SNES_USB", "longname": "Phaser.Input.Gamepad.Configs.SNES_USB.LEFT", "scope": "static", "___id": "T000002R021888", "___s": true }, { "comment": "/**\r\n * D-Pad right\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.SNES_USB.RIGHT\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SNES_USB_Controller.js", "lineno": 52, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "D-Pad right", "name": "RIGHT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.SNES_USB", "longname": "Phaser.Input.Gamepad.Configs.SNES_USB.RIGHT", "scope": "static", "___id": "T000002R021890", "___s": true }, { "comment": "/**\r\n * Select button\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.SNES_USB.SELECT\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SNES_USB_Controller.js", "lineno": 62, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Select button", "name": "SELECT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.SNES_USB", "longname": "Phaser.Input.Gamepad.Configs.SNES_USB.SELECT", "scope": "static", "___id": "T000002R021892", "___s": true }, { "comment": "/**\r\n * Start button\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.SNES_USB.START\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SNES_USB_Controller.js", "lineno": 72, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Start button", "name": "START", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.SNES_USB", "longname": "Phaser.Input.Gamepad.Configs.SNES_USB.START", "scope": "static", "___id": "T000002R021894", "___s": true }, { "comment": "/**\r\n * B Button (Bottom)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.SNES_USB.B\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SNES_USB_Controller.js", "lineno": 82, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "B Button (Bottom)", "name": "B", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.SNES_USB", "longname": "Phaser.Input.Gamepad.Configs.SNES_USB.B", "scope": "static", "___id": "T000002R021896", "___s": true }, { "comment": "/**\r\n * A Button (Right)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.SNES_USB.A\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SNES_USB_Controller.js", "lineno": 92, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "A Button (Right)", "name": "A", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.SNES_USB", "longname": "Phaser.Input.Gamepad.Configs.SNES_USB.A", "scope": "static", "___id": "T000002R021898", "___s": true }, { "comment": "/**\r\n * Y Button (Left)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.SNES_USB.Y\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SNES_USB_Controller.js", "lineno": 102, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Y Button (Left)", "name": "Y", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.SNES_USB", "longname": "Phaser.Input.Gamepad.Configs.SNES_USB.Y", "scope": "static", "___id": "T000002R021900", "___s": true }, { "comment": "/**\r\n * X Button (Top)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.SNES_USB.X\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SNES_USB_Controller.js", "lineno": 112, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "X Button (Top)", "name": "X", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.SNES_USB", "longname": "Phaser.Input.Gamepad.Configs.SNES_USB.X", "scope": "static", "___id": "T000002R021902", "___s": true }, { "comment": "/**\r\n * Left shoulder button (L)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.SNES_USB.LEFT_SHOULDER\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SNES_USB_Controller.js", "lineno": 122, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Left shoulder button (L)", "name": "LEFT_SHOULDER", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.SNES_USB", "longname": "Phaser.Input.Gamepad.Configs.SNES_USB.LEFT_SHOULDER", "scope": "static", "___id": "T000002R021904", "___s": true }, { "comment": "/**\r\n * Right shoulder button (R)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.SNES_USB.RIGHT_SHOULDER\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "SNES_USB_Controller.js", "lineno": 132, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Right shoulder button (R)", "name": "RIGHT_SHOULDER", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.SNES_USB", "longname": "Phaser.Input.Gamepad.Configs.SNES_USB.RIGHT_SHOULDER", "scope": "static", "___id": "T000002R021906", "___s": true }, { "comment": "/**\r\n * Button and axis index constants for the Sony PlayStation DualShock 4 (v2) wireless controller.\r\n *\r\n * This configuration object maps human-readable names to the numeric button and axis indices\r\n * reported by the browser Gamepad API when a DualShock 4 controller is connected. Use these\r\n * constants with Phaser's `Gamepad` class to check button states and read analog stick values\r\n * without relying on magic numbers in your game code.\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4\r\n * @namespace\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Button and axis index constants for the Sony PlayStation DualShock 4 (v2) wireless controller.\r\rThis configuration object maps human-readable names to the numeric button and axis indices\rreported by the browser Gamepad API when a DualShock 4 controller is connected. Use these\rconstants with Phaser's `Gamepad` class to check button states and read analog stick values\rwithout relying on magic numbers in your game code.", "name": "DUALSHOCK_4", "kind": "namespace", "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "scope": "static", "___id": "T000002R021908", "___s": true }, { "comment": "/**\r\n * D-Pad up\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.UP\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "D-Pad up", "name": "UP", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.UP", "scope": "static", "___id": "T000002R021910", "___s": true }, { "comment": "/**\r\n * D-Pad down\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.DOWN\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "D-Pad down", "name": "DOWN", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.DOWN", "scope": "static", "___id": "T000002R021912", "___s": true }, { "comment": "/**\r\n * D-Pad left\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.LEFT\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 41, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "D-Pad left", "name": "LEFT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.LEFT", "scope": "static", "___id": "T000002R021914", "___s": true }, { "comment": "/**\r\n * D-Pad right\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.RIGHT\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 51, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "D-Pad right", "name": "RIGHT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.RIGHT", "scope": "static", "___id": "T000002R021916", "___s": true }, { "comment": "/**\r\n * Share button\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.SHARE\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 61, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Share button", "name": "SHARE", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.SHARE", "scope": "static", "___id": "T000002R021918", "___s": true }, { "comment": "/**\r\n * Options button\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.OPTIONS\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 71, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Options button", "name": "OPTIONS", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.OPTIONS", "scope": "static", "___id": "T000002R021920", "___s": true }, { "comment": "/**\r\n * PlayStation logo button\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.PS\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "PlayStation logo button", "name": "PS", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.PS", "scope": "static", "___id": "T000002R021922", "___s": true }, { "comment": "/**\r\n * Touchpad click\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.TOUCHBAR\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 91, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Touchpad click", "name": "TOUCHBAR", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.TOUCHBAR", "scope": "static", "___id": "T000002R021924", "___s": true }, { "comment": "/**\r\n * Cross button (Bottom)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.X\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 101, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Cross button (Bottom)", "name": "X", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.X", "scope": "static", "___id": "T000002R021926", "___s": true }, { "comment": "/**\r\n * Circle button (Right)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.CIRCLE\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 111, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Circle button (Right)", "name": "CIRCLE", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.CIRCLE", "scope": "static", "___id": "T000002R021928", "___s": true }, { "comment": "/**\r\n * Square button (Left)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.SQUARE\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 121, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Square button (Left)", "name": "SQUARE", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.SQUARE", "scope": "static", "___id": "T000002R021930", "___s": true }, { "comment": "/**\r\n * Triangle button (Top)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.TRIANGLE\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 131, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Triangle button (Top)", "name": "TRIANGLE", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.TRIANGLE", "scope": "static", "___id": "T000002R021932", "___s": true }, { "comment": "/**\r\n * Left bumper (L1)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.L1\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 141, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Left bumper (L1)", "name": "L1", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.L1", "scope": "static", "___id": "T000002R021934", "___s": true }, { "comment": "/**\r\n * Right bumper (R1)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.R1\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 151, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Right bumper (R1)", "name": "R1", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.R1", "scope": "static", "___id": "T000002R021936", "___s": true }, { "comment": "/**\r\n * Left trigger (L2)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.L2\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 161, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Left trigger (L2)", "name": "L2", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.L2", "scope": "static", "___id": "T000002R021938", "___s": true }, { "comment": "/**\r\n * Right trigger (R2)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.R2\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 171, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Right trigger (R2)", "name": "R2", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.R2", "scope": "static", "___id": "T000002R021940", "___s": true }, { "comment": "/**\r\n * Left stick click (L3)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.L3\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 181, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Left stick click (L3)", "name": "L3", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.L3", "scope": "static", "___id": "T000002R021942", "___s": true }, { "comment": "/**\r\n * Right stick click (R3)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.R3\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Right stick click (R3)", "name": "R3", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.R3", "scope": "static", "___id": "T000002R021944", "___s": true }, { "comment": "/**\r\n * Left stick horizontal\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.LEFT_STICK_H\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Left stick horizontal", "name": "LEFT_STICK_H", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.LEFT_STICK_H", "scope": "static", "___id": "T000002R021946", "___s": true }, { "comment": "/**\r\n * Left stick vertical\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.LEFT_STICK_V\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 211, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Left stick vertical", "name": "LEFT_STICK_V", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.LEFT_STICK_V", "scope": "static", "___id": "T000002R021948", "___s": true }, { "comment": "/**\r\n * Right stick horizontal\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.RIGHT_STICK_H\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 221, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Right stick horizontal", "name": "RIGHT_STICK_H", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.RIGHT_STICK_H", "scope": "static", "___id": "T000002R021950", "___s": true }, { "comment": "/**\r\n * Right stick vertical\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.DUALSHOCK_4.RIGHT_STICK_V\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Sony_PlayStation_DualShock_4.js", "lineno": 231, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Right stick vertical", "name": "RIGHT_STICK_V", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4", "longname": "Phaser.Input.Gamepad.Configs.DUALSHOCK_4.RIGHT_STICK_V", "scope": "static", "___id": "T000002R021952", "___s": true }, { "comment": "/**\r\n * Button and axis index constants for the XBox 360 gamepad. Use these values\r\n * with Phaser's Gamepad input system to identify specific buttons and analog\r\n * sticks by name rather than raw index. For example, check\r\n * `pad.buttons[Phaser.Input.Gamepad.Configs.XBOX_360.A]` to test the A button,\r\n * or read `pad.axes[Phaser.Input.Gamepad.Configs.XBOX_360.LEFT_STICK_H]` for\r\n * the left stick's horizontal axis value.\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360\r\n * @namespace\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Button and axis index constants for the XBox 360 gamepad. Use these values\rwith Phaser's Gamepad input system to identify specific buttons and analog\rsticks by name rather than raw index. For example, check\r`pad.buttons[Phaser.Input.Gamepad.Configs.XBOX_360.A]` to test the A button,\ror read `pad.axes[Phaser.Input.Gamepad.Configs.XBOX_360.LEFT_STICK_H]` for\rthe left stick's horizontal axis value.", "name": "XBOX_360", "kind": "namespace", "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360", "scope": "static", "___id": "T000002R021954", "___s": true }, { "comment": "/**\r\n * D-Pad up\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.UP\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 21, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "D-Pad up", "name": "UP", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.UP", "scope": "static", "___id": "T000002R021956", "___s": true }, { "comment": "/**\r\n * D-Pad down\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.DOWN\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 31, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "D-Pad down", "name": "DOWN", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.DOWN", "scope": "static", "___id": "T000002R021958", "___s": true }, { "comment": "/**\r\n * D-Pad left\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.LEFT\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 41, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "D-Pad left", "name": "LEFT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.LEFT", "scope": "static", "___id": "T000002R021960", "___s": true }, { "comment": "/**\r\n * D-Pad right\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.RIGHT\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 51, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "D-Pad right", "name": "RIGHT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.RIGHT", "scope": "static", "___id": "T000002R021962", "___s": true }, { "comment": "/**\r\n * XBox menu button\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.MENU\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 61, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "XBox menu button", "name": "MENU", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.MENU", "scope": "static", "___id": "T000002R021964", "___s": true }, { "comment": "/**\r\n * A button (Bottom)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.A\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 71, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "A button (Bottom)", "name": "A", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.A", "scope": "static", "___id": "T000002R021966", "___s": true }, { "comment": "/**\r\n * B button (Right)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.B\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "B button (Right)", "name": "B", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.B", "scope": "static", "___id": "T000002R021968", "___s": true }, { "comment": "/**\r\n * X button (Left)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.X\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 91, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "X button (Left)", "name": "X", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.X", "scope": "static", "___id": "T000002R021970", "___s": true }, { "comment": "/**\r\n * Y button (Top)\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.Y\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 101, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Y button (Top)", "name": "Y", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.Y", "scope": "static", "___id": "T000002R021972", "___s": true }, { "comment": "/**\r\n * Left Bumper\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.LB\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 111, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Left Bumper", "name": "LB", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.LB", "scope": "static", "___id": "T000002R021974", "___s": true }, { "comment": "/**\r\n * Right Bumper\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.RB\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 121, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Right Bumper", "name": "RB", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.RB", "scope": "static", "___id": "T000002R021976", "___s": true }, { "comment": "/**\r\n * Left Trigger\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.LT\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 131, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Left Trigger", "name": "LT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.LT", "scope": "static", "___id": "T000002R021978", "___s": true }, { "comment": "/**\r\n * Right Trigger\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.RT\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 141, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Right Trigger", "name": "RT", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.RT", "scope": "static", "___id": "T000002R021980", "___s": true }, { "comment": "/**\r\n * Back / Change View button\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.BACK\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 151, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Back / Change View button", "name": "BACK", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.BACK", "scope": "static", "___id": "T000002R021982", "___s": true }, { "comment": "/**\r\n * Start button\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.START\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 161, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Start button", "name": "START", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.START", "scope": "static", "___id": "T000002R021984", "___s": true }, { "comment": "/**\r\n * Left Stick press\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.LS\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 171, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Left Stick press", "name": "LS", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.LS", "scope": "static", "___id": "T000002R021986", "___s": true }, { "comment": "/**\r\n * Right Stick press\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.RS\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 181, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Right Stick press", "name": "RS", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.RS", "scope": "static", "___id": "T000002R021988", "___s": true }, { "comment": "/**\r\n * Left Stick horizontal\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.LEFT_STICK_H\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 191, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Left Stick horizontal", "name": "LEFT_STICK_H", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.LEFT_STICK_H", "scope": "static", "___id": "T000002R021990", "___s": true }, { "comment": "/**\r\n * Left Stick vertical\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.LEFT_STICK_V\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 201, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Left Stick vertical", "name": "LEFT_STICK_V", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.LEFT_STICK_V", "scope": "static", "___id": "T000002R021992", "___s": true }, { "comment": "/**\r\n * Right Stick horizontal\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.RIGHT_STICK_H\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 211, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Right Stick horizontal", "name": "RIGHT_STICK_H", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.RIGHT_STICK_H", "scope": "static", "___id": "T000002R021994", "___s": true }, { "comment": "/**\r\n * Right Stick vertical\r\n *\r\n * @name Phaser.Input.Gamepad.Configs.XBOX_360.RIGHT_STICK_V\r\n * @const\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "XBox360_Controller.js", "lineno": 221, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\configs", "code": {} }, "description": "Right Stick vertical", "name": "RIGHT_STICK_V", "kind": "constant", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Configs.XBOX_360", "longname": "Phaser.Input.Gamepad.Configs.XBOX_360.RIGHT_STICK_V", "scope": "static", "___id": "T000002R021996", "___s": true }, { "comment": "/**\r\n * The Gamepad Button Down Event.\r\n *\r\n * This event is dispatched by the Gamepad Plugin when a button has been pressed on any active Gamepad.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.gamepad.on('down', listener)`.\r\n *\r\n * You 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.\r\n *\r\n * @event Phaser.Input.Gamepad.Events#BUTTON_DOWN\r\n * @type {string}\r\n * @since 3.10.0\r\n *\r\n * @param {Phaser.Input.Gamepad} pad - A reference to the Gamepad on which the button was pressed.\r\n * @param {Phaser.Input.Gamepad.Button} button - A reference to the Button which was pressed.\r\n * @param {number} value - The value of the button at the time it was pressed. Between 0 and 1. Some Gamepads have pressure-sensitive buttons.\r\n */", "meta": { "filename": "BUTTON_DOWN_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\events", "code": {} }, "description": "The Gamepad Button Down Event.\r\rThis event is dispatched by the Gamepad Plugin when a button has been pressed on any active Gamepad.\r\rListen to this event from within a Scene using: `this.input.gamepad.on('down', listener)`.\r\rYou 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.10.0", "params": [ { "type": { "names": [ "Phaser.Input.Gamepad" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad" } }, "description": "A reference to the Gamepad on which the button was pressed.", "name": "pad" }, { "type": { "names": [ "Phaser.Input.Gamepad.Button" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad.Button" } }, "description": "A reference to the Button which was pressed.", "name": "button" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R021998", "___s": true }, { "comment": "/**\r\n * The Gamepad Button Up Event.\r\n *\r\n * This event is dispatched by the Gamepad Plugin when a button has been released on any active Gamepad.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.gamepad.on('up', listener)`.\r\n *\r\n * You 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.\r\n *\r\n * @event Phaser.Input.Gamepad.Events#BUTTON_UP\r\n * @type {string}\r\n * @since 3.10.0\r\n *\r\n * @param {Phaser.Input.Gamepad} pad - A reference to the Gamepad on which the button was released.\r\n * @param {Phaser.Input.Gamepad.Button} button - A reference to the Button which was released.\r\n * @param {number} value - The value of the button at the time it was released. Between 0 and 1. Some Gamepads have pressure-sensitive buttons.\r\n */", "meta": { "filename": "BUTTON_UP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\events", "code": {} }, "description": "The Gamepad Button Up Event.\r\rThis event is dispatched by the Gamepad Plugin when a button has been released on any active Gamepad.\r\rListen to this event from within a Scene using: `this.input.gamepad.on('up', listener)`.\r\rYou 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.10.0", "params": [ { "type": { "names": [ "Phaser.Input.Gamepad" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad" } }, "description": "A reference to the Gamepad on which the button was released.", "name": "pad" }, { "type": { "names": [ "Phaser.Input.Gamepad.Button" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad.Button" } }, "description": "A reference to the Button which was released.", "name": "button" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R022000", "___s": true }, { "comment": "/**\r\n * The Gamepad Connected Event.\r\n *\r\n * This event is dispatched by the Gamepad Plugin when a Gamepad has been connected.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.gamepad.once('connected', listener)`.\r\n *\r\n * Note that the browser may require you to press a button on a gamepad before it will allow you to access it,\r\n * this is for security reasons. However, it may also trust the page already, in which case you won't get the\r\n * 'connected' event and instead should check `GamepadPlugin.total` to see if it thinks there are any gamepads\r\n * already connected.\r\n *\r\n * @event Phaser.Input.Gamepad.Events#CONNECTED\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Gamepad} pad - A reference to the Gamepad which was connected.\r\n * @param {Event} event - The native DOM Event that triggered the connection.\r\n */", "meta": { "filename": "CONNECTED_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\events", "code": {} }, "description": "The Gamepad Connected Event.\r\rThis event is dispatched by the Gamepad Plugin when a Gamepad has been connected.\r\rListen to this event from within a Scene using: `this.input.gamepad.once('connected', listener)`.\r\rNote that the browser may require you to press a button on a gamepad before it will allow you to access it,\rthis is for security reasons. However, it may also trust the page already, in which case you won't get the\r'connected' event and instead should check `GamepadPlugin.total` to see if it thinks there are any gamepads\ralready connected.", "kind": "event", "name": "CONNECTED", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Gamepad" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad" } }, "description": "A reference to the Gamepad which was connected.", "name": "pad" }, { "type": { "names": [ "Event" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R022002", "___s": true }, { "comment": "/**\r\n * The Gamepad Disconnected Event.\r\n *\r\n * This event is dispatched by the Gamepad Plugin when a Gamepad has been disconnected.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.gamepad.once('disconnected', listener)`.\r\n *\r\n * @event Phaser.Input.Gamepad.Events#DISCONNECTED\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Gamepad} pad - A reference to the Gamepad which was disconnected.\r\n * @param {Event} event - The native DOM Event that triggered the disconnection.\r\n */", "meta": { "filename": "DISCONNECTED_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\events", "code": {} }, "description": "The Gamepad Disconnected Event.\r\rThis event is dispatched by the Gamepad Plugin when a Gamepad has been disconnected.\r\rListen to this event from within a Scene using: `this.input.gamepad.once('disconnected', listener)`.", "kind": "event", "name": "DISCONNECTED", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Gamepad" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad" } }, "description": "A reference to the Gamepad which was disconnected.", "name": "pad" }, { "type": { "names": [ "Event" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R022004", "___s": true }, { "comment": "/**\r\n * The Gamepad Button Down Event.\r\n *\r\n * This event is dispatched by a Gamepad instance when a button has been pressed on it.\r\n *\r\n * Listen to this event from a Gamepad instance. One way to get this is from the `pad1`, `pad2`, etc properties on the Gamepad Plugin:\r\n * `this.input.gamepad.pad1.on('down', listener)`.\r\n *\r\n * Note that you will not receive any Gamepad button events until the browser considers the Gamepad as being 'connected'.\r\n *\r\n * You 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.\r\n *\r\n * @event Phaser.Input.Gamepad.Events#GAMEPAD_BUTTON_DOWN\r\n * @type {string}\r\n * @since 3.10.0\r\n *\r\n * @param {number} index - The index of the button that was pressed.\r\n * @param {number} value - The value of the button at the time it was pressed. Between 0 and 1. Some Gamepads have pressure-sensitive buttons.\r\n * @param {Phaser.Input.Gamepad.Button} button - A reference to the Button which was pressed.\r\n */", "meta": { "filename": "GAMEPAD_BUTTON_DOWN_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\events", "code": {} }, "description": "The Gamepad Button Down Event.\r\rThis event is dispatched by a Gamepad instance when a button has been pressed on it.\r\rListen to this event from a Gamepad instance. One way to get this is from the `pad1`, `pad2`, etc properties on the Gamepad Plugin:\r`this.input.gamepad.pad1.on('down', listener)`.\r\rNote that you will not receive any Gamepad button events until the browser considers the Gamepad as being 'connected'.\r\rYou 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the button that was pressed.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R022006", "___s": true }, { "comment": "/**\r\n * The Gamepad Button Up Event.\r\n *\r\n * This event is dispatched by a Gamepad instance when a button has been released on it.\r\n *\r\n * Listen to this event from a Gamepad instance. One way to get this is from the `pad1`, `pad2`, etc properties on the Gamepad Plugin:\r\n * `this.input.gamepad.pad1.on('up', listener)`.\r\n *\r\n * Note that you will not receive any Gamepad button events until the browser considers the Gamepad as being 'connected'.\r\n *\r\n * You 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.\r\n *\r\n * @event Phaser.Input.Gamepad.Events#GAMEPAD_BUTTON_UP\r\n * @type {string}\r\n * @since 3.10.0\r\n *\r\n * @param {number} index - The index of the button that was released.\r\n * @param {number} value - The value of the button at the time it was released. Between 0 and 1. Some Gamepads have pressure-sensitive buttons.\r\n * @param {Phaser.Input.Gamepad.Button} button - A reference to the Button which was released.\r\n */", "meta": { "filename": "GAMEPAD_BUTTON_UP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\events", "code": {} }, "description": "The Gamepad Button Up Event.\r\rThis event is dispatched by a Gamepad instance when a button has been released on it.\r\rListen to this event from a Gamepad instance. One way to get this is from the `pad1`, `pad2`, etc properties on the Gamepad Plugin:\r`this.input.gamepad.pad1.on('up', listener)`.\r\rNote that you will not receive any Gamepad button events until the browser considers the Gamepad as being 'connected'.\r\rYou 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the button that was released.", "name": "index" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R022008", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Input.Gamepad.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Input.Gamepad", "longname": "Phaser.Input.Gamepad.Events", "scope": "static", "___id": "T000002R022010", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Represents a single connected gamepad controller. Each Gamepad contains Button and Axis\r\n * objects that are automatically created and updated by the Gamepad Plugin. You can access\r\n * the directional sticks via the `leftStick` and `rightStick` Vector2 properties, individual\r\n * buttons via the `buttons` array, and axes via the `axes` array. Gamepads are typically\r\n * accessed through `this.input.gamepad.pad1` through `pad4` in a Scene.\r\n *\r\n * @class Gamepad\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Input.Gamepad\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Gamepad.GamepadPlugin} manager - A reference to the Gamepad Plugin.\r\n * @param {Phaser.Types.Input.Gamepad.Pad} pad - The Gamepad object, as extracted from GamepadEvent.\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "classdesc": "Represents a single connected gamepad controller. Each Gamepad contains Button and Axis\robjects that are automatically created and updated by the Gamepad Plugin. You can access\rthe directional sticks via the `leftStick` and `rightStick` Vector2 properties, individual\rbuttons via the `buttons` array, and axes via the `axes` array. Gamepads are typically\raccessed through `this.input.gamepad.pad1` through `pad4` in a Scene.", "kind": "class", "name": "Gamepad", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Input.Gamepad", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Gamepad.GamepadPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad.GamepadPlugin" } }, "description": "A reference to the Gamepad Plugin.", "name": "manager" }, { "type": { "names": [ "Phaser.Types.Input.Gamepad.Pad" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.Gamepad.Pad" } }, "description": "The Gamepad object, as extracted from GamepadEvent.", "name": "pad" } ], "scope": "static", "longname": "Phaser.Input.Gamepad.Gamepad", "___id": "T000002R022023", "___s": true }, { "comment": "/**\r\n * A reference to the Gamepad Plugin.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#manager\r\n * @type {Phaser.Input.Gamepad.GamepadPlugin}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 40, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A reference to the Gamepad Plugin.", "name": "manager", "type": { "names": [ "Phaser.Input.Gamepad.GamepadPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad.GamepadPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#manager", "scope": "instance", "kind": "member", "___id": "T000002R022027", "___s": true }, { "comment": "/**\r\n * A reference to the native Gamepad object that is connected to the browser.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#pad\r\n * @type {any}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 49, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A reference to the native Gamepad object that is connected to the browser.", "name": "pad", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#pad", "scope": "instance", "kind": "member", "___id": "T000002R022029", "___s": true }, { "comment": "/**\r\n * A string containing some information about the controller.\r\n *\r\n * This is not strictly specified, but in Firefox it will contain three pieces of information\r\n * separated by dashes (-): two 4-digit hexadecimal strings containing the USB vendor and\r\n * product id of the controller, and the name of the controller as provided by the driver.\r\n * In Chrome it will contain the name of the controller as provided by the driver,\r\n * followed by vendor and product 4-digit hexadecimal strings.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#id\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A string containing some information about the controller.\r\rThis is not strictly specified, but in Firefox it will contain three pieces of information\rseparated by dashes (-): two 4-digit hexadecimal strings containing the USB vendor and\rproduct id of the controller, and the name of the controller as provided by the driver.\rIn Chrome it will contain the name of the controller as provided by the driver,\rfollowed by vendor and product 4-digit hexadecimal strings.", "name": "id", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#id", "scope": "instance", "kind": "member", "___id": "T000002R022031", "___s": true }, { "comment": "/**\r\n * An integer that is unique for each Gamepad currently connected to the system.\r\n * This can be used to distinguish multiple controllers.\r\n * Note that disconnecting a device and then connecting a new device may reuse the previous index.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#index\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "An integer that is unique for each Gamepad currently connected to the system.\rThis can be used to distinguish multiple controllers.\rNote that disconnecting a device and then connecting a new device may reuse the previous index.", "name": "index", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#index", "scope": "instance", "kind": "member", "___id": "T000002R022033", "___s": true }, { "comment": "/**\r\n * An array of Gamepad Button objects, corresponding to the different buttons available on the Gamepad.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#buttons\r\n * @type {Phaser.Input.Gamepad.Button[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 91, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "An array of Gamepad Button objects, corresponding to the different buttons available on the Gamepad.", "name": "buttons", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Input.Gamepad.Button", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#buttons", "scope": "instance", "kind": "member", "___id": "T000002R022037", "___s": true }, { "comment": "/**\r\n * An array of Gamepad Axis objects, corresponding to the different axes available on the Gamepad, if any.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#axes\r\n * @type {Phaser.Input.Gamepad.Axis[]}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "An array of Gamepad Axis objects, corresponding to the different axes available on the Gamepad, if any.", "name": "axes", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Input.Gamepad.Axis", "type": "NameExpression" } ] } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#axes", "scope": "instance", "kind": "member", "___id": "T000002R022041", "___s": true }, { "comment": "/**\r\n * The Gamepad's Haptic Actuator (Vibration / Rumble support).\r\n * This is highly experimental and only set if both present on the device,\r\n * and exposed by both the hardware and browser.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#vibration\r\n * @type {GamepadHapticActuator}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "The Gamepad's Haptic Actuator (Vibration / Rumble support).\rThis is highly experimental and only set if both present on the device,\rand exposed by both the hardware and browser.", "name": "vibration", "type": { "names": [ "GamepadHapticActuator" ], "parsedType": { "type": "NameExpression", "name": "GamepadHapticActuator" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#vibration", "scope": "instance", "kind": "member", "___id": "T000002R022043", "___s": true }, { "comment": "/**\r\n * A Vector2 containing the most recent values from the Gamepad's left axis stick.\r\n * This is updated automatically as part of the Gamepad.update cycle.\r\n * The H Axis is mapped to the `Vector2.x` property, and the V Axis to the `Vector2.y` property.\r\n * The values are based on the Axis thresholds.\r\n * If the Gamepad does not have a left axis stick, the values will always be zero.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#leftStick\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 293, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A Vector2 containing the most recent values from the Gamepad's left axis stick.\rThis is updated automatically as part of the Gamepad.update cycle.\rThe H Axis is mapped to the `Vector2.x` property, and the V Axis to the `Vector2.y` property.\rThe values are based on the Axis thresholds.\rIf the Gamepad does not have a left axis stick, the values will always be zero.", "name": "leftStick", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#leftStick", "scope": "instance", "kind": "member", "___id": "T000002R022082", "___s": true }, { "comment": "/**\r\n * A Vector2 containing the most recent values from the Gamepad's right axis stick.\r\n * This is updated automatically as part of the Gamepad.update cycle.\r\n * The H Axis is mapped to the `Vector2.x` property, and the V Axis to the `Vector2.y` property.\r\n * The values are based on the Axis thresholds.\r\n * If the Gamepad does not have a right axis stick, the values will always be zero.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#rightStick\r\n * @type {Phaser.Math.Vector2}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 306, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A Vector2 containing the most recent values from the Gamepad's right axis stick.\rThis is updated automatically as part of the Gamepad.update cycle.\rThe H Axis is mapped to the `Vector2.x` property, and the V Axis to the `Vector2.y` property.\rThe values are based on the Axis thresholds.\rIf the Gamepad does not have a right axis stick, the values will always be zero.", "name": "rightStick", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#rightStick", "scope": "instance", "kind": "member", "___id": "T000002R022084", "___s": true }, { "comment": "/**\r\n * Gets the total number of axis this Gamepad claims to support.\r\n *\r\n * @method Phaser.Input.Gamepad.Gamepad#getAxisTotal\r\n * @since 3.10.0\r\n *\r\n * @return {number} The total number of axes this Gamepad claims to support.\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 330, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Gets the total number of axis this Gamepad claims to support.", "kind": "function", "name": "getAxisTotal", "since": "3.10.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of axes this Gamepad claims to support." } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#getAxisTotal", "scope": "instance", "___id": "T000002R022088", "___s": true }, { "comment": "/**\r\n * Gets the value of an axis based on the given index.\r\n * The index must be valid within the range of axes supported by this Gamepad.\r\n * The return value will be a float between -1 and 1.\r\n *\r\n * @method Phaser.Input.Gamepad.Gamepad#getAxisValue\r\n * @since 3.10.0\r\n *\r\n * @param {number} index - The index of the axes to get the value for.\r\n *\r\n * @return {number} The value of the axis, between -1 and 1.\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 343, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Gets the value of an axis based on the given index.\rThe index must be valid within the range of axes supported by this Gamepad.\rThe return value will be a float between -1 and 1.", "kind": "function", "name": "getAxisValue", "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the axes to get the value for.", "name": "index" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value of the axis, between -1 and 1." } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#getAxisValue", "scope": "instance", "___id": "T000002R022090", "___s": true }, { "comment": "/**\r\n * Sets the threshold value of all axis on this Gamepad.\r\n * The value is a float between 0 and 1 and is the amount below which the axis is considered as not having been moved.\r\n *\r\n * @method Phaser.Input.Gamepad.Gamepad#setAxisThreshold\r\n * @since 3.10.0\r\n *\r\n * @param {number} value - A value between 0 and 1.\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 360, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Sets the threshold value of all axis on this Gamepad.\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "A value between 0 and 1.", "name": "value" } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#setAxisThreshold", "scope": "instance", "___id": "T000002R022092", "___s": true }, { "comment": "/**\r\n * Gets the total number of buttons this Gamepad claims to have.\r\n *\r\n * @method Phaser.Input.Gamepad.Gamepad#getButtonTotal\r\n * @since 3.10.0\r\n *\r\n * @return {number} The total number of buttons this Gamepad claims to have.\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 377, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Gets the total number of buttons this Gamepad claims to have.", "kind": "function", "name": "getButtonTotal", "since": "3.10.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of buttons this Gamepad claims to have." } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#getButtonTotal", "scope": "instance", "___id": "T000002R022096", "___s": true }, { "comment": "/**\r\n * Gets the value of a button based on the given index.\r\n * The index must be valid within the range of buttons supported by this Gamepad.\r\n *\r\n * The return value will be either 0 or 1 for a digital button, or a float between 0 and 1\r\n * for a pressure-sensitive analogue button, such as the shoulder buttons on a Dual Shock.\r\n *\r\n * @method Phaser.Input.Gamepad.Gamepad#getButtonValue\r\n * @since 3.10.0\r\n *\r\n * @param {number} index - The index of the button to get the value for.\r\n *\r\n * @return {number} The value of the button, between 0 and 1.\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 390, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Gets the value of a button based on the given index.\rThe index must be valid within the range of buttons supported by this Gamepad.\r\rThe return value will be either 0 or 1 for a digital button, or a float between 0 and 1\rfor a pressure-sensitive analogue button, such as the shoulder buttons on a Dual Shock.", "kind": "function", "name": "getButtonValue", "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the button to get the value for.", "name": "index" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The value of the button, between 0 and 1." } ], "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#getButtonValue", "scope": "instance", "___id": "T000002R022098", "___s": true }, { "comment": "/**\r\n * Returns if the button is pressed down or not.\r\n * The index must be valid within the range of buttons supported by this Gamepad.\r\n *\r\n * @method Phaser.Input.Gamepad.Gamepad#isButtonDown\r\n * @since 3.10.0\r\n *\r\n * @param {number} index - The index of the button to get the value for.\r\n *\r\n * @return {boolean} `true` if the button is considered as being pressed down, otherwise `false`.\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 409, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Returns if the button is pressed down or not.\rThe index must be valid within the range of buttons supported by this Gamepad.", "kind": "function", "name": "isButtonDown", "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the button to get the value for.", "name": "index" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R022100", "___s": true }, { "comment": "/**\r\n * Destroys this Gamepad instance, its buttons and axes, and releases external references it holds.\r\n *\r\n * @method Phaser.Input.Gamepad.Gamepad#destroy\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 477, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "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", "___id": "T000002R022113", "___s": true }, { "comment": "/**\r\n * Is this Gamepad currently connected or not?\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#connected\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 506, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Is this Gamepad currently connected or not?", "name": "connected", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#connected", "scope": "instance", "kind": "member", "___id": "T000002R022122", "___s": true }, { "comment": "/**\r\n * A timestamp containing the most recent time this Gamepad was updated.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#timestamp\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A timestamp containing the most recent time this Gamepad was updated.", "name": "timestamp", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#timestamp", "scope": "instance", "kind": "member", "___id": "T000002R022125", "___s": true }, { "comment": "/**\r\n * Is the Gamepad's Left button being pressed?\r\n * If the Gamepad doesn't have this button it will always return false.\r\n * This is the d-pad left button under standard Gamepad mapping.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#left\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 539, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Is the Gamepad's Left button being pressed?\rIf the Gamepad doesn't have this button it will always return false.\rThis is the d-pad left button under standard Gamepad mapping.", "name": "left", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#left", "scope": "instance", "kind": "member", "___id": "T000002R022128", "___s": true }, { "comment": "/**\r\n * Is the Gamepad's Right button being pressed?\r\n * If the Gamepad doesn't have this button it will always return false.\r\n * This is the d-pad right button under standard Gamepad mapping.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#right\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 557, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Is the Gamepad's Right button being pressed?\rIf the Gamepad doesn't have this button it will always return false.\rThis is the d-pad right button under standard Gamepad mapping.", "name": "right", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#right", "scope": "instance", "kind": "member", "___id": "T000002R022131", "___s": true }, { "comment": "/**\r\n * Is the Gamepad's Up button being pressed?\r\n * If the Gamepad doesn't have this button it will always return false.\r\n * This is the d-pad up button under standard Gamepad mapping.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#up\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 575, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Is the Gamepad's Up button being pressed?\rIf the Gamepad doesn't have this button it will always return false.\rThis is the d-pad up button under standard Gamepad mapping.", "name": "up", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#up", "scope": "instance", "kind": "member", "___id": "T000002R022134", "___s": true }, { "comment": "/**\r\n * Is the Gamepad's Down button being pressed?\r\n * If the Gamepad doesn't have this button it will always return false.\r\n * This is the d-pad down button under standard Gamepad mapping.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#down\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 593, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Is the Gamepad's Down button being pressed?\rIf the Gamepad doesn't have this button it will always return false.\rThis is the d-pad down button under standard Gamepad mapping.", "name": "down", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#down", "scope": "instance", "kind": "member", "___id": "T000002R022137", "___s": true }, { "comment": "/**\r\n * Is the Gamepad's bottom button in the right button cluster being pressed?\r\n * If the Gamepad doesn't have this button it will always return false.\r\n * On a Dual Shock controller it's the X button.\r\n * On an XBox controller it's the A button.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#A\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 611, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Is the Gamepad's bottom button in the right button cluster being pressed?\rIf the Gamepad doesn't have this button it will always return false.\rOn a Dual Shock controller it's the X button.\rOn an XBox controller it's the A button.", "name": "A", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#A", "scope": "instance", "kind": "member", "___id": "T000002R022140", "___s": true }, { "comment": "/**\r\n * Is the Gamepad's top button in the right button cluster being pressed?\r\n * If the Gamepad doesn't have this button it will always return false.\r\n * On a Dual Shock controller it's the Triangle button.\r\n * On an XBox controller it's the Y button.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#Y\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 630, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Is the Gamepad's top button in the right button cluster being pressed?\rIf the Gamepad doesn't have this button it will always return false.\rOn a Dual Shock controller it's the Triangle button.\rOn an XBox controller it's the Y button.", "name": "Y", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#Y", "scope": "instance", "kind": "member", "___id": "T000002R022143", "___s": true }, { "comment": "/**\r\n * Is the Gamepad's left button in the right button cluster being pressed?\r\n * If the Gamepad doesn't have this button it will always return false.\r\n * On a Dual Shock controller it's the Square button.\r\n * On an XBox controller it's the X button.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#X\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 649, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Is the Gamepad's left button in the right button cluster being pressed?\rIf the Gamepad doesn't have this button it will always return false.\rOn a Dual Shock controller it's the Square button.\rOn an XBox controller it's the X button.", "name": "X", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#X", "scope": "instance", "kind": "member", "___id": "T000002R022146", "___s": true }, { "comment": "/**\r\n * Is the Gamepad's right button in the right button cluster being pressed?\r\n * If the Gamepad doesn't have this button it will always return false.\r\n * On a Dual Shock controller it's the Circle button.\r\n * On an XBox controller it's the B button.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#B\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 668, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Is the Gamepad's right button in the right button cluster being pressed?\rIf the Gamepad doesn't have this button it will always return false.\rOn a Dual Shock controller it's the Circle button.\rOn an XBox controller it's the B button.", "name": "B", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#B", "scope": "instance", "kind": "member", "___id": "T000002R022149", "___s": true }, { "comment": "/**\r\n * Returns the value of the Gamepad's top left shoulder button.\r\n * If the Gamepad doesn't have this button it will always return zero.\r\n * The value is a float between 0 and 1, corresponding to how depressed the button is.\r\n * On a Dual Shock controller it's the L1 button.\r\n * On an XBox controller it's the LB button.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#L1\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 687, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Returns the value of the Gamepad's top left shoulder button.\rIf the Gamepad doesn't have this button it will always return zero.\rThe value is a float between 0 and 1, corresponding to how depressed the button is.\rOn a Dual Shock controller it's the L1 button.\rOn an XBox controller it's the LB button.", "name": "L1", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#L1", "scope": "instance", "kind": "member", "___id": "T000002R022152", "___s": true }, { "comment": "/**\r\n * Returns the value of the Gamepad's bottom left shoulder button.\r\n * If the Gamepad doesn't have this button it will always return zero.\r\n * The value is a float between 0 and 1, corresponding to how depressed the button is.\r\n * On a Dual Shock controller it's the L2 button.\r\n * On an XBox controller it's the LT button.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#L2\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 707, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Returns the value of the Gamepad's bottom left shoulder button.\rIf the Gamepad doesn't have this button it will always return zero.\rThe value is a float between 0 and 1, corresponding to how depressed the button is.\rOn a Dual Shock controller it's the L2 button.\rOn an XBox controller it's the LT button.", "name": "L2", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#L2", "scope": "instance", "kind": "member", "___id": "T000002R022155", "___s": true }, { "comment": "/**\r\n * Returns the value of the Gamepad's top right shoulder button.\r\n * If the Gamepad doesn't have this button it will always return zero.\r\n * The value is a float between 0 and 1, corresponding to how depressed the button is.\r\n * On a Dual Shock controller it's the R1 button.\r\n * On an XBox controller it's the RB button.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#R1\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 727, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Returns the value of the Gamepad's top right shoulder button.\rIf the Gamepad doesn't have this button it will always return zero.\rThe value is a float between 0 and 1, corresponding to how depressed the button is.\rOn a Dual Shock controller it's the R1 button.\rOn an XBox controller it's the RB button.", "name": "R1", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#R1", "scope": "instance", "kind": "member", "___id": "T000002R022158", "___s": true }, { "comment": "/**\r\n * Returns the value of the Gamepad's bottom right shoulder button.\r\n * If the Gamepad doesn't have this button it will always return zero.\r\n * The value is a float between 0 and 1, corresponding to how depressed the button is.\r\n * On a Dual Shock controller it's the R2 button.\r\n * On an XBox controller it's the RT button.\r\n *\r\n * @name Phaser.Input.Gamepad.Gamepad#R2\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Gamepad.js", "lineno": 747, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Returns the value of the Gamepad's bottom right shoulder button.\rIf the Gamepad doesn't have this button it will always return zero.\rThe value is a float between 0 and 1, corresponding to how depressed the button is.\rOn a Dual Shock controller it's the R2 button.\rOn an XBox controller it's the RT button.", "name": "R2", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.Gamepad", "longname": "Phaser.Input.Gamepad.Gamepad#R2", "scope": "instance", "kind": "member", "___id": "T000002R022161", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Gamepad Plugin is an input plugin that belongs to the Scene-owned Input system.\r\n *\r\n * Its role is to listen for native DOM Gamepad Events and then process them.\r\n *\r\n * You do not need to create this class directly, the Input system will create an instance of it automatically.\r\n *\r\n * You can access it from within a Scene using `this.input.gamepad`.\r\n *\r\n * To listen for a gamepad being connected:\r\n *\r\n * ```javascript\r\n * this.input.gamepad.once('connected', function (pad) {\r\n * // 'pad' is a reference to the gamepad that was just connected\r\n * });\r\n * ```\r\n *\r\n * Note that the browser may require you to press a button on a gamepad before it will allow you to access it,\r\n * this is for security reasons. However, it may also trust the page already, in which case you won't get the\r\n * 'connected' event and instead should check `GamepadPlugin.total` to see if it thinks there are any gamepads\r\n * already connected.\r\n *\r\n * Once you have received the connected event, or polled the gamepads and found them enabled, you can access\r\n * them via the built-in properties `GamepadPlugin.pad1` to `pad4`, for up to 4 game pads. With a reference\r\n * to the gamepads you can poll its buttons and axis sticks. See the properties and methods available on\r\n * the `Gamepad` class for more details.\r\n *\r\n * As of September 2020 Chrome, and likely other browsers, will soon start to require that games requesting\r\n * access to the Gamepad API are running under SSL. They will actively block API access if they are not.\r\n *\r\n * For more information about Gamepad support in browsers see the following resources:\r\n *\r\n * https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API\r\n * https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API/Using_the_Gamepad_API\r\n * https://www.smashingmagazine.com/2015/11/gamepad-api-in-web-games/\r\n * http://html5gamepad.com/\r\n *\r\n * @class GamepadPlugin\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Input.Gamepad\r\n * @constructor\r\n * @since 3.10.0\r\n *\r\n * @param {Phaser.Input.InputPlugin} sceneInputPlugin - A reference to the Scene Input Plugin that the GamepadPlugin belongs to.\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "classdesc": "The Gamepad Plugin is an input plugin that belongs to the Scene-owned Input system.\r\rIts role is to listen for native DOM Gamepad Events and then process them.\r\rYou do not need to create this class directly, the Input system will create an instance of it automatically.\r\rYou can access it from within a Scene using `this.input.gamepad`.\r\rTo listen for a gamepad being connected:\r\r```javascript\rthis.input.gamepad.once('connected', function (pad) {\r // 'pad' is a reference to the gamepad that was just connected\r});\r```\r\rNote that the browser may require you to press a button on a gamepad before it will allow you to access it,\rthis is for security reasons. However, it may also trust the page already, in which case you won't get the\r'connected' event and instead should check `GamepadPlugin.total` to see if it thinks there are any gamepads\ralready connected.\r\rOnce you have received the connected event, or polled the gamepads and found them enabled, you can access\rthem via the built-in properties `GamepadPlugin.pad1` to `pad4`, for up to 4 game pads. With a reference\rto the gamepads you can poll its buttons and axis sticks. See the properties and methods available on\rthe `Gamepad` class for more details.\r\rAs of September 2020 Chrome, and likely other browsers, will soon start to require that games requesting\raccess to the Gamepad API are running under SSL. They will actively block API access if they are not.\r\rFor more information about Gamepad support in browsers see the following resources:\r\rhttps://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API\rhttps://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API/Using_the_Gamepad_API\rhttps://www.smashingmagazine.com/2015/11/gamepad-api-in-web-games/\rhttp://html5gamepad.com/", "kind": "class", "name": "GamepadPlugin", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Input.Gamepad", "since": "3.10.0", "params": [ { "type": { "names": [ "Phaser.Input.InputPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputPlugin" } }, "description": "A reference to the Scene Input Plugin that the GamepadPlugin belongs to.", "name": "sceneInputPlugin" } ], "scope": "static", "longname": "Phaser.Input.Gamepad.GamepadPlugin", "___id": "T000002R022172", "___s": true }, { "comment": "/**\r\n * A reference to the Scene that this Input Plugin is responsible for.\r\n *\r\n * @name Phaser.Input.Gamepad.GamepadPlugin#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A reference to the Scene that this Input Plugin is responsible for.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "longname": "Phaser.Input.Gamepad.GamepadPlugin#scene", "scope": "instance", "kind": "member", "___id": "T000002R022176", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Systems Settings.\r\n *\r\n * @name Phaser.Input.Gamepad.GamepadPlugin#settings\r\n * @type {Phaser.Types.Scenes.SettingsObject}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 80, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A reference to the Scene Systems Settings.", "name": "settings", "type": { "names": [ "Phaser.Types.Scenes.SettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Scenes.SettingsObject" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "longname": "Phaser.Input.Gamepad.GamepadPlugin#settings", "scope": "instance", "kind": "member", "___id": "T000002R022178", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Input Plugin that created this Gamepad Plugin.\r\n *\r\n * @name Phaser.Input.Gamepad.GamepadPlugin#sceneInputPlugin\r\n * @type {Phaser.Input.InputPlugin}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 89, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A reference to the Scene Input Plugin that created this Gamepad Plugin.", "name": "sceneInputPlugin", "type": { "names": [ "Phaser.Input.InputPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputPlugin" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "longname": "Phaser.Input.Gamepad.GamepadPlugin#sceneInputPlugin", "scope": "instance", "kind": "member", "___id": "T000002R022180", "___s": true }, { "comment": "/**\r\n * A boolean that controls if the Gamepad Manager is enabled or not.\r\n * Can be toggled on the fly.\r\n *\r\n * @name Phaser.Input.Gamepad.GamepadPlugin#enabled\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.10.0\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 98, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A boolean that controls if the Gamepad Manager is enabled or not.\rCan be toggled on the fly.", "name": "enabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "longname": "Phaser.Input.Gamepad.GamepadPlugin#enabled", "scope": "instance", "kind": "member", "___id": "T000002R022182", "___s": true }, { "comment": "/**\r\n * The Gamepad Event target, as defined in the Game Config.\r\n * Typically the browser window, but can be any interactive DOM element.\r\n *\r\n * @name Phaser.Input.Gamepad.GamepadPlugin#target\r\n * @type {any}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 109, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "The Gamepad Event target, as defined in the Game Config.\rTypically the browser window, but can be any interactive DOM element.", "name": "target", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "longname": "Phaser.Input.Gamepad.GamepadPlugin#target", "scope": "instance", "kind": "member", "___id": "T000002R022184", "___s": true }, { "comment": "/**\r\n * An array of the connected Gamepads.\r\n *\r\n * @name Phaser.Input.Gamepad.GamepadPlugin#gamepads\r\n * @type {Phaser.Input.Gamepad.Gamepad[]}\r\n * @default []\r\n * @since 3.10.0\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 119, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "An array of the connected Gamepads.", "name": "gamepads", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Input.Gamepad.Gamepad", "type": "NameExpression" } ] } }, "defaultvalue": "[]", "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "longname": "Phaser.Input.Gamepad.GamepadPlugin#gamepads", "scope": "instance", "kind": "member", "___id": "T000002R022186", "___s": true }, { "comment": "/**\r\n * Checks to see if both this plugin and the Scene to which it belongs is active.\r\n *\r\n * @method Phaser.Input.Gamepad.GamepadPlugin#isActive\r\n * @since 3.10.0\r\n *\r\n * @return {boolean} `true` if the plugin and the Scene it belongs to is active.\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 234, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R022209", "___s": true }, { "comment": "/**\r\n * Disconnects all current Gamepads.\r\n *\r\n * @method Phaser.Input.Gamepad.GamepadPlugin#disconnectAll\r\n * @since 3.10.0\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 312, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "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", "___id": "T000002R022221", "___s": true }, { "comment": "/**\r\n * Returns an array of all currently connected Gamepads.\r\n *\r\n * @method Phaser.Input.Gamepad.GamepadPlugin#getAll\r\n * @since 3.10.0\r\n *\r\n * @return {Phaser.Input.Gamepad.Gamepad[]} An array of all currently connected Gamepads.\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 407, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Returns an array of all currently connected Gamepads.", "kind": "function", "name": "getAll", "since": "3.10.0", "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Input.Gamepad.Gamepad", "type": "NameExpression" } ] } }, "description": "An array of all currently connected Gamepads." } ], "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "longname": "Phaser.Input.Gamepad.GamepadPlugin#getAll", "scope": "instance", "___id": "T000002R022242", "___s": true }, { "comment": "/**\r\n * Looks up a single Gamepad based on the given index value.\r\n *\r\n * @method Phaser.Input.Gamepad.GamepadPlugin#getPad\r\n * @since 3.10.0\r\n *\r\n * @param {number} index - The index of the Gamepad to get.\r\n *\r\n * @return {Phaser.Input.Gamepad.Gamepad} The Gamepad matching the given index, or undefined if none were found.\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 431, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "Looks up a single Gamepad based on the given index value.", "kind": "function", "name": "getPad", "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the Gamepad to get.", "name": "index" } ], "returns": [ { "type": { "names": [ "Phaser.Input.Gamepad.Gamepad" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R022247", "___s": true }, { "comment": "/**\r\n * The total number of connected game pads.\r\n *\r\n * @name Phaser.Input.Gamepad.GamepadPlugin#total\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 542, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "The total number of connected game pads.", "name": "total", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "longname": "Phaser.Input.Gamepad.GamepadPlugin#total", "scope": "instance", "kind": "member", "___id": "T000002R022268", "___s": true }, { "comment": "/**\r\n * A reference to the first connected Gamepad.\r\n *\r\n * This will be undefined if either no pads are connected, or the browser\r\n * has not yet issued a gamepadconnected, which can happen even if a Gamepad\r\n * is plugged in, but hasn't yet had any buttons pressed on it.\r\n *\r\n * @name Phaser.Input.Gamepad.GamepadPlugin#pad1\r\n * @type {Phaser.Input.Gamepad.Gamepad}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 558, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A reference to the first connected Gamepad.\r\rThis will be undefined if either no pads are connected, or the browser\rhas not yet issued a gamepadconnected, which can happen even if a Gamepad\ris plugged in, but hasn't yet had any buttons pressed on it.", "name": "pad1", "type": { "names": [ "Phaser.Input.Gamepad.Gamepad" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad.Gamepad" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "longname": "Phaser.Input.Gamepad.GamepadPlugin#pad1", "scope": "instance", "kind": "member", "___id": "T000002R022271", "___s": true }, { "comment": "/**\r\n * A reference to the second connected Gamepad.\r\n *\r\n * This will be undefined if either no pads are connected, or the browser\r\n * has not yet issued a gamepadconnected, which can happen even if a Gamepad\r\n * is plugged in, but hasn't yet had any buttons pressed on it.\r\n *\r\n * @name Phaser.Input.Gamepad.GamepadPlugin#pad2\r\n * @type {Phaser.Input.Gamepad.Gamepad}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 578, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A reference to the second connected Gamepad.\r\rThis will be undefined if either no pads are connected, or the browser\rhas not yet issued a gamepadconnected, which can happen even if a Gamepad\ris plugged in, but hasn't yet had any buttons pressed on it.", "name": "pad2", "type": { "names": [ "Phaser.Input.Gamepad.Gamepad" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad.Gamepad" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "longname": "Phaser.Input.Gamepad.GamepadPlugin#pad2", "scope": "instance", "kind": "member", "___id": "T000002R022274", "___s": true }, { "comment": "/**\r\n * A reference to the third connected Gamepad.\r\n *\r\n * This will be undefined if either no pads are connected, or the browser\r\n * has not yet issued a gamepadconnected, which can happen even if a Gamepad\r\n * is plugged in, but hasn't yet had any buttons pressed on it.\r\n *\r\n * @name Phaser.Input.Gamepad.GamepadPlugin#pad3\r\n * @type {Phaser.Input.Gamepad.Gamepad}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 598, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A reference to the third connected Gamepad.\r\rThis will be undefined if either no pads are connected, or the browser\rhas not yet issued a gamepadconnected, which can happen even if a Gamepad\ris plugged in, but hasn't yet had any buttons pressed on it.", "name": "pad3", "type": { "names": [ "Phaser.Input.Gamepad.Gamepad" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad.Gamepad" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "longname": "Phaser.Input.Gamepad.GamepadPlugin#pad3", "scope": "instance", "kind": "member", "___id": "T000002R022277", "___s": true }, { "comment": "/**\r\n * A reference to the fourth connected Gamepad.\r\n *\r\n * This will be undefined if either no pads are connected, or the browser\r\n * has not yet issued a gamepadconnected, which can happen even if a Gamepad\r\n * is plugged in, but hasn't yet had any buttons pressed on it.\r\n *\r\n * @name Phaser.Input.Gamepad.GamepadPlugin#pad4\r\n * @type {Phaser.Input.Gamepad.Gamepad}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 618, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "A reference to the fourth connected Gamepad.\r\rThis will be undefined if either no pads are connected, or the browser\rhas not yet issued a gamepadconnected, which can happen even if a Gamepad\ris plugged in, but hasn't yet had any buttons pressed on it.", "name": "pad4", "type": { "names": [ "Phaser.Input.Gamepad.Gamepad" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad.Gamepad" } }, "since": "3.10.0", "memberof": "Phaser.Input.Gamepad.GamepadPlugin", "longname": "Phaser.Input.Gamepad.GamepadPlugin#pad4", "scope": "instance", "kind": "member", "___id": "T000002R022280", "___s": true }, { "comment": "/**\r\n * An instance of the Gamepad Plugin class, if enabled via the `input.gamepad` Scene or Game Config property.\r\n * Use this to access Gamepads connected to the browser and respond to gamepad buttons.\r\n *\r\n * @name Phaser.Input.InputPlugin#gamepad\r\n * @type {?Phaser.Input.Gamepad.GamepadPlugin}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "GamepadPlugin.js", "lineno": 640, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "description": "An instance of the Gamepad Plugin class, if enabled via the `input.gamepad` Scene or Game Config property.\rUse this to access Gamepads connected to the browser and respond to gamepad buttons.", "name": "gamepad", "type": { "names": [ "Phaser.Input.Gamepad.GamepadPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Gamepad.GamepadPlugin", "nullable": true } }, "nullable": true, "since": "3.10.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#gamepad", "scope": "instance", "kind": "member", "___id": "T000002R022283", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Input.Gamepad\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad", "code": {} }, "kind": "namespace", "name": "Gamepad", "memberof": "Phaser.Input", "longname": "Phaser.Input.Gamepad", "scope": "static", "___id": "T000002R022285", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Input.Gamepad\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\typedefs", "code": {} }, "kind": "namespace", "name": "Gamepad", "memberof": "Phaser.Types.Input", "longname": "Phaser.Types.Input.Gamepad", "scope": "static", "___id": "T000002R022293", "___s": true }, { "comment": "/**\r\n * The Gamepad object, as extracted from GamepadEvent.\r\n * \r\n * @typedef {object} Phaser.Types.Input.Gamepad.Pad\r\n * @since 3.10.0\r\n *\r\n * @property {string} id - The ID of the Gamepad.\r\n * @property {number} index - The index of the Gamepad.\r\n */", "meta": { "filename": "Pad.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\gamepad\\typedefs", "code": {} }, "description": "The Gamepad object, as extracted from GamepadEvent.", "kind": "typedef", "name": "Pad", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.10.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The ID of the Gamepad.", "name": "id" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The index of the Gamepad.", "name": "index" } ], "memberof": "Phaser.Types.Input.Gamepad", "longname": "Phaser.Types.Input.Gamepad.Pad", "scope": "static", "___id": "T000002R022294", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Input\r\n */", "meta": { "filename": "index.js", "lineno": 10, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "kind": "namespace", "name": "Input", "memberof": "Phaser", "longname": "Phaser.Input", "scope": "static", "___id": "T000002R022297", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Input Manager is responsible for handling the pointer related systems in a single Phaser Game instance.\r\n *\r\n * Based on the Game Config it will create handlers for mouse and touch support.\r\n *\r\n * Keyboard and Gamepad are plugins, handled directly by the InputPlugin class.\r\n *\r\n * It then manages the events, pointer creation and general hit test related operations.\r\n *\r\n * You rarely need to interact with the Input Manager directly, and as such, all of its properties and methods\r\n * should be considered private. Instead, you should use the Input Plugin, which is a Scene level system, responsible\r\n * for dealing with all input events for a Scene.\r\n *\r\n * @class InputManager\r\n * @memberof Phaser.Input\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - The Game instance that owns the Input Manager.\r\n * @param {object} config - The Input Configuration object, as set in the Game Config.\r\n */", "meta": { "filename": "InputManager.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "classdesc": "The Input Manager is responsible for handling the pointer related systems in a single Phaser Game instance.\r\rBased on the Game Config it will create handlers for mouse and touch support.\r\rKeyboard and Gamepad are plugins, handled directly by the InputPlugin class.\r\rIt then manages the events, pointer creation and general hit test related operations.\r\rYou rarely need to interact with the Input Manager directly, and as such, all of its properties and methods\rshould be considered private. Instead, you should use the Input Plugin, which is a Scene level system, responsible\rfor dealing with all input events for a Scene.", "kind": "class", "name": "InputManager", "memberof": "Phaser.Input", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "The Game instance that owns the Input Manager.", "name": "game" }, { "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "description": "The Input Configuration object, as set in the Game Config.", "name": "config" } ], "scope": "static", "longname": "Phaser.Input.InputManager", "___id": "T000002R022323", "___s": true }, { "comment": "/**\r\n * The Game instance that owns the Input Manager.\r\n * A Game only maintains one instance of the Input Manager at any time.\r\n *\r\n * @name Phaser.Input.InputManager#game\r\n * @type {Phaser.Game}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 47, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The Game instance that owns the Input Manager.\rA Game only maintains one instance of the Input Manager at any time.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#game", "scope": "instance", "kind": "member", "___id": "T000002R022326", "___s": true }, { "comment": "/**\r\n * A reference to the global Game Scale Manager.\r\n * Used for all bounds checks and pointer scaling.\r\n *\r\n * @name Phaser.Input.InputManager#scaleManager\r\n * @type {Phaser.Scale.ScaleManager}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 58, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A reference to the global Game Scale Manager.\rUsed for all bounds checks and pointer scaling.", "name": "scaleManager", "type": { "names": [ "Phaser.Scale.ScaleManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scale.ScaleManager" } }, "since": "3.16.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#scaleManager", "scope": "instance", "kind": "member", "___id": "T000002R022328", "___s": true }, { "comment": "/**\r\n * The Canvas that is used for all DOM event input listeners.\r\n *\r\n * @name Phaser.Input.InputManager#canvas\r\n * @type {HTMLCanvasElement}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 68, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The Canvas that is used for all DOM event input listeners.", "name": "canvas", "type": { "names": [ "HTMLCanvasElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLCanvasElement" } }, "since": "3.0.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#canvas", "scope": "instance", "kind": "member", "___id": "T000002R022330", "___s": true }, { "comment": "/**\r\n * The Game Configuration object, as set during the game boot.\r\n *\r\n * @name Phaser.Input.InputManager#config\r\n * @type {Phaser.Core.Config}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The Game Configuration object, as set during the game boot.", "name": "config", "type": { "names": [ "Phaser.Core.Config" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Core.Config" } }, "since": "3.0.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#config", "scope": "instance", "kind": "member", "___id": "T000002R022332", "___s": true }, { "comment": "/**\r\n * If set, the Input Manager will run its update loop every frame.\r\n *\r\n * @name Phaser.Input.InputManager#enabled\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "If set, the Input Manager will run its update loop every frame.", "name": "enabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#enabled", "scope": "instance", "kind": "member", "___id": "T000002R022334", "___s": true }, { "comment": "/**\r\n * The Event Emitter instance that the Input Manager uses to emit events from.\r\n *\r\n * @name Phaser.Input.InputManager#events\r\n * @type {Phaser.Events.EventEmitter}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The Event Emitter instance that the Input Manager uses to emit events from.", "name": "events", "type": { "names": [ "Phaser.Events.EventEmitter" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Events.EventEmitter" } }, "since": "3.0.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#events", "scope": "instance", "kind": "member", "___id": "T000002R022336", "___s": true }, { "comment": "/**\r\n * Are any mouse or touch pointers currently over the game canvas?\r\n * This is updated automatically by the canvas over and out handlers.\r\n *\r\n * @name Phaser.Input.InputManager#isOver\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 105, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Are any mouse or touch pointers currently over the game canvas?\rThis is updated automatically by the canvas over and out handlers.", "name": "isOver", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#isOver", "scope": "instance", "kind": "member", "___id": "T000002R022338", "___s": true }, { "comment": "/**\r\n * The default CSS cursor to be used when interacting with your game.\r\n *\r\n * See the `setDefaultCursor` method for more details.\r\n *\r\n * @name Phaser.Input.InputManager#defaultCursor\r\n * @type {string}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The default CSS cursor to be used when interacting with your game.\r\rSee the `setDefaultCursor` method for more details.", "name": "defaultCursor", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.10.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#defaultCursor", "scope": "instance", "kind": "member", "___id": "T000002R022340", "___s": true }, { "comment": "/**\r\n * A reference to the Keyboard Manager class, if enabled via the `input.keyboard` Game Config property.\r\n *\r\n * @name Phaser.Input.InputManager#keyboard\r\n * @type {?Phaser.Input.Keyboard.KeyboardManager}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 127, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.KeyboardManager", "nullable": true } }, "nullable": true, "since": "3.16.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#keyboard", "scope": "instance", "kind": "member", "___id": "T000002R022342", "___s": true }, { "comment": "/**\r\n * A reference to the Mouse Manager class, if enabled via the `input.mouse` Game Config property.\r\n *\r\n * @name Phaser.Input.InputManager#mouse\r\n * @type {?Phaser.Input.Mouse.MouseManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Mouse.MouseManager", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#mouse", "scope": "instance", "kind": "member", "___id": "T000002R022344", "___s": true }, { "comment": "/**\r\n * A reference to the Touch Manager class, if enabled via the `input.touch` Game Config property.\r\n *\r\n * @name Phaser.Input.InputManager#touch\r\n * @type {Phaser.Input.Touch.TouchManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Touch.TouchManager" } }, "since": "3.0.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#touch", "scope": "instance", "kind": "member", "___id": "T000002R022346", "___s": true }, { "comment": "/**\r\n * An array of Pointers that have been added to the game.\r\n * The first entry is reserved for the Mouse Pointer, the rest are Touch Pointers.\r\n *\r\n * By default there is 1 touch pointer enabled. If you need more use the `addPointer` method to start them,\r\n * or set the `input.activePointers` property in the Game Config.\r\n *\r\n * @name Phaser.Input.InputManager#pointers\r\n * @type {Phaser.Input.Pointer[]}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 154, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "An array of Pointers that have been added to the game.\rThe first entry is reserved for the Mouse Pointer, the rest are Touch Pointers.\r\rBy default there is 1 touch pointer enabled. If you need more use the `addPointer` method to start them,\ror set the `input.activePointers` property in the Game Config.", "name": "pointers", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Input.Pointer", "type": "NameExpression" } ] } }, "since": "3.10.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#pointers", "scope": "instance", "kind": "member", "___id": "T000002R022348", "___s": true }, { "comment": "/**\r\n * The number of touch objects activated and being processed each update.\r\n *\r\n * You can change this by either calling `addPointer` at run-time, or by\r\n * setting the `input.activePointers` property in the Game Config.\r\n *\r\n * @name Phaser.Input.InputManager#pointersTotal\r\n * @type {number}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 167, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The number of touch objects activated and being processed each update.\r\rYou can change this by either calling `addPointer` at run-time, or by\rsetting the `input.activePointers` property in the Game Config.", "name": "pointersTotal", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#pointersTotal", "scope": "instance", "kind": "member", "___id": "T000002R022350", "___s": true }, { "comment": "/**\r\n * The mouse has its own unique Pointer object, which you can reference directly if making a _desktop specific game_.\r\n * If you are supporting both desktop and touch devices then do not use this property, instead use `activePointer`\r\n * which will always map to the most recently interacted pointer.\r\n *\r\n * @name Phaser.Input.InputManager#mousePointer\r\n * @type {?Phaser.Input.Pointer}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 189, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The mouse has its own unique Pointer object, which you can reference directly if making a _desktop specific game_.\rIf you are supporting both desktop and touch devices then do not use this property, instead use `activePointer`\rwhich will always map to the most recently interacted pointer.", "name": "mousePointer", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer", "nullable": true } }, "nullable": true, "since": "3.10.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#mousePointer", "scope": "instance", "kind": "member", "___id": "T000002R022355", "___s": true }, { "comment": "/**\r\n * The most recently active Pointer object.\r\n *\r\n * If you've only 1 Pointer in your game then this will accurately be either the first finger touched, or the mouse.\r\n *\r\n * If your game doesn't need to support multi-touch then you can safely use this property in all of your game\r\n * code and it will adapt to be either the mouse or the touch, based on device.\r\n *\r\n * @name Phaser.Input.InputManager#activePointer\r\n * @type {Phaser.Input.Pointer}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 200, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The most recently active Pointer object.\r\rIf you've only 1 Pointer in your game then this will accurately be either the first finger touched, or the mouse.\r\rIf your game doesn't need to support multi-touch then you can safely use this property in all of your game\rcode and it will adapt to be either the mouse or the touch, based on device.", "name": "activePointer", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "since": "3.0.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#activePointer", "scope": "instance", "kind": "member", "___id": "T000002R022357", "___s": true }, { "comment": "/**\r\n * If the top-most Scene in the Scene List receives an input it will stop input from\r\n * propagating any lower down the scene list, i.e. if you have a UI Scene at the top\r\n * and click something on it, that click will not then be passed down to any other\r\n * Scene below. Disable this to have input events passed through all Scenes, all the time.\r\n *\r\n * @name Phaser.Input.InputManager#globalTopOnly\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 214, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "If the top-most Scene in the Scene List receives an input it will stop input from\rpropagating any lower down the scene list, i.e. if you have a UI Scene at the top\rand click something on it, that click will not then be passed down to any other\rScene below. Disable this to have input events passed through all Scenes, all the time.", "name": "globalTopOnly", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#globalTopOnly", "scope": "instance", "kind": "member", "___id": "T000002R022359", "___s": true }, { "comment": "/**\r\n * The time this Input Manager was last updated.\r\n * This value is populated by the Game Step each frame.\r\n *\r\n * @name Phaser.Input.InputManager#time\r\n * @type {number}\r\n * @readonly\r\n * @since 3.16.2\r\n */", "meta": { "filename": "InputManager.js", "lineno": 227, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The time this Input Manager was last updated.\rThis value is populated by the Game Step each frame.", "name": "time", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.16.2", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#time", "scope": "instance", "kind": "member", "___id": "T000002R022361", "___s": true }, { "comment": "/**\r\n * The Boot handler is called by Phaser.Game when it first starts up.\r\n * The renderer is available by now.\r\n *\r\n * @method Phaser.Input.InputManager#boot\r\n * @protected\r\n * @fires Phaser.Input.Events#MANAGER_BOOT\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 302, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The Boot handler is called by Phaser.Game when it first starts up.\rThe renderer is available by now.", "kind": "function", "name": "boot", "access": "protected", "fires": [ "Phaser.Input.Events#event:MANAGER_BOOT" ], "since": "3.0.0", "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#boot", "scope": "instance", "___id": "T000002R022377", "___s": true }, { "comment": "/**\r\n * Tells the Input system to set a custom cursor.\r\n *\r\n * This cursor will be the default cursor used when interacting with the game canvas.\r\n *\r\n * If an Interactive Object also sets a custom cursor, this is the cursor that is reset after its use.\r\n *\r\n * Any valid CSS cursor value is allowed, including paths to image files, i.e.:\r\n *\r\n * ```javascript\r\n * this.input.setDefaultCursor('url(assets/cursors/sword.cur), pointer');\r\n * ```\r\n *\r\n * Please read about the differences between browsers when it comes to the file formats and sizes they support:\r\n *\r\n * https://developer.mozilla.org/en-US/docs/Web/CSS/cursor\r\n * https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_User_Interface/Using_URL_values_for_the_cursor_property\r\n *\r\n * It's up to you to pick a suitable cursor format that works across the range of browsers you need to support.\r\n *\r\n * @method Phaser.Input.InputManager#setDefaultCursor\r\n * @since 3.10.0\r\n *\r\n * @param {string} cursor - The CSS to be used when setting the default cursor.\r\n */", "meta": { "filename": "InputManager.js", "lineno": 390, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Tells the Input system to set a custom cursor.\r\rThis cursor will be the default cursor used when interacting with the game canvas.\r\rIf an Interactive Object also sets a custom cursor, this is the cursor that is reset after its use.\r\rAny valid CSS cursor value is allowed, including paths to image files, i.e.:\r\r```javascript\rthis.input.setDefaultCursor('url(assets/cursors/sword.cur), pointer');\r```\r\rPlease read about the differences between browsers when it comes to the file formats and sizes they support:\r\rhttps://developer.mozilla.org/en-US/docs/Web/CSS/cursor\rhttps://developer.mozilla.org/en-US/docs/Web/CSS/CSS_User_Interface/Using_URL_values_for_the_cursor_property\r\rIt'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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R022397", "___s": true }, { "comment": "/**\r\n * Adds new Pointer objects to the Input Manager.\r\n *\r\n * By default Phaser creates 2 pointer objects: `mousePointer` and `pointer1`.\r\n *\r\n * You can create more either by calling this method, or by setting the `input.activePointers` property\r\n * in the Game Config, up to a maximum of 10 pointers.\r\n *\r\n * The first 10 pointers are available via the `InputPlugin.pointerX` properties, once they have been added\r\n * via this method.\r\n *\r\n * @method Phaser.Input.InputManager#addPointer\r\n * @since 3.10.0\r\n *\r\n * @param {number} [quantity=1] The number of new Pointers to create. A maximum of 10 is allowed in total.\r\n *\r\n * @return {Phaser.Input.Pointer[]} An array containing all of the new Pointer objects that were created.\r\n */", "meta": { "filename": "InputManager.js", "lineno": 466, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Adds new Pointer objects to the Input Manager.\r\rBy default Phaser creates 2 pointer objects: `mousePointer` and `pointer1`.\r\rYou can create more either by calling this method, or by setting the `input.activePointers` property\rin the Game Config, up to a maximum of 10 pointers.\r\rThe first 10 pointers are available via the `InputPlugin.pointerX` properties, once they have been added\rvia this method.", "kind": "function", "name": "addPointer", "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Input.Pointer", "type": "NameExpression" } ] } }, "description": "An array containing all of the new Pointer objects that were created." } ], "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#addPointer", "scope": "instance", "___id": "T000002R022407", "___s": true }, { "comment": "/**\r\n * Internal method that gets a list of all the active Input Plugins in the game\r\n * and updates each of them in turn, in reverse order (top to bottom), to allow\r\n * for DOM top-level event handling simulation.\r\n *\r\n * @method Phaser.Input.InputManager#updateInputPlugins\r\n * @since 3.16.0\r\n *\r\n * @param {number} type - The type of event to process.\r\n * @param {Phaser.Input.Pointer[]} pointers - An array of Pointers on which the event occurred.\r\n */", "meta": { "filename": "InputManager.js", "lineno": 513, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Internal method that gets a list of all the active Input Plugins in the game\rand updates each of them in turn, in reverse order (top to bottom), to allow\rfor DOM top-level event handling simulation.", "kind": "function", "name": "updateInputPlugins", "since": "3.16.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The type of event to process.", "name": "type" }, { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Input.Pointer", "type": "NameExpression" } ] } }, "description": "An array of Pointers on which the event occurred.", "name": "pointers" } ], "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#updateInputPlugins", "scope": "instance", "___id": "T000002R022416", "___s": true }, { "comment": "/**\r\n * Performs a hit test using the given Pointer and camera, against an array of interactive Game Objects.\r\n *\r\n * The Game Objects are culled against the camera, and then the coordinates are translated into the local camera space\r\n * and used to determine if they fall within the remaining Game Objects hit areas or not.\r\n *\r\n * If nothing is matched an empty array is returned.\r\n *\r\n * This method is called automatically by InputPlugin.hitTestPointer and doesn't usually need to be invoked directly.\r\n *\r\n * @method Phaser.Input.InputManager#hitTest\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer to test against.\r\n * @param {array} gameObjects - An array of interactive Game Objects to check.\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera which is being tested against.\r\n * @param {array} [output] - An array to store the results in. If not given, a new empty array is created.\r\n *\r\n * @return {array} An array of the Game Objects that were hit during this hit test.\r\n */", "meta": { "filename": "InputManager.js", "lineno": 868, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Performs a hit test using the given Pointer and camera, against an array of interactive Game Objects.\r\rThe Game Objects are culled against the camera, and then the coordinates are translated into the local camera space\rand used to determine if they fall within the remaining Game Objects hit areas or not.\r\rIf nothing is matched an empty array is returned.\r\rThis 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer to test against.", "name": "pointer" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of interactive Game Objects to check.", "name": "gameObjects" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera which is being tested against.", "name": "camera" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R022486", "___s": true }, { "comment": "/**\r\n * Checks if the given x and y coordinate are within the hit area of the Game Object.\r\n *\r\n * This method assumes that the coordinate values have already been translated into the space of the Game Object.\r\n *\r\n * If the coordinates are within the hit area they are set into the Game Objects Input `localX` and `localY` properties.\r\n *\r\n * @method Phaser.Input.InputManager#pointWithinHitArea\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The interactive Game Object to check against.\r\n * @param {number} x - The translated x coordinate for the hit test.\r\n * @param {number} y - The translated y coordinate for the hit test.\r\n *\r\n * @return {boolean} `true` if the coordinates were inside the Game Objects hit area, otherwise `false`.\r\n */", "meta": { "filename": "InputManager.js", "lineno": 947, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Checks if the given x and y coordinate are within the hit area of the Game Object.\r\rThis method assumes that the coordinate values have already been translated into the space of the Game Object.\r\rIf 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The interactive Game Object to check against.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The translated x coordinate for the hit test.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The translated y coordinate for the hit test.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R022506", "___s": true }, { "comment": "/**\r\n * Checks if the given x and y coordinate are within the hit area of the Interactive Object.\r\n *\r\n * This method assumes that the coordinate values have already been translated into the space of the Interactive Object.\r\n *\r\n * If the coordinates are within the hit area they are set into the Interactive Objects Input `localX` and `localY` properties.\r\n *\r\n * @method Phaser.Input.InputManager#pointWithinInteractiveObject\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Types.Input.InteractiveObject} object - The Interactive Object to check against.\r\n * @param {number} x - The translated x coordinate for the hit test.\r\n * @param {number} y - The translated y coordinate for the hit test.\r\n *\r\n * @return {boolean} `true` if the coordinates were inside the Interactive Object's hit area, otherwise `false`.\r\n */", "meta": { "filename": "InputManager.js", "lineno": 984, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Checks if the given x and y coordinate are within the hit area of the Interactive Object.\r\rThis method assumes that the coordinate values have already been translated into the space of the Interactive Object.\r\rIf 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.InteractiveObject" } }, "description": "The Interactive Object to check against.", "name": "object" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The translated x coordinate for the hit test.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The translated y coordinate for the hit test.", "name": "y" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the coordinates were inside the Interactive Object's hit area, otherwise `false`." } ], "memberof": "Phaser.Input.InputManager", "longname": "Phaser.Input.InputManager#pointWithinInteractiveObject", "scope": "instance", "___id": "T000002R022513", "___s": true }, { "comment": "/**\r\n * Transforms the pageX and pageY values of a Pointer into the scaled coordinate space of the Input Manager.\r\n *\r\n * @method Phaser.Input.InputManager#transformPointer\r\n * @since 3.10.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer to transform the values for.\r\n * @param {number} pageX - The Page X value.\r\n * @param {number} pageY - The Page Y value.\r\n * @param {boolean} wasMove - Are we transforming the Pointer from a move event, or an up / down event?\r\n */", "meta": { "filename": "InputManager.js", "lineno": 1017, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer to transform the values for.", "name": "pointer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Page X value.", "name": "pageX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The Page Y value.", "name": "pageY" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R022519", "___s": true }, { "comment": "/**\r\n * Destroys the Input Manager and all of its systems.\r\n *\r\n * There is no way to recover from doing this.\r\n *\r\n * @method Phaser.Input.InputManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputManager.js", "lineno": 1057, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Destroys the Input Manager and all of its systems.\r\rThere 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", "___id": "T000002R022532", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Input Plugin belongs to a Scene and handles all input related events and operations for it.\r\n *\r\n * You can access it from within a Scene using `this.input`.\r\n *\r\n * It emits events directly. For example, you can do:\r\n *\r\n * ```javascript\r\n * this.input.on('pointerdown', callback, context);\r\n * ```\r\n *\r\n * To listen for a pointer down event anywhere on the game canvas.\r\n *\r\n * Game Objects can be enabled for input by calling their `setInteractive` method. After which they\r\n * will directly emit input events:\r\n *\r\n * ```javascript\r\n * var sprite = this.add.sprite(x, y, texture);\r\n * sprite.setInteractive();\r\n * sprite.on('pointerdown', callback, context);\r\n * ```\r\n *\r\n * There are lots of game configuration options available relating to input.\r\n * See the [Input Config object]{@linkcode Phaser.Types.Core.InputConfig} for more details, including how to deal with Phaser\r\n * listening for input events outside of the canvas, how to set a default number of pointers, input\r\n * capture settings and more.\r\n *\r\n * Please also see the Input examples and tutorials for further information.\r\n *\r\n * **Incorrect input coordinates with Angular**\r\n *\r\n * If you are using Phaser within Angular, and use nglf or the router, to make the component in which the Phaser game resides\r\n * change state (i.e. appear or disappear) then you'll need to notify the Scale Manager about this, as Angular will mess with\r\n * the DOM in a way in which Phaser can't detect directly. Call `this.scale.updateBounds()` as part of your game init in order\r\n * to refresh the canvas DOM bounds values, which Phaser uses for input point position calculations.\r\n *\r\n * @class InputPlugin\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Input\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Scene} scene - A reference to the Scene that this Input Plugin is responsible for.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 29, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "classdesc": "The Input Plugin belongs to a Scene and handles all input related events and operations for it.\r\rYou can access it from within a Scene using `this.input`.\r\rIt emits events directly. For example, you can do:\r\r```javascript\rthis.input.on('pointerdown', callback, context);\r```\r\rTo listen for a pointer down event anywhere on the game canvas.\r\rGame Objects can be enabled for input by calling their `setInteractive` method. After which they\rwill directly emit input events:\r\r```javascript\rvar sprite = this.add.sprite(x, y, texture);\rsprite.setInteractive();\rsprite.on('pointerdown', callback, context);\r```\r\rThere are lots of game configuration options available relating to input.\rSee the [Input Config object]{@linkcode Phaser.Types.Core.InputConfig} for more details, including how to deal with Phaser\rlistening for input events outside of the canvas, how to set a default number of pointers, input\rcapture settings and more.\r\rPlease also see the Input examples and tutorials for further information.\r\r**Incorrect input coordinates with Angular**\r\rIf you are using Phaser within Angular, and use nglf or the router, to make the component in which the Phaser game resides\rchange state (i.e. appear or disappear) then you'll need to notify the Scale Manager about this, as Angular will mess with\rthe DOM in a way in which Phaser can't detect directly. Call `this.scale.updateBounds()` as part of your game init in order\rto refresh the canvas DOM bounds values, which Phaser uses for input point position calculations.", "kind": "class", "name": "InputPlugin", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Input", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "description": "A reference to the Scene that this Input Plugin is responsible for.", "name": "scene" } ], "scope": "static", "longname": "Phaser.Input.InputPlugin", "___id": "T000002R022561", "___s": true }, { "comment": "/**\r\n * A reference to the Scene that this Input Plugin is responsible for.\r\n *\r\n * @name Phaser.Input.InputPlugin#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A reference to the Scene that this Input Plugin is responsible for.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.0.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#scene", "scope": "instance", "kind": "member", "___id": "T000002R022565", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Systems class.\r\n *\r\n * @name Phaser.Input.InputPlugin#systems\r\n * @type {Phaser.Scenes.Systems}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 93, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A reference to the Scene Systems class.", "name": "systems", "type": { "names": [ "Phaser.Scenes.Systems" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scenes.Systems" } }, "since": "3.0.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#systems", "scope": "instance", "kind": "member", "___id": "T000002R022567", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Systems Settings.\r\n *\r\n * @name Phaser.Input.InputPlugin#settings\r\n * @type {Phaser.Types.Scenes.SettingsObject}\r\n * @since 3.5.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 102, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A reference to the Scene Systems Settings.", "name": "settings", "type": { "names": [ "Phaser.Types.Scenes.SettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Scenes.SettingsObject" } }, "since": "3.5.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#settings", "scope": "instance", "kind": "member", "___id": "T000002R022569", "___s": true }, { "comment": "/**\r\n * A reference to the Game Input Manager.\r\n *\r\n * @name Phaser.Input.InputPlugin#manager\r\n * @type {Phaser.Input.InputManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 111, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A reference to the Game Input Manager.", "name": "manager", "type": { "names": [ "Phaser.Input.InputManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputManager" } }, "since": "3.0.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#manager", "scope": "instance", "kind": "member", "___id": "T000002R022571", "___s": true }, { "comment": "/**\r\n * If `true` this Input Plugin will process DOM input events.\r\n *\r\n * @name Phaser.Input.InputPlugin#enabled\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.5.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 130, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "If `true` this Input Plugin will process DOM input events.", "name": "enabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.5.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#enabled", "scope": "instance", "kind": "member", "___id": "T000002R022575", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Display List. This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Input.InputPlugin#displayList\r\n * @type {Phaser.GameObjects.DisplayList}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A reference to the Scene Display List. This property is set during the `boot` method.", "name": "displayList", "type": { "names": [ "Phaser.GameObjects.DisplayList" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.DisplayList" } }, "since": "3.0.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#displayList", "scope": "instance", "kind": "member", "___id": "T000002R022577", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Cameras Manager. This property is set during the `boot` method.\r\n *\r\n * @name Phaser.Input.InputPlugin#cameras\r\n * @type {Phaser.Cameras.Scene2D.CameraManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A reference to the Scene Cameras Manager. This property is set during the `boot` method.", "name": "cameras", "type": { "names": [ "Phaser.Cameras.Scene2D.CameraManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.CameraManager" } }, "since": "3.0.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#cameras", "scope": "instance", "kind": "member", "___id": "T000002R022579", "___s": true }, { "comment": "/**\r\n * A reference to the Mouse Manager.\r\n *\r\n * This property is only set if Mouse support has been enabled in your Game Configuration file.\r\n *\r\n * If you just wish to get access to the mouse pointer, use the `mousePointer` property instead.\r\n *\r\n * @name Phaser.Input.InputPlugin#mouse\r\n * @type {?Phaser.Input.Mouse.MouseManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 161, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A reference to the Mouse Manager.\r\rThis property is only set if Mouse support has been enabled in your Game Configuration file.\r\rIf you just wish to get access to the mouse pointer, use the `mousePointer` property instead.", "name": "mouse", "type": { "names": [ "Phaser.Input.Mouse.MouseManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Mouse.MouseManager", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#mouse", "scope": "instance", "kind": "member", "___id": "T000002R022581", "___s": true }, { "comment": "/**\r\n * When set to `true` (the default) the Input Plugin will emulate DOM behavior by only emitting events from\r\n * the top-most Game Objects in the Display List.\r\n *\r\n * If set to `false` it will emit events from all Game Objects below a Pointer, not just the top one.\r\n *\r\n * @name Phaser.Input.InputPlugin#topOnly\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 174, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "When set to `true` (the default) the Input Plugin will emulate DOM behavior by only emitting events from\rthe top-most Game Objects in the Display List.\r\rIf set to `false` it will emit events from all Game Objects below a Pointer, not just the top one.", "name": "topOnly", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#topOnly", "scope": "instance", "kind": "member", "___id": "T000002R022583", "___s": true }, { "comment": "/**\r\n * How often should the Pointers be checked?\r\n *\r\n * The value is a time, given in ms, and is the time that must have elapsed between game steps before\r\n * the Pointers will be polled again. When a pointer is polled it runs a hit test to see which Game\r\n * Objects are currently below it, or being interacted with it.\r\n *\r\n * Pointers will *always* be checked if they have been moved by the user, or press or released.\r\n *\r\n * This property only controls how often they will be polled if they have not been updated.\r\n * You should set this if you want to have Game Objects constantly check against the pointers, even\r\n * if the pointer didn't itself move.\r\n *\r\n * Set to 0 to poll constantly. Set to -1 to only poll on user movement.\r\n *\r\n * @name Phaser.Input.InputPlugin#pollRate\r\n * @type {number}\r\n * @default -1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 187, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "How often should the Pointers be checked?\r\rThe value is a time, given in ms, and is the time that must have elapsed between game steps before\rthe Pointers will be polled again. When a pointer is polled it runs a hit test to see which Game\rObjects are currently below it, or being interacted with it.\r\rPointers will *always* be checked if they have been moved by the user, or press or released.\r\rThis property only controls how often they will be polled if they have not been updated.\rYou should set this if you want to have Game Objects constantly check against the pointers, even\rif the pointer didn't itself move.\r\rSet to 0 to poll constantly. Set to -1 to only poll on user movement.", "name": "pollRate", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#pollRate", "scope": "instance", "kind": "member", "___id": "T000002R022585", "___s": true }, { "comment": "/**\r\n * The distance, in pixels, a pointer has to move while being held down, before it thinks it is being dragged.\r\n *\r\n * @name Phaser.Input.InputPlugin#dragDistanceThreshold\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 247, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#dragDistanceThreshold", "scope": "instance", "kind": "member", "___id": "T000002R022597", "___s": true }, { "comment": "/**\r\n * The amount of time, in ms, a pointer has to be held down before it thinks it is dragging.\r\n *\r\n * The default polling rate is to poll only on move so once the time threshold is reached the\r\n * drag event will not start until you move the mouse. If you want it to start immediately\r\n * when the time threshold is reached, you must increase the polling rate by calling\r\n * [setPollAlways]{@linkcode Phaser.Input.InputPlugin#setPollAlways} or\r\n * [setPollRate]{@linkcode Phaser.Input.InputPlugin#setPollRate}.\r\n *\r\n * @name Phaser.Input.InputPlugin#dragTimeThreshold\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 257, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The amount of time, in ms, a pointer has to be held down before it thinks it is dragging.\r\rThe default polling rate is to poll only on move so once the time threshold is reached the\rdrag event will not start until you move the mouse. If you want it to start immediately\rwhen the time threshold is reached, you must increase the polling rate by calling\r[setPollAlways]{@linkcode Phaser.Input.InputPlugin#setPollAlways} or\r[setPollRate]{@linkcode Phaser.Input.InputPlugin#setPollRate}.", "name": "dragTimeThreshold", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#dragTimeThreshold", "scope": "instance", "kind": "member", "___id": "T000002R022599", "___s": true }, { "comment": "/**\r\n * Checks to see if the Input Manager, this plugin and the Scene to which it belongs are all active and input enabled.\r\n *\r\n * @method Phaser.Input.InputPlugin#isActive\r\n * @since 3.10.0\r\n *\r\n * @return {boolean} `true` if the plugin and the Scene it belongs to is active.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 528, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Checks to see if the Input Manager, this plugin and the Scene to which it belongs are all active and input enabled.", "kind": "function", "name": "isActive", "since": "3.10.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R022670", "___s": true }, { "comment": "/**\r\n * Sets a custom cursor on the parent canvas element of the game, based on the `cursor`\r\n * setting of the given Interactive Object (i.e. a Sprite).\r\n * \r\n * See the CSS property `cursor` for more information on MDN:\r\n *\r\n * https://developer.mozilla.org/en-US/docs/Web/CSS/cursor\r\n *\r\n * @method Phaser.Input.InputPlugin#setCursor\r\n * @since 3.85.0\r\n *\r\n * @param {Phaser.Types.Input.InteractiveObject} interactiveObject - The Interactive Object that will set the cursor on the canvas.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 541, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Sets a custom cursor on the parent canvas element of the game, based on the `cursor`\rsetting of the given Interactive Object (i.e. a Sprite).\r\rSee the CSS property `cursor` for more information on MDN:\r\rhttps://developer.mozilla.org/en-US/docs/Web/CSS/cursor", "kind": "function", "name": "setCursor", "since": "3.85.0", "params": [ { "type": { "names": [ "Phaser.Types.Input.InteractiveObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.InteractiveObject" } }, "description": "The Interactive Object that will set the cursor on the canvas.", "name": "interactiveObject" } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setCursor", "scope": "instance", "___id": "T000002R022672", "___s": true }, { "comment": "/**\r\n * Forces the Input Manager to clear the custom or hand cursor, regardless of the\r\n * interactive state of any Game Objects.\r\n *\r\n * @method Phaser.Input.InputPlugin#resetCursor\r\n * @since 3.85.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 562, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Forces the Input Manager to clear the custom or hand cursor, regardless of the\rinteractive state of any Game Objects.", "kind": "function", "name": "resetCursor", "since": "3.85.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#resetCursor", "scope": "instance", "___id": "T000002R022674", "___s": true }, { "comment": "/**\r\n * This is called automatically by the Input Manager.\r\n * It emits events for plugins to listen to and also handles polling updates, if enabled.\r\n *\r\n * @method Phaser.Input.InputPlugin#updatePoll\r\n * @since 3.18.0\r\n *\r\n * @param {number} time - The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.\r\n * @param {number} delta - The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate.\r\n *\r\n * @return {boolean} `true` if the plugin and the Scene it belongs to is active.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 577, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "This is called automatically by the Input Manager.\rIt 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R022676", "___s": true }, { "comment": "/**\r\n * Clears a Game Object so it no longer has an Interactive Object associated with it.\r\n * The Game Object is then queued for removal from the Input Plugin on the next update.\r\n *\r\n * @method Phaser.Input.InputPlugin#clear\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will have its Interactive Object removed.\r\n * @param {boolean} [skipQueue=false] - Skip adding this Game Object into the removal queue?\r\n *\r\n * @return {Phaser.GameObjects.GameObject} The Game Object that had its Interactive Object removed.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 797, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Clears a Game Object so it no longer has an Interactive Object associated with it.\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that will have its Interactive Object removed.", "name": "gameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Skip adding this Game Object into the removal queue?", "name": "skipQueue" } ], "returns": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that had its Interactive Object removed." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#clear", "scope": "instance", "___id": "T000002R022720", "___s": true }, { "comment": "/**\r\n * Disables Input on a single Game Object.\r\n *\r\n * An input disabled Game Object still retains its Interactive Object component and can be re-enabled\r\n * at any time, by passing it to `InputPlugin.enable`.\r\n *\r\n * @method Phaser.Input.InputPlugin#disable\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to have its input system disabled.\r\n * @param {boolean} [resetCursor=false] - Reset the cursor to the default?\r\n *\r\n * @return {this} This Input Plugin.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 847, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Disables Input on a single Game Object.\r\rAn input disabled Game Object still retains its Interactive Object component and can be re-enabled\rat any time, by passing it to `InputPlugin.enable`.", "kind": "function", "name": "disable", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to have its input system disabled.", "name": "gameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Reset the cursor to the default?", "name": "resetCursor" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Input Plugin." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#disable", "scope": "instance", "___id": "T000002R022731", "___s": true }, { "comment": "/**\r\n * Enable a Game Object for interaction.\r\n *\r\n * If the Game Object already has an Interactive Object component, it is enabled and returned.\r\n *\r\n * Otherwise, a new Interactive Object component is created and assigned to the Game Object's `input` property.\r\n *\r\n * Input works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\r\n * for the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\r\n * input detection.\r\n *\r\n * If no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\r\n * this isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\r\n * shape for it to use.\r\n *\r\n * You can also provide an Input Configuration Object as the only argument to this method.\r\n *\r\n * @method Phaser.Input.InputPlugin#enable\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to be enabled for input.\r\n * @param {(Phaser.Types.Input.InputConfiguration|any)} [hitArea] - 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.\r\n * @param {Phaser.Types.Input.HitAreaCallback} [hitAreaCallback] - The 'contains' function to invoke to check if the pointer is within the hit area.\r\n * @param {boolean} [dropZone=false] - Is this Game Object a drop zone or not?\r\n *\r\n * @return {this} This Input Plugin.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 903, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Enable a Game Object for interaction.\r\rIf the Game Object already has an Interactive Object component, it is enabled and returned.\r\rOtherwise, a new Interactive Object component is created and assigned to the Game Object's `input` property.\r\rInput works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area\rfor the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced\rinput detection.\r\rIf no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If\rthis isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific\rshape for it to use.\r\rYou 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to be enabled for input.", "name": "gameObject" }, { "type": { "names": [ "Phaser.Types.Input.InputConfiguration", "any" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Input.InputConfiguration" }, { "type": "NameExpression", "name": "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": "hitArea" }, { "type": { "names": [ "Phaser.Types.Input.HitAreaCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.HitAreaCallback" } }, "optional": true, "description": "The 'contains' function to invoke to check if the pointer is within the hit area.", "name": "hitAreaCallback" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Is this Game Object a drop zone or not?", "name": "dropZone" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Input Plugin." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#enable", "scope": "instance", "___id": "T000002R022744", "___s": true }, { "comment": "/**\r\n * Takes the given Pointer and performs a hit test against it, to see which interactive Game Objects\r\n * it is currently above.\r\n *\r\n * The hit test is performed against which-ever Camera the Pointer is over. If it is over multiple\r\n * cameras, it starts checking the camera at the top of the camera list, and if nothing is found, iterates down the list.\r\n *\r\n * @method Phaser.Input.InputPlugin#hitTestPointer\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer to check against the Game Objects.\r\n *\r\n * @return {Phaser.GameObjects.GameObject[]} An array of all the interactive Game Objects the Pointer was above.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 953, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Takes the given Pointer and performs a hit test against it, to see which interactive Game Objects\rit is currently above.\r\rThe hit test is performed against which-ever Camera the Pointer is over. If it is over multiple\rcameras, 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer to check against the Game Objects.", "name": "pointer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "An array of all the interactive Game Objects the Pointer was above." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#hitTestPointer", "scope": "instance", "___id": "T000002R022749", "___s": true }, { "comment": "/**\r\n * Returns the drag state of the given Pointer for this Input Plugin.\r\n *\r\n * The state will be one of the following:\r\n *\r\n * 0 = Not dragging anything\r\n * 1 = Primary button down and objects below, so collect a draglist\r\n * 2 = Pointer being checked if meets drag criteria\r\n * 3 = Pointer meets criteria, notify the draglist\r\n * 4 = Pointer actively dragging the draglist and has moved\r\n * 5 = Pointer actively dragging but has been released, notify draglist\r\n *\r\n * @method Phaser.Input.InputPlugin#getDragState\r\n * @since 3.16.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer to get the drag state for.\r\n *\r\n * @return {number} The drag state of the given Pointer.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 1085, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Returns the drag state of the given Pointer for this Input Plugin.\r\rThe state will be one of the following:\r\r0 = Not dragging anything\r1 = Primary button down and objects below, so collect a draglist\r2 = Pointer being checked if meets drag criteria\r3 = Pointer meets criteria, notify the draglist\r4 = Pointer actively dragging the draglist and has moved\r5 = Pointer actively dragging but has been released, notify draglist", "kind": "function", "name": "getDragState", "since": "3.16.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer to get the drag state for.", "name": "pointer" } ], "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The drag state of the given Pointer." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#getDragState", "scope": "instance", "___id": "T000002R022768", "___s": true }, { "comment": "/**\r\n * Sets the drag state of the given Pointer for this Input Plugin.\r\n *\r\n * The state must be one of the following values:\r\n *\r\n * 0 = Not dragging anything\r\n * 1 = Primary button down and objects below, so collect a draglist\r\n * 2 = Pointer being checked if meets drag criteria\r\n * 3 = Pointer meets criteria, notify the draglist\r\n * 4 = Pointer actively dragging the draglist and has moved\r\n * 5 = Pointer actively dragging but has been released, notify draglist\r\n *\r\n * @method Phaser.Input.InputPlugin#setDragState\r\n * @since 3.16.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer to set the drag state for.\r\n * @param {number} state - The drag state value. An integer between 0 and 5.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 1109, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Sets the drag state of the given Pointer for this Input Plugin.\r\rThe state must be one of the following values:\r\r0 = Not dragging anything\r1 = Primary button down and objects below, so collect a draglist\r2 = Pointer being checked if meets drag criteria\r3 = Pointer meets criteria, notify the draglist\r4 = Pointer actively dragging the draglist and has moved\r5 = Pointer actively dragging but has been released, notify draglist", "kind": "function", "name": "setDragState", "since": "3.16.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer to set the drag state for.", "name": "pointer" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The drag state value. An integer between 0 and 5.", "name": "state" } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setDragState", "scope": "instance", "___id": "T000002R022770", "___s": true }, { "comment": "/**\r\n * This method will force the given Game Object into the 'down' input state.\r\n * \r\n * This will check to see if the Game Object is enabled for input, and if so,\r\n * it will emit the `GAMEOBJECT_POINTER_DOWN` event for it. If that doesn't change\r\n * the input state, it will then emit the `GAMEOBJECT_DOWN` event.\r\n * \r\n * The Game Object is not checked against the Pointer to see if it can enter this state,\r\n * that is up to you to do before calling this method.\r\n *\r\n * @method Phaser.Input.InputPlugin#forceDownState\r\n * @fires Phaser.Input.Events#GAMEOBJECT_POINTER_DOWN\r\n * @fires Phaser.Input.Events#GAMEOBJECT_DOWN\r\n * @since 3.85.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The pointer to use when setting the state.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to have its state set.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2080, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "This method will force the given Game Object into the 'down' input state.\r\rThis will check to see if the Game Object is enabled for input, and if so,\rit will emit the `GAMEOBJECT_POINTER_DOWN` event for it. If that doesn't change\rthe input state, it will then emit the `GAMEOBJECT_DOWN` event.\r\rThe Game Object is not checked against the Pointer to see if it can enter this state,\rthat is up to you to do before calling this method.", "kind": "function", "name": "forceDownState", "fires": [ "Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN", "Phaser.Input.Events#event:GAMEOBJECT_DOWN" ], "since": "3.85.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The pointer to use when setting the state.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to have its state set.", "name": "gameObject" } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#forceDownState", "scope": "instance", "___id": "T000002R022931", "___s": true }, { "comment": "/**\r\n * This method will force the given Game Object into the 'up' input state.\r\n * \r\n * This will check to see if the Game Object is enabled for input, and if so,\r\n * it will emit the `GAMEOBJECT_POINTER_UP` event for it. If that doesn't change\r\n * the input state, it will then emit the `GAMEOBJECT_UP` event.\r\n * \r\n * The Game Object is not checked against the Pointer to see if it can enter this state,\r\n * that is up to you to do before calling this method.\r\n *\r\n * @method Phaser.Input.InputPlugin#forceUpState\r\n * @fires Phaser.Input.Events#GAMEOBJECT_POINTER_UP\r\n * @fires Phaser.Input.Events#GAMEOBJECT_UP\r\n * @since 3.85.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The pointer to use when setting the state.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to have its state set.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "This method will force the given Game Object into the 'up' input state.\r\rThis will check to see if the Game Object is enabled for input, and if so,\rit will emit the `GAMEOBJECT_POINTER_UP` event for it. If that doesn't change\rthe input state, it will then emit the `GAMEOBJECT_UP` event.\r\rThe Game Object is not checked against the Pointer to see if it can enter this state,\rthat is up to you to do before calling this method.", "kind": "function", "name": "forceUpState", "fires": [ "Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP", "Phaser.Input.Events#event:GAMEOBJECT_UP" ], "since": "3.85.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The pointer to use when setting the state.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to have its state set.", "name": "gameObject" } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#forceUpState", "scope": "instance", "___id": "T000002R022933", "___s": true }, { "comment": "/**\r\n * This method will force the given Game Object into the 'over' input state.\r\n * \r\n * This will check to see if the Game Object is enabled for input, and if so,\r\n * it will emit the `GAMEOBJECT_POINTER_OVER` event for it. If that doesn't change\r\n * the input state, it will then emit the `GAMEOBJECT_OVER` event.\r\n * \r\n * The Game Object is not checked against the Pointer to see if it can enter this state,\r\n * that is up to you to do before calling this method.\r\n *\r\n * @method Phaser.Input.InputPlugin#forceOverState\r\n * @fires Phaser.Input.Events#GAMEOBJECT_POINTER_OVER\r\n * @fires Phaser.Input.Events#GAMEOBJECT_OVER\r\n * @since 3.85.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The pointer to use when setting the state.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to have its state set.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2126, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "This method will force the given Game Object into the 'over' input state.\r\rThis will check to see if the Game Object is enabled for input, and if so,\rit will emit the `GAMEOBJECT_POINTER_OVER` event for it. If that doesn't change\rthe input state, it will then emit the `GAMEOBJECT_OVER` event.\r\rThe Game Object is not checked against the Pointer to see if it can enter this state,\rthat is up to you to do before calling this method.", "kind": "function", "name": "forceOverState", "fires": [ "Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER", "Phaser.Input.Events#event:GAMEOBJECT_OVER" ], "since": "3.85.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The pointer to use when setting the state.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to have its state set.", "name": "gameObject" } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#forceOverState", "scope": "instance", "___id": "T000002R022935", "___s": true }, { "comment": "/**\r\n * This method will force the given Game Object into the 'out' input state.\r\n * \r\n * This will check to see if the Game Object is enabled for input, and if so,\r\n * it will emit the `GAMEOBJECT_POINTER_OUT` event for it. If that doesn't change\r\n * the input state, it will then emit the `GAMEOBJECT_OUT` event.\r\n * \r\n * The Game Object is not checked against the Pointer to see if it can enter this state,\r\n * that is up to you to do before calling this method.\r\n *\r\n * @method Phaser.Input.InputPlugin#forceOutState\r\n * @fires Phaser.Input.Events#GAMEOBJECT_POINTER_OUT\r\n * @fires Phaser.Input.Events#GAMEOBJECT_OUT\r\n * @since 3.85.0\r\n *\r\n * @param {Phaser.Input.Pointer} pointer - The pointer to use when setting the state.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to have its state set.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2149, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "This method will force the given Game Object into the 'out' input state.\r\rThis will check to see if the Game Object is enabled for input, and if so,\rit will emit the `GAMEOBJECT_POINTER_OUT` event for it. If that doesn't change\rthe input state, it will then emit the `GAMEOBJECT_OUT` event.\r\rThe Game Object is not checked against the Pointer to see if it can enter this state,\rthat is up to you to do before calling this method.", "kind": "function", "name": "forceOutState", "fires": [ "Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT", "Phaser.Input.Events#event:GAMEOBJECT_OUT" ], "since": "3.85.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The pointer to use when setting the state.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to have its state set.", "name": "gameObject" } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#forceOutState", "scope": "instance", "___id": "T000002R022937", "___s": true }, { "comment": "/**\r\n * This method will force the given Game Object into the given input state.\r\n * \r\n * @method Phaser.Input.InputPlugin#forceState\r\n * @since 3.85.0\r\n * \r\n * @param {Phaser.Input.Pointer} pointer - The pointer to use when setting the state.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to have its state set.\r\n * @param {string} gameObjectEvent - The event to emit on the Game Object.\r\n * @param {string} inputPluginEvent - The event to emit on the Input Plugin.\r\n * @param {boolean} [setCursor=false] - Should the cursor be set to the Game Object's cursor?\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2172, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "This method will force the given Game Object into the given input state.", "kind": "function", "name": "forceState", "since": "3.85.0", "params": [ { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The pointer to use when setting the state.", "name": "pointer" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to have its state set.", "name": "gameObject" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The event to emit on the Game Object.", "name": "gameObjectEvent" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The event to emit on the Input Plugin.", "name": "inputPluginEvent" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Should the cursor be set to the Game Object's cursor?", "name": "setCursor" } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#forceState", "scope": "instance", "___id": "T000002R022939", "___s": true }, { "comment": "/**\r\n * Sets the draggable state of the given array of Game Objects.\r\n *\r\n * They can either be set to be draggable, or can have their draggable state removed by passing `false`.\r\n *\r\n * A Game Object will not fire drag events unless it has been specifically enabled for drag.\r\n *\r\n * @method Phaser.Input.InputPlugin#setDraggable\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[])} gameObjects - An array of Game Objects to change the draggable state on.\r\n * @param {boolean} [value=true] - Set to `true` if the Game Objects should be made draggable, `false` if they should be unset.\r\n *\r\n * @return {this} This InputPlugin object.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2246, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Sets the draggable state of the given array of Game Objects.\r\rThey can either be set to be draggable, or can have their draggable state removed by passing `false`.\r\rA 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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects to change the draggable state on.", "name": "gameObjects" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This InputPlugin object." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setDraggable", "scope": "instance", "___id": "T000002R022948", "___s": true }, { "comment": "/**\r\n * Creates a function that can be passed to `setInteractive`, `enable` or `setHitArea` that will handle\r\n * pixel-perfect input detection on an Image or Sprite based Game Object, or any custom class that extends them.\r\n *\r\n * The following will create a sprite that is clickable on any pixel that has an alpha value >= 1.\r\n *\r\n * ```javascript\r\n * this.add.sprite(x, y, key).setInteractive(this.input.makePixelPerfect());\r\n * ```\r\n *\r\n * The following will create a sprite that is clickable on any pixel that has an alpha value >= 150.\r\n *\r\n * ```javascript\r\n * this.add.sprite(x, y, key).setInteractive(this.input.makePixelPerfect(150));\r\n * ```\r\n *\r\n * Once you have made an Interactive Object pixel perfect it impacts all input related events for it: down, up,\r\n * dragstart, drag, etc.\r\n *\r\n * As a pointer interacts with the Game Object it will constantly poll the texture, extracting a single pixel from\r\n * the given coordinates and checking its color values. This is an expensive process, so should only be enabled on\r\n * Game Objects that really need it.\r\n *\r\n * You cannot make non-texture based Game Objects pixel perfect. So this will not work on Graphics, BitmapText,\r\n * Render Textures, Text, Tilemaps, Containers or Particles.\r\n *\r\n * @method Phaser.Input.InputPlugin#makePixelPerfect\r\n * @since 3.10.0\r\n *\r\n * @param {number} [alphaTolerance=1] - The alpha level that the pixel should be above to be included as a successful interaction.\r\n *\r\n * @return {function} A Pixel Perfect Handler for use as a hitArea shape callback.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2291, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Creates a function that can be passed to `setInteractive`, `enable` or `setHitArea` that will handle\rpixel-perfect input detection on an Image or Sprite based Game Object, or any custom class that extends them.\r\rThe following will create a sprite that is clickable on any pixel that has an alpha value >= 1.\r\r```javascript\rthis.add.sprite(x, y, key).setInteractive(this.input.makePixelPerfect());\r```\r\rThe following will create a sprite that is clickable on any pixel that has an alpha value >= 150.\r\r```javascript\rthis.add.sprite(x, y, key).setInteractive(this.input.makePixelPerfect(150));\r```\r\rOnce you have made an Interactive Object pixel perfect it impacts all input related events for it: down, up,\rdragstart, drag, etc.\r\rAs a pointer interacts with the Game Object it will constantly poll the texture, extracting a single pixel from\rthe given coordinates and checking its color values. This is an expensive process, so should only be enabled on\rGame Objects that really need it.\r\rYou cannot make non-texture based Game Objects pixel perfect. So this will not work on Graphics, BitmapText,\rRender Textures, Text, Tilemaps, Containers or Particles.", "kind": "function", "name": "makePixelPerfect", "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "A Pixel Perfect Handler for use as a hitArea shape callback." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#makePixelPerfect", "scope": "instance", "___id": "T000002R022956", "___s": true }, { "comment": "/**\r\n * Sets the hit area for the given array of Game Objects.\r\n *\r\n * A hit area is typically one of the geometric shapes Phaser provides, such as a `Phaser.Geom.Rectangle`\r\n * or `Phaser.Geom.Circle`. However, it can be any object as long as it works with the provided callback.\r\n *\r\n * If no hit area is provided a Rectangle is created based on the size of the Game Object, if possible\r\n * to calculate.\r\n *\r\n * The hit area callback is the function that takes an `x` and `y` coordinate and returns a boolean if\r\n * those values fall within the area of the shape or not. All of the Phaser geometry objects provide this,\r\n * such as `Phaser.Geom.Rectangle.Contains`.\r\n * \r\n * A hit area callback can be supplied to the `hitArea` parameter without using the `hitAreaCallback` parameter.\r\n *\r\n * @method Phaser.Input.InputPlugin#setHitArea\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[])} gameObjects - An array of Game Objects to set the hit area on.\r\n * @param {(Phaser.Types.Input.InputConfiguration|Phaser.Types.Input.HitAreaCallback|any)} [hitArea] - Either an input configuration object, a geometric shape that defines the hit area or a hit area callback. If not specified a Rectangle hit area will be used.\r\n * @param {Phaser.Types.Input.HitAreaCallback} [hitAreaCallback] - The 'contains' function to invoke to check if the pointer is within the hit area.\r\n *\r\n * @return {this} This InputPlugin object.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2333, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Sets the hit area for the given array of Game Objects.\r\rA hit area is typically one of the geometric shapes Phaser provides, such as a `Phaser.Geom.Rectangle`\ror `Phaser.Geom.Circle`. However, it can be any object as long as it works with the provided callback.\r\rIf no hit area is provided a Rectangle is created based on the size of the Game Object, if possible\rto calculate.\r\rThe hit area callback is the function that takes an `x` and `y` coordinate and returns a boolean if\rthose values fall within the area of the shape or not. All of the Phaser geometry objects provide this,\rsuch as `Phaser.Geom.Rectangle.Contains`.\r\rA hit area callback can be supplied to the `hitArea` parameter without using the `hitAreaCallback` parameter.", "kind": "function", "name": "setHitArea", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects to set the hit area on.", "name": "gameObjects" }, { "type": { "names": [ "Phaser.Types.Input.InputConfiguration", "Phaser.Types.Input.HitAreaCallback", "any" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Types.Input.InputConfiguration" }, { "type": "NameExpression", "name": "Phaser.Types.Input.HitAreaCallback" }, { "type": "NameExpression", "name": "any" } ] } }, "optional": true, "description": "Either an input configuration object, a geometric shape that defines the hit area or a hit area callback. If not specified a Rectangle hit area will be used.", "name": "hitArea" }, { "type": { "names": [ "Phaser.Types.Input.HitAreaCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.HitAreaCallback" } }, "optional": true, "description": "The 'contains' function to invoke to check if the pointer is within the hit area.", "name": "hitAreaCallback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This InputPlugin object." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setHitArea", "scope": "instance", "___id": "T000002R022960", "___s": true }, { "comment": "/**\r\n * Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Circle` shape, using\r\n * the given coordinates and radius to control its position and size.\r\n *\r\n * @method Phaser.Input.InputPlugin#setHitAreaCircle\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[])} gameObjects - An array of Game Objects to set as having a circle hit area.\r\n * @param {number} x - The center of the circle.\r\n * @param {number} y - The center of the circle.\r\n * @param {number} radius - The radius of the circle.\r\n * @param {Phaser.Types.Input.HitAreaCallback} [callback] - The hit area callback. If undefined it uses Circle.Contains.\r\n *\r\n * @return {this} This InputPlugin object.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2440, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Circle` shape, using\rthe 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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects to set as having a circle hit area.", "name": "gameObjects" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The center of the circle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The center of the circle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The radius of the circle.", "name": "radius" }, { "type": { "names": [ "Phaser.Types.Input.HitAreaCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.HitAreaCallback" } }, "optional": true, "description": "The hit area callback. If undefined it uses Circle.Contains.", "name": "callback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This InputPlugin object." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setHitAreaCircle", "scope": "instance", "___id": "T000002R022990", "___s": true }, { "comment": "/**\r\n * Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Ellipse` shape, using\r\n * the given coordinates and dimensions to control its position and size.\r\n *\r\n * @method Phaser.Input.InputPlugin#setHitAreaEllipse\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[])} gameObjects - An array of Game Objects to set as having an ellipse hit area.\r\n * @param {number} x - The center of the ellipse.\r\n * @param {number} y - The center of the ellipse.\r\n * @param {number} width - The width of the ellipse.\r\n * @param {number} height - The height of the ellipse.\r\n * @param {Phaser.Types.Input.HitAreaCallback} [callback] - The hit area callback. If undefined it uses Ellipse.Contains.\r\n *\r\n * @return {this} This InputPlugin object.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Ellipse` shape, using\rthe 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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects to set as having an ellipse hit area.", "name": "gameObjects" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The center of the ellipse.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The center of the ellipse.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the ellipse.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the ellipse.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Input.HitAreaCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.HitAreaCallback" } }, "optional": true, "description": "The hit area callback. If undefined it uses Ellipse.Contains.", "name": "callback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This InputPlugin object." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setHitAreaEllipse", "scope": "instance", "___id": "T000002R022994", "___s": true }, { "comment": "/**\r\n * Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Rectangle` shape, using\r\n * the Game Objects texture frame to define the position and size of the hit area.\r\n *\r\n * @method Phaser.Input.InputPlugin#setHitAreaFromTexture\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[])} gameObjects - An array of Game Objects to set as having a Rectangle hit area based on their texture frame.\r\n * @param {Phaser.Types.Input.HitAreaCallback} [callback] - The hit area callback. If undefined it uses Rectangle.Contains.\r\n *\r\n * @return {this} This InputPlugin object.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2489, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Rectangle` shape, using\rthe 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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects to set as having a Rectangle hit area based on their texture frame.", "name": "gameObjects" }, { "type": { "names": [ "Phaser.Types.Input.HitAreaCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.HitAreaCallback" } }, "optional": true, "description": "The hit area callback. If undefined it uses Rectangle.Contains.", "name": "callback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This InputPlugin object." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setHitAreaFromTexture", "scope": "instance", "___id": "T000002R022998", "___s": true }, { "comment": "/**\r\n * Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Rectangle` shape, using\r\n * the given coordinates and dimensions to control its position and size.\r\n *\r\n * @method Phaser.Input.InputPlugin#setHitAreaRectangle\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[])} gameObjects - An array of Game Objects to set as having a rectangular hit area.\r\n * @param {number} x - The top-left of the rectangle.\r\n * @param {number} y - The top-left of the rectangle.\r\n * @param {number} width - The width of the rectangle.\r\n * @param {number} height - The height of the rectangle.\r\n * @param {Phaser.Types.Input.HitAreaCallback} [callback] - The hit area callback. If undefined it uses Rectangle.Contains.\r\n *\r\n * @return {this} This InputPlugin object.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2547, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Rectangle` shape, using\rthe 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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects to set as having a rectangular hit area.", "name": "gameObjects" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left of the rectangle.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The top-left of the rectangle.", "name": "y" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The width of the rectangle.", "name": "width" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The height of the rectangle.", "name": "height" }, { "type": { "names": [ "Phaser.Types.Input.HitAreaCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.HitAreaCallback" } }, "optional": true, "description": "The hit area callback. If undefined it uses Rectangle.Contains.", "name": "callback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This InputPlugin object." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setHitAreaRectangle", "scope": "instance", "___id": "T000002R023012", "___s": true }, { "comment": "/**\r\n * Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Triangle` shape, using\r\n * the given coordinates to control the position of its points.\r\n *\r\n * @method Phaser.Input.InputPlugin#setHitAreaTriangle\r\n * @since 3.0.0\r\n *\r\n * @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[])} gameObjects - An array of Game Objects to set as having a triangular hit area.\r\n * @param {number} x1 - The x coordinate of the first point of the triangle.\r\n * @param {number} y1 - The y coordinate of the first point of the triangle.\r\n * @param {number} x2 - The x coordinate of the second point of the triangle.\r\n * @param {number} y2 - The y coordinate of the second point of the triangle.\r\n * @param {number} x3 - The x coordinate of the third point of the triangle.\r\n * @param {number} y3 - The y coordinate of the third point of the triangle.\r\n * @param {Phaser.Types.Input.HitAreaCallback} [callback] - The hit area callback. If undefined it uses Triangle.Contains.\r\n *\r\n * @return {this} This InputPlugin object.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Sets the hit area for an array of Game Objects to be a `Phaser.Geom.Triangle` shape, using\rthe given coordinates to control the position of its points.", "kind": "function", "name": "setHitAreaTriangle", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } ] } }, "description": "An array of Game Objects to set as having a triangular hit area.", "name": "gameObjects" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the first point of the triangle.", "name": "x1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the first point of the triangle.", "name": "y1" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the second point of the triangle.", "name": "x2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the second point of the triangle.", "name": "y2" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the third point of the triangle.", "name": "x3" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the third point of the triangle.", "name": "y3" }, { "type": { "names": [ "Phaser.Types.Input.HitAreaCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.HitAreaCallback" } }, "optional": true, "description": "The hit area callback. If undefined it uses Triangle.Contains.", "name": "callback" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This InputPlugin object." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setHitAreaTriangle", "scope": "instance", "___id": "T000002R023016", "___s": true }, { "comment": "/**\r\n * Creates an Input Debug Shape for the given Game Object.\r\n *\r\n * The Game Object must have _already_ been enabled for input prior to calling this method.\r\n *\r\n * This is intended to assist you during development and debugging.\r\n *\r\n * Debug Shapes can only be created for Game Objects that are using standard Phaser Geometry for input,\r\n * including: Circle, Ellipse, Line, Polygon, Rectangle and Triangle.\r\n *\r\n * Game Objects that are using their automatic hit areas are using Rectangles by default, so will also work.\r\n *\r\n * The Debug Shape is created and added to the display list and is then kept in sync with the Game Object\r\n * it is connected with. Should you need to modify it yourself, such as to hide it, you can access it via\r\n * the Game Object property: `GameObject.input.hitAreaDebug`.\r\n *\r\n * Calling this method on a Game Object that already has a Debug Shape will first destroy the old shape,\r\n * before creating a new one. If you wish to remove the Debug Shape entirely, you should call the\r\n * method `InputPlugin.removeDebug`.\r\n *\r\n * Note that the debug shape will only show the outline of the input area. If the input test is using a\r\n * pixel perfect check, for example, then this is not displayed. If you are using a custom shape, that\r\n * doesn't extend one of the base Phaser Geometry objects, as your hit area, then this method will not\r\n * work.\r\n *\r\n * @method Phaser.Input.InputPlugin#enableDebug\r\n * @since 3.19.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to create the input debug shape for.\r\n * @param {number} [color=0x00ff00] - The outline color of the debug shape.\r\n *\r\n * @return {this} This Input Plugin.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Creates an Input Debug Shape for the given Game Object.\r\rThe Game Object must have _already_ been enabled for input prior to calling this method.\r\rThis is intended to assist you during development and debugging.\r\rDebug Shapes can only be created for Game Objects that are using standard Phaser Geometry for input,\rincluding: Circle, Ellipse, Line, Polygon, Rectangle and Triangle.\r\rGame Objects that are using their automatic hit areas are using Rectangles by default, so will also work.\r\rThe Debug Shape is created and added to the display list and is then kept in sync with the Game Object\rit is connected with. Should you need to modify it yourself, such as to hide it, you can access it via\rthe Game Object property: `GameObject.input.hitAreaDebug`.\r\rCalling this method on a Game Object that already has a Debug Shape will first destroy the old shape,\rbefore creating a new one. If you wish to remove the Debug Shape entirely, you should call the\rmethod `InputPlugin.removeDebug`.\r\rNote that the debug shape will only show the outline of the input area. If the input test is using a\rpixel perfect check, for example, then this is not displayed. If you are using a custom shape, that\rdoesn't extend one of the base Phaser Geometry objects, as your hit area, then this method will not\rwork.", "kind": "function", "name": "enableDebug", "since": "3.19.0", "params": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to create the input debug shape for.", "name": "gameObject" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": "0x00ff00", "description": "The outline color of the debug shape.", "name": "color" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Input Plugin." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#enableDebug", "scope": "instance", "___id": "T000002R023020", "___s": true }, { "comment": "/**\r\n * Removes an Input Debug Shape from the given Game Object.\r\n *\r\n * The shape is destroyed immediately and the `hitAreaDebug` property is set to `null`.\r\n *\r\n * @method Phaser.Input.InputPlugin#removeDebug\r\n * @since 3.19.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to remove the input debug shape from.\r\n *\r\n * @return {this} This Input Plugin.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2739, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Removes an Input Debug Shape from the given Game Object.\r\rThe 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to remove the input debug shape from.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Input Plugin." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#removeDebug", "scope": "instance", "___id": "T000002R023059", "___s": true }, { "comment": "/**\r\n * Sets the Pointers to always poll.\r\n *\r\n * When a pointer is polled it runs a hit test to see which Game Objects are currently below it,\r\n * or being interacted with it, regardless if the Pointer has actually moved or not.\r\n *\r\n * You should enable this if you want objects in your game to fire over / out events, and the objects\r\n * are constantly moving, but the pointer may not have. Polling every frame has additional computation\r\n * costs, especially if there are a large number of interactive objects in your game.\r\n *\r\n * @method Phaser.Input.InputPlugin#setPollAlways\r\n * @since 3.0.0\r\n *\r\n * @return {this} This InputPlugin object.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2768, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Sets the Pointers to always poll.\r\rWhen a pointer is polled it runs a hit test to see which Game Objects are currently below it,\ror being interacted with it, regardless if the Pointer has actually moved or not.\r\rYou should enable this if you want objects in your game to fire over / out events, and the objects\rare constantly moving, but the pointer may not have. Polling every frame has additional computation\rcosts, especially if there are a large number of interactive objects in your game.", "kind": "function", "name": "setPollAlways", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This InputPlugin object." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setPollAlways", "scope": "instance", "___id": "T000002R023064", "___s": true }, { "comment": "/**\r\n * Sets the Pointers to only poll when they are moved or updated.\r\n *\r\n * When a pointer is polled it runs a hit test to see which Game Objects are currently below it,\r\n * or being interacted with it.\r\n *\r\n * @method Phaser.Input.InputPlugin#setPollOnMove\r\n * @since 3.0.0\r\n *\r\n * @return {this} This InputPlugin object.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2788, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Sets the Pointers to only poll when they are moved or updated.\r\rWhen a pointer is polled it runs a hit test to see which Game Objects are currently below it,\ror being interacted with it.", "kind": "function", "name": "setPollOnMove", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This InputPlugin object." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setPollOnMove", "scope": "instance", "___id": "T000002R023066", "___s": true }, { "comment": "/**\r\n * Sets the poll rate value. This is the amount of time that should have elapsed before a pointer\r\n * will be polled again. See the `setPollAlways` and `setPollOnMove` methods.\r\n *\r\n * @method Phaser.Input.InputPlugin#setPollRate\r\n * @since 3.0.0\r\n *\r\n * @param {number} value - The amount of time, in ms, that should elapsed before re-polling the pointers.\r\n *\r\n * @return {this} This InputPlugin object.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2804, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Sets the poll rate value. This is the amount of time that should have elapsed before a pointer\rwill be polled again. See the `setPollAlways` and `setPollOnMove` methods.", "kind": "function", "name": "setPollRate", "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The amount of time, in ms, that should elapsed before re-polling the pointers.", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This InputPlugin object." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setPollRate", "scope": "instance", "___id": "T000002R023068", "___s": true }, { "comment": "/**\r\n * When set to `true` the global Input Manager will emulate DOM behavior by only emitting events from\r\n * the top-most Scene in the Scene List. By default, if a Scene receives an input event it will then stop the event\r\n * from flowing down to any Scenes below it in the Scene list. To disable this behavior call this method with `false`.\r\n *\r\n * @method Phaser.Input.InputPlugin#setGlobalTopOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - 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.\r\n *\r\n * @return {this} This InputPlugin object.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2823, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "When set to `true` the global Input Manager will emulate DOM behavior by only emitting events from\rthe top-most Scene in the Scene List. By default, if a Scene receives an input event it will then stop the event\rfrom 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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This InputPlugin object." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setGlobalTopOnly", "scope": "instance", "___id": "T000002R023072", "___s": true }, { "comment": "/**\r\n * When set to `true` this Input Plugin will emulate DOM behavior by only emitting events from\r\n * the top-most Game Objects in the Display List.\r\n *\r\n * If set to `false` it will emit events from all Game Objects below a Pointer, not just the top one.\r\n *\r\n * @method Phaser.Input.InputPlugin#setTopOnly\r\n * @since 3.0.0\r\n *\r\n * @param {boolean} value - `true` to only include the top-most Game Object, or `false` to include all Game Objects in a hit test.\r\n *\r\n * @return {this} This InputPlugin object.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2842, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "When set to `true` this Input Plugin will emulate DOM behavior by only emitting events from\rthe top-most Game Objects in the Display List.\r\rIf 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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This InputPlugin object." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setTopOnly", "scope": "instance", "___id": "T000002R023075", "___s": true }, { "comment": "/**\r\n * Given an array of Game Objects and a Pointer, sort the array and return it,\r\n * so that the objects are in render order with the lowest at the bottom.\r\n *\r\n * @method Phaser.Input.InputPlugin#sortGameObjects\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject[]} gameObjects - An array of Game Objects to be sorted.\r\n * @param {Phaser.Input.Pointer} pointer - The Pointer to check against the Game Objects.\r\n *\r\n * @return {Phaser.GameObjects.GameObject[]} The sorted array of Game Objects.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2862, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Given an array of Game Objects and a Pointer, sort the array and return it,\rso that the objects are in render order with the lowest at the bottom.", "kind": "function", "name": "sortGameObjects", "since": "3.0.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "An array of Game Objects to be sorted.", "name": "gameObjects" }, { "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "description": "The Pointer to check against the Game Objects.", "name": "pointer" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "The sorted array of Game Objects." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#sortGameObjects", "scope": "instance", "___id": "T000002R023078", "___s": true }, { "comment": "/**\r\n * Given an array of Drop Zone Game Objects, sort the array and return it,\r\n * so that the objects are in depth index order with the lowest at the bottom.\r\n *\r\n * @method Phaser.Input.InputPlugin#sortDropZones\r\n * @since 3.52.0\r\n *\r\n * @param {Phaser.GameObjects.GameObject[]} gameObjects - An array of Game Objects to be sorted.\r\n *\r\n * @return {Phaser.GameObjects.GameObject[]} The sorted array of Game Objects.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2892, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Given an array of Drop Zone Game Objects, sort the array and return it,\rso that the objects are in depth index order with the lowest at the bottom.", "kind": "function", "name": "sortDropZones", "since": "3.52.0", "params": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "An array of Game Objects to be sorted.", "name": "gameObjects" } ], "returns": [ { "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.GameObjects.GameObject", "type": "NameExpression" } ] } }, "description": "The sorted array of Game Objects." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#sortDropZones", "scope": "instance", "___id": "T000002R023083", "___s": true }, { "comment": "/**\r\n * This method should be called from within an input event handler, such as `pointerdown`.\r\n *\r\n * When called, it stops the Input Manager from allowing _this specific event_ to be processed by any other Scene\r\n * not yet handled in the scene list.\r\n *\r\n * @method Phaser.Input.InputPlugin#stopPropagation\r\n * @since 3.0.0\r\n *\r\n * @return {this} This InputPlugin object.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 2984, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "This method should be called from within an input event handler, such as `pointerdown`.\r\rWhen called, it stops the Input Manager from allowing _this specific event_ to be processed by any other Scene\rnot yet handled in the scene list.", "kind": "function", "name": "stopPropagation", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This InputPlugin object." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#stopPropagation", "scope": "instance", "___id": "T000002R023093", "___s": true }, { "comment": "/**\r\n * Adds new Pointer objects to the Input Manager.\r\n *\r\n * By default Phaser creates 2 pointer objects: `mousePointer` and `pointer1`.\r\n *\r\n * You can create more either by calling this method, or by setting the `input.activePointers` property\r\n * in the Game Config, up to a maximum of 10 pointers.\r\n *\r\n * The first 10 pointers are available via the `InputPlugin.pointerX` properties, once they have been added\r\n * via this method.\r\n *\r\n * @method Phaser.Input.InputPlugin#addPointer\r\n * @since 3.10.0\r\n *\r\n * @param {number} [quantity=1] The number of new Pointers to create. A maximum of 10 is allowed in total.\r\n *\r\n * @return {Phaser.Input.Pointer[]} An array containing all of the new Pointer objects that were created.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3002, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Adds new Pointer objects to the Input Manager.\r\rBy default Phaser creates 2 pointer objects: `mousePointer` and `pointer1`.\r\rYou can create more either by calling this method, or by setting the `input.activePointers` property\rin the Game Config, up to a maximum of 10 pointers.\r\rThe first 10 pointers are available via the `InputPlugin.pointerX` properties, once they have been added\rvia this method.", "kind": "function", "name": "addPointer", "since": "3.10.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Input.Pointer", "type": "NameExpression" } ] } }, "description": "An array containing all of the new Pointer objects that were created." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#addPointer", "scope": "instance", "___id": "T000002R023096", "___s": true }, { "comment": "/**\r\n * Tells the Input system to set a custom cursor.\r\n *\r\n * This cursor will be the default cursor used when interacting with the game canvas.\r\n *\r\n * If an Interactive Object also sets a custom cursor, this is the cursor that is reset after its use.\r\n *\r\n * Any valid CSS cursor value is allowed, including paths to image files, i.e.:\r\n *\r\n * ```javascript\r\n * this.input.setDefaultCursor('url(assets/cursors/sword.cur), pointer');\r\n * ```\r\n *\r\n * Please read about the differences between browsers when it comes to the file formats and sizes they support:\r\n *\r\n * https://developer.mozilla.org/en-US/docs/Web/CSS/cursor\r\n * https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_User_Interface/Using_URL_values_for_the_cursor_property\r\n *\r\n * It's up to you to pick a suitable cursor format that works across the range of browsers you need to support.\r\n *\r\n * @method Phaser.Input.InputPlugin#setDefaultCursor\r\n * @since 3.10.0\r\n *\r\n * @param {string} cursor - The CSS to be used when setting the default cursor.\r\n *\r\n * @return {this} This Input instance.\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3025, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Tells the Input system to set a custom cursor.\r\rThis cursor will be the default cursor used when interacting with the game canvas.\r\rIf an Interactive Object also sets a custom cursor, this is the cursor that is reset after its use.\r\rAny valid CSS cursor value is allowed, including paths to image files, i.e.:\r\r```javascript\rthis.input.setDefaultCursor('url(assets/cursors/sword.cur), pointer');\r```\r\rPlease read about the differences between browsers when it comes to the file formats and sizes they support:\r\rhttps://developer.mozilla.org/en-US/docs/Web/CSS/cursor\rhttps://developer.mozilla.org/en-US/docs/Web/CSS/CSS_User_Interface/Using_URL_values_for_the_cursor_property\r\rIt'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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The CSS to be used when setting the default cursor.", "name": "cursor" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Input instance." } ], "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#setDefaultCursor", "scope": "instance", "___id": "T000002R023098", "___s": true }, { "comment": "/**\r\n * Loops through all of the Input Manager Pointer instances and calls `reset` on them.\r\n *\r\n * Use this function if you find that input has been stolen from Phaser via a 3rd\r\n * party component, such as Vue, and you need to tell Phaser to reset the Pointer states.\r\n *\r\n * @method Phaser.Input.InputPlugin#resetPointers\r\n * @since 3.60.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Loops through all of the Input Manager Pointer instances and calls `reset` on them.\r\rUse this function if you find that input has been stolen from Phaser via a 3rd\rparty component, such as Vue, and you need to tell Phaser to reset the Pointer states.", "kind": "function", "name": "resetPointers", "since": "3.60.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#resetPointers", "scope": "instance", "___id": "T000002R023123", "___s": true }, { "comment": "/**\r\n * The x coordinate of the ActivePointer based on the first camera in the camera list.\r\n * This is only safe to use if your game has just 1 non-transformed camera and doesn't use multi-touch.\r\n *\r\n * @name Phaser.Input.InputPlugin#x\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3190, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The x coordinate of the ActivePointer based on the first camera in the camera list.\rThis 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#x", "scope": "instance", "kind": "member", "___id": "T000002R023134", "___s": true }, { "comment": "/**\r\n * The y coordinate of the ActivePointer based on the first camera in the camera list.\r\n * This is only safe to use if your game has just 1 non-transformed camera and doesn't use multi-touch.\r\n *\r\n * @name Phaser.Input.InputPlugin#y\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3208, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The y coordinate of the ActivePointer based on the first camera in the camera list.\rThis 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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#y", "scope": "instance", "kind": "member", "___id": "T000002R023137", "___s": true }, { "comment": "/**\r\n * Are any mouse or touch pointers currently over the game canvas?\r\n *\r\n * @name Phaser.Input.InputPlugin#isOver\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3226, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Are any mouse or touch pointers currently over the game canvas?", "name": "isOver", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#isOver", "scope": "instance", "kind": "member", "___id": "T000002R023140", "___s": true }, { "comment": "/**\r\n * The mouse has its own unique Pointer object, which you can reference directly if making a _desktop specific game_.\r\n * If you are supporting both desktop and touch devices then do not use this property, instead use `activePointer`\r\n * which will always map to the most recently interacted pointer.\r\n *\r\n * @name Phaser.Input.InputPlugin#mousePointer\r\n * @type {Phaser.Input.Pointer}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3243, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The mouse has its own unique Pointer object, which you can reference directly if making a _desktop specific game_.\rIf you are supporting both desktop and touch devices then do not use this property, instead use `activePointer`\rwhich will always map to the most recently interacted pointer.", "name": "mousePointer", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#mousePointer", "scope": "instance", "kind": "member", "___id": "T000002R023143", "___s": true }, { "comment": "/**\r\n * The current active input Pointer.\r\n *\r\n * @name Phaser.Input.InputPlugin#activePointer\r\n * @type {Phaser.Input.Pointer}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3262, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The current active input Pointer.", "name": "activePointer", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#activePointer", "scope": "instance", "kind": "member", "___id": "T000002R023146", "___s": true }, { "comment": "/**\r\n * A touch-based Pointer object. This is the first pointer created by Phaser and is available by default,\r\n * alongside the `mousePointer`.\r\n *\r\n * @name Phaser.Input.InputPlugin#pointer1\r\n * @type {Phaser.Input.Pointer}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3279, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A touch-based Pointer object. This is the first pointer created by Phaser and is available by default,\ralongside the `mousePointer`.", "name": "pointer1", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#pointer1", "scope": "instance", "kind": "member", "___id": "T000002R023149", "___s": true }, { "comment": "/**\r\n * A touch-based Pointer object.\r\n * This will be `undefined` by default unless you add a new Pointer using `addPointer`.\r\n *\r\n * @name Phaser.Input.InputPlugin#pointer2\r\n * @type {Phaser.Input.Pointer}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3297, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A touch-based Pointer object.\rThis will be `undefined` by default unless you add a new Pointer using `addPointer`.", "name": "pointer2", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#pointer2", "scope": "instance", "kind": "member", "___id": "T000002R023152", "___s": true }, { "comment": "/**\r\n * A touch-based Pointer object.\r\n * This will be `undefined` by default unless you add a new Pointer using `addPointer`.\r\n *\r\n * @name Phaser.Input.InputPlugin#pointer3\r\n * @type {Phaser.Input.Pointer}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3315, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A touch-based Pointer object.\rThis will be `undefined` by default unless you add a new Pointer using `addPointer`.", "name": "pointer3", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#pointer3", "scope": "instance", "kind": "member", "___id": "T000002R023155", "___s": true }, { "comment": "/**\r\n * A touch-based Pointer object.\r\n * This will be `undefined` by default unless you add a new Pointer using `addPointer`.\r\n *\r\n * @name Phaser.Input.InputPlugin#pointer4\r\n * @type {Phaser.Input.Pointer}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3333, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A touch-based Pointer object.\rThis will be `undefined` by default unless you add a new Pointer using `addPointer`.", "name": "pointer4", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#pointer4", "scope": "instance", "kind": "member", "___id": "T000002R023158", "___s": true }, { "comment": "/**\r\n * A touch-based Pointer object.\r\n * This will be `undefined` by default unless you add a new Pointer using `addPointer`.\r\n *\r\n * @name Phaser.Input.InputPlugin#pointer5\r\n * @type {Phaser.Input.Pointer}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3351, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A touch-based Pointer object.\rThis will be `undefined` by default unless you add a new Pointer using `addPointer`.", "name": "pointer5", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#pointer5", "scope": "instance", "kind": "member", "___id": "T000002R023161", "___s": true }, { "comment": "/**\r\n * A touch-based Pointer object.\r\n * This will be `undefined` by default unless you add a new Pointer using `addPointer`.\r\n *\r\n * @name Phaser.Input.InputPlugin#pointer6\r\n * @type {Phaser.Input.Pointer}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3369, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A touch-based Pointer object.\rThis will be `undefined` by default unless you add a new Pointer using `addPointer`.", "name": "pointer6", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#pointer6", "scope": "instance", "kind": "member", "___id": "T000002R023164", "___s": true }, { "comment": "/**\r\n * A touch-based Pointer object.\r\n * This will be `undefined` by default unless you add a new Pointer using `addPointer`.\r\n *\r\n * @name Phaser.Input.InputPlugin#pointer7\r\n * @type {Phaser.Input.Pointer}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3387, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A touch-based Pointer object.\rThis will be `undefined` by default unless you add a new Pointer using `addPointer`.", "name": "pointer7", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#pointer7", "scope": "instance", "kind": "member", "___id": "T000002R023167", "___s": true }, { "comment": "/**\r\n * A touch-based Pointer object.\r\n * This will be `undefined` by default unless you add a new Pointer using `addPointer`.\r\n *\r\n * @name Phaser.Input.InputPlugin#pointer8\r\n * @type {Phaser.Input.Pointer}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3405, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A touch-based Pointer object.\rThis will be `undefined` by default unless you add a new Pointer using `addPointer`.", "name": "pointer8", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#pointer8", "scope": "instance", "kind": "member", "___id": "T000002R023170", "___s": true }, { "comment": "/**\r\n * A touch-based Pointer object.\r\n * This will be `undefined` by default unless you add a new Pointer using `addPointer`.\r\n *\r\n * @name Phaser.Input.InputPlugin#pointer9\r\n * @type {Phaser.Input.Pointer}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3423, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A touch-based Pointer object.\rThis will be `undefined` by default unless you add a new Pointer using `addPointer`.", "name": "pointer9", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#pointer9", "scope": "instance", "kind": "member", "___id": "T000002R023173", "___s": true }, { "comment": "/**\r\n * A touch-based Pointer object.\r\n * This will be `undefined` by default unless you add a new Pointer using `addPointer`.\r\n *\r\n * @name Phaser.Input.InputPlugin#pointer10\r\n * @type {Phaser.Input.Pointer}\r\n * @readonly\r\n * @since 3.10.0\r\n */", "meta": { "filename": "InputPlugin.js", "lineno": 3441, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A touch-based Pointer object.\rThis will be `undefined` by default unless you add a new Pointer using `addPointer`.", "name": "pointer10", "type": { "names": [ "Phaser.Input.Pointer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Pointer" } }, "readonly": true, "since": "3.10.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#pointer10", "scope": "instance", "kind": "member", "___id": "T000002R023176", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Input.InputPluginCache\r\n */", "meta": { "filename": "InputPluginCache.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "kind": "namespace", "name": "InputPluginCache", "memberof": "Phaser.Input", "longname": "Phaser.Input.InputPluginCache", "scope": "static", "___id": "T000002R023182", "___s": true }, { "comment": "/**\r\n * Static method called directly by the core internal plugins.\r\n * Key is a reference used to get the plugin from the input plugin cache.\r\n * Plugin is the object to instantiate to create the plugin.\r\n * Mapping is the property key used when the plugin is injected into the Input Plugin (e.g. `input`).\r\n *\r\n * @function Phaser.Input.InputPluginCache.register\r\n * @static\r\n * @since 3.10.0\r\n *\r\n * @param {string} key - A reference used to get this plugin from the plugin cache.\r\n * @param {function} plugin - The plugin to be stored. Should be the core object, not instantiated.\r\n * @param {string} mapping - If this plugin is to be injected into the Input Plugin, this is the property key used.\r\n * @param {string} settingsKey - The key in the Scene Settings to check to see if this plugin should install or not.\r\n * @param {string} configKey - The key in the Game Config to check to see if this plugin should install or not.\r\n */", "meta": { "filename": "InputPluginCache.js", "lineno": 19, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Static method called directly by the core internal plugins.\rKey is a reference used to get the plugin from the input plugin cache.\rPlugin is the object to instantiate to create the plugin.\rMapping is the property key used when the plugin is injected into the Input Plugin (e.g. `input`).", "kind": "function", "name": "register", "scope": "static", "since": "3.10.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "A reference used to get this plugin from the plugin cache.", "name": "key" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The plugin to be stored. Should be the core object, not instantiated.", "name": "plugin" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "If this plugin is to be injected into the Input Plugin, this is the property key used.", "name": "mapping" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key in the Scene Settings to check to see if this plugin should install or not.", "name": "settingsKey" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023184", "___s": true }, { "comment": "/**\r\n * Returns the input plugin object from the cache based on the given key.\r\n *\r\n * @function Phaser.Input.InputPluginCache.getPlugin\r\n * @static\r\n * @since 3.10.0\r\n *\r\n * @param {string} key - The key of the input plugin to get.\r\n *\r\n * @return {Phaser.Types.Input.InputPluginContainer} The input plugin object.\r\n */", "meta": { "filename": "InputPluginCache.js", "lineno": 40, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Returns the input plugin object from the cache based on the given key.", "kind": "function", "name": "getPlugin", "scope": "static", "since": "3.10.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the input plugin to get.", "name": "key" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Input.InputPluginContainer" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.InputPluginContainer" } }, "description": "The input plugin object." } ], "memberof": "Phaser.Input.InputPluginCache", "longname": "Phaser.Input.InputPluginCache.getPlugin", "___id": "T000002R023191", "___s": true }, { "comment": "/**\r\n * Installs all of the registered Input Plugins into the given target.\r\n *\r\n * @function Phaser.Input.InputPluginCache.install\r\n * @static\r\n * @since 3.10.0\r\n *\r\n * @param {Phaser.Input.InputPlugin} target - The target InputPlugin to install the plugins into.\r\n */", "meta": { "filename": "InputPluginCache.js", "lineno": 56, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputPlugin" } }, "description": "The target InputPlugin to install the plugins into.", "name": "target" } ], "memberof": "Phaser.Input.InputPluginCache", "longname": "Phaser.Input.InputPluginCache.install", "___id": "T000002R023193", "___s": true }, { "comment": "/**\r\n * Removes an input plugin based on the given key.\r\n *\r\n * @function Phaser.Input.InputPluginCache.remove\r\n * @static\r\n * @since 3.10.0\r\n *\r\n * @param {string} key - The key of the input plugin to remove.\r\n */", "meta": { "filename": "InputPluginCache.js", "lineno": 85, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Removes an input plugin based on the given key.", "kind": "function", "name": "remove", "scope": "static", "since": "3.10.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the input plugin to remove.", "name": "key" } ], "memberof": "Phaser.Input.InputPluginCache", "longname": "Phaser.Input.InputPluginCache.remove", "___id": "T000002R023204", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A KeyCombo will listen for a specific string of keys from the Keyboard, and when it receives them\r\n * it will emit a `keycombomatch` event from the Keyboard Manager.\r\n *\r\n * The keys to be listened for can be defined as:\r\n *\r\n * A string (i.e. 'ATARI')\r\n * An array of either integers (key codes) or strings, or a mixture of both\r\n * An array of objects (such as Key objects) with a public 'keyCode' property\r\n *\r\n * For example, to listen for the Konami code (up, up, down, down, left, right, left, right, b, a, enter)\r\n * you could pass the following array of key codes:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.createCombo([ 38, 38, 40, 40, 37, 39, 37, 39, 66, 65, 13 ], { resetOnMatch: true });\r\n *\r\n * this.input.keyboard.on('keycombomatch', function (event) {\r\n * console.log('Konami Code entered!');\r\n * });\r\n * ```\r\n *\r\n * Or, to listen for the user entering the word PHASER:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.createCombo('PHASER');\r\n * ```\r\n *\r\n * @class KeyCombo\r\n * @memberof Phaser.Input.Keyboard\r\n * @constructor\r\n * @listens Phaser.Input.Keyboard.Events#ANY_KEY_DOWN\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Keyboard.KeyboardPlugin} keyboardPlugin - A reference to the Keyboard Plugin.\r\n * @param {(string|number[]|object[])} keys - The keys that comprise this combo.\r\n * @param {Phaser.Types.Input.Keyboard.KeyComboConfig} [config] - A Key Combo configuration object.\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 13, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "classdesc": "A KeyCombo will listen for a specific string of keys from the Keyboard, and when it receives them\rit will emit a `keycombomatch` event from the Keyboard Manager.\r\rThe keys to be listened for can be defined as:\r\rA string (i.e. 'ATARI')\rAn array of either integers (key codes) or strings, or a mixture of both\rAn array of objects (such as Key objects) with a public 'keyCode' property\r\rFor example, to listen for the Konami code (up, up, down, down, left, right, left, right, b, a, enter)\ryou could pass the following array of key codes:\r\r```javascript\rthis.input.keyboard.createCombo([ 38, 38, 40, 40, 37, 39, 37, 39, 66, 65, 13 ], { resetOnMatch: true });\r\rthis.input.keyboard.on('keycombomatch', function (event) {\r console.log('Konami Code entered!');\r});\r```\r\rOr, to listen for the user entering the word PHASER:\r\r```javascript\rthis.input.keyboard.createCombo('PHASER');\r```", "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.KeyboardPlugin" } }, "description": "A reference to the Keyboard Plugin.", "name": "keyboardPlugin" }, { "type": { "names": [ "string", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } ] } }, "description": "The keys that comprise this combo.", "name": "keys" }, { "type": { "names": [ "Phaser.Types.Input.Keyboard.KeyComboConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.Keyboard.KeyComboConfig" } }, "optional": true, "description": "A Key Combo configuration object.", "name": "config" } ], "scope": "static", "longname": "Phaser.Input.Keyboard.KeyCombo", "___id": "T000002R023217", "___s": true }, { "comment": "/**\r\n * A reference to the Keyboard Plugin\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#manager\r\n * @type {Phaser.Input.Keyboard.KeyboardPlugin}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "description": "A reference to the Keyboard Plugin", "name": "manager", "type": { "names": [ "Phaser.Input.Keyboard.KeyboardPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.KeyboardPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#manager", "scope": "instance", "kind": "member", "___id": "T000002R023221", "___s": true }, { "comment": "/**\r\n * A flag that controls if this Key Combo is actively processing keys or not.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#enabled\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 74, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "description": "A flag that controls if this Key Combo is actively processing keys or not.", "name": "enabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#enabled", "scope": "instance", "kind": "member", "___id": "T000002R023223", "___s": true }, { "comment": "/**\r\n * An array of the keycodes that comprise this combo.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#keyCodes\r\n * @type {array}\r\n * @default []\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 84, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "description": "An array of the keycodes that comprise this combo.", "name": "keyCodes", "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "defaultvalue": "[]", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#keyCodes", "scope": "instance", "kind": "member", "___id": "T000002R023225", "___s": true }, { "comment": "/**\r\n * The current keyCode the combo is waiting for.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#current\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 114, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "description": "The current keyCode the combo is waiting for.", "name": "current", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#current", "scope": "instance", "kind": "member", "___id": "T000002R023229", "___s": true }, { "comment": "/**\r\n * The current index of the key being waited for in the `keyCodes` array.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#index\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 123, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "description": "The current index of the key being waited for in the `keyCodes` array.", "name": "index", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#index", "scope": "instance", "kind": "member", "___id": "T000002R023231", "___s": true }, { "comment": "/**\r\n * The length of this combo (in keycodes)\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#size\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 133, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "description": "The length of this combo (in keycodes)", "name": "size", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#size", "scope": "instance", "kind": "member", "___id": "T000002R023233", "___s": true }, { "comment": "/**\r\n * The time the previous key in the combo was matched.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#timeLastMatched\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "description": "The time the previous key in the combo was matched.", "name": "timeLastMatched", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#timeLastMatched", "scope": "instance", "kind": "member", "___id": "T000002R023235", "___s": true }, { "comment": "/**\r\n * Has this Key Combo been matched yet?\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#matched\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 152, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "description": "Has this Key Combo been matched yet?", "name": "matched", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#matched", "scope": "instance", "kind": "member", "___id": "T000002R023237", "___s": true }, { "comment": "/**\r\n * The time the entire combo was matched.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#timeMatched\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 162, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "description": "The time the entire combo was matched.", "name": "timeMatched", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#timeMatched", "scope": "instance", "kind": "member", "___id": "T000002R023239", "___s": true }, { "comment": "/**\r\n * If the user presses an incorrect key, the combo sequence will be reset to the beginning.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#resetOnWrongKey\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 172, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "description": "If the user presses an incorrect key, the combo sequence will be reset to the beginning.", "name": "resetOnWrongKey", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#resetOnWrongKey", "scope": "instance", "kind": "member", "___id": "T000002R023241", "___s": true }, { "comment": "/**\r\n * The max delay in ms between each key press. Above this the combo is reset. 0 means disabled.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#maxKeyDelay\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "description": "The max delay in ms between each key press. Above this the combo is reset. 0 means disabled.", "name": "maxKeyDelay", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#maxKeyDelay", "scope": "instance", "kind": "member", "___id": "T000002R023243", "___s": true }, { "comment": "/**\r\n * If the combo has previously been matched and the user presses the first key of the combo again, the combo will reset.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#resetOnMatch\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 192, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "description": "If the combo has previously been matched and the user presses the first key of the combo again, the combo will reset.", "name": "resetOnMatch", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#resetOnMatch", "scope": "instance", "kind": "member", "___id": "T000002R023245", "___s": true }, { "comment": "/**\r\n * If the combo matches successfully, this KeyCombo instance will automatically destroy itself.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#deleteOnMatch\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 202, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "description": "If the combo matches successfully, this KeyCombo instance will automatically destroy itself.", "name": "deleteOnMatch", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#deleteOnMatch", "scope": "instance", "kind": "member", "___id": "T000002R023247", "___s": true }, { "comment": "/**\r\n * How far complete is this combo? A value between 0 and 1.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCombo#progress\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 252, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "description": "How far complete is this combo? A value between 0 and 1.", "name": "progress", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCombo", "longname": "Phaser.Input.Keyboard.KeyCombo#progress", "scope": "instance", "kind": "member", "___id": "T000002R023254", "___s": true }, { "comment": "/**\r\n * Destroys this Key Combo and all of its references.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyCombo#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCombo.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\combo", "code": {} }, "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", "___id": "T000002R023257", "___s": true }, { "comment": "/**\r\n * The Global Key Down Event.\r\n *\r\n * This event is dispatched by the Keyboard Plugin when any key on the keyboard is pressed down.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.keyboard.on('keydown', listener)`.\r\n *\r\n * You can also listen for a specific key being pressed. See [Keyboard.Events.KEY_DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:KEY_DOWN} for details.\r\n *\r\n * Finally, 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.\r\n *\r\n * _Note_: Many keyboards are unable to process certain combinations of keys due to hardware limitations known as ghosting.\r\n * Read [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.\r\n *\r\n * Also, please be aware that some browser extensions can disable or override Phaser keyboard handling.\r\n * For example, the Chrome extension vimium is known to disable Phaser from using the D key, while EverNote disables the backtick key.\r\n * There are others. So, please check your extensions if you find you have specific keys that don't work.\r\n *\r\n * @event Phaser.Input.Keyboard.Events#ANY_KEY_DOWN\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {KeyboardEvent} event - The native DOM Keyboard Event. You can inspect this to learn more about the key that was pressed, any modifiers, etc.\r\n */", "meta": { "filename": "ANY_KEY_DOWN_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\events", "code": {} }, "description": "The Global Key Down Event.\r\rThis event is dispatched by the Keyboard Plugin when any key on the keyboard is pressed down.\r\rListen to this event from within a Scene using: `this.input.keyboard.on('keydown', listener)`.\r\rYou can also listen for a specific key being pressed. See [Keyboard.Events.KEY_DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:KEY_DOWN} for details.\r\rFinally, 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.\r\r_Note_: Many keyboards are unable to process certain combinations of keys due to hardware limitations known as ghosting.\rRead [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.\r\rAlso, please be aware that some browser extensions can disable or override Phaser keyboard handling.\rFor example, the Chrome extension vimium is known to disable Phaser from using the D key, while EverNote disables the backtick key.\rThere are others. So, please check your extensions if you find you have specific keys that don't work.", "kind": "event", "name": "ANY_KEY_DOWN", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "KeyboardEvent" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023287", "___s": true }, { "comment": "/**\r\n * The Global Key Up Event.\r\n *\r\n * This event is dispatched by the Keyboard Plugin when any key on the keyboard is released.\r\n *\r\n * Listen to this event from within a Scene using: `this.input.keyboard.on('keyup', listener)`.\r\n *\r\n * You can also listen for a specific key being released. See [Keyboard.Events.KEY_UP]{@linkcode Phaser.Input.Keyboard.Events#event:KEY_UP} for details.\r\n *\r\n * Finally, 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.\r\n *\r\n * @event Phaser.Input.Keyboard.Events#ANY_KEY_UP\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {KeyboardEvent} event - The native DOM Keyboard Event. You can inspect this to learn more about the key that was released, any modifiers, etc.\r\n */", "meta": { "filename": "ANY_KEY_UP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\events", "code": {} }, "description": "The Global Key Up Event.\r\rThis event is dispatched by the Keyboard Plugin when any key on the keyboard is released.\r\rListen to this event from within a Scene using: `this.input.keyboard.on('keyup', listener)`.\r\rYou can also listen for a specific key being released. See [Keyboard.Events.KEY_UP]{@linkcode Phaser.Input.Keyboard.Events#event:KEY_UP} for details.\r\rFinally, 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "KeyboardEvent" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023289", "___s": true }, { "comment": "/**\r\n * The Key Combo Match Event.\r\n *\r\n * This event is dispatched by the Keyboard Plugin when a [Key Combo]{@link Phaser.Input.Keyboard.KeyCombo} is matched.\r\n *\r\n * Listen for this event from the Key Plugin after a combo has been created:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.createCombo([ 38, 38, 40, 40, 37, 39, 37, 39, 66, 65, 13 ], { resetOnMatch: true });\r\n *\r\n * this.input.keyboard.on('keycombomatch', function (event) {\r\n * console.log('Konami Code entered!');\r\n * });\r\n * ```\r\n *\r\n * @event Phaser.Input.Keyboard.Events#COMBO_MATCH\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Keyboard.KeyCombo} keycombo - The Key Combo object that was matched.\r\n * @param {KeyboardEvent} event - The native DOM Keyboard Event of the final key in the combo. You can inspect this to learn more about any modifiers, etc.\r\n */", "meta": { "filename": "COMBO_MATCH_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\events", "code": {} }, "description": "The Key Combo Match Event.\r\rThis event is dispatched by the Keyboard Plugin when a [Key Combo]{@link Phaser.Input.Keyboard.KeyCombo} is matched.\r\rListen for this event from the Key Plugin after a combo has been created:\r\r```javascript\rthis.input.keyboard.createCombo([ 38, 38, 40, 40, 37, 39, 37, 39, 66, 65, 13 ], { resetOnMatch: true });\r\rthis.input.keyboard.on('keycombomatch', function (event) {\r console.log('Konami Code entered!');\r});\r```", "kind": "event", "name": "COMBO_MATCH", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Keyboard.KeyCombo" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.KeyCombo" } }, "description": "The Key Combo object that was matched.", "name": "keycombo" }, { "type": { "names": [ "KeyboardEvent" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023291", "___s": true }, { "comment": "/**\r\n * The Key Down Event.\r\n *\r\n * This event is dispatched by a [Key]{@link Phaser.Input.Keyboard.Key} object when it is pressed.\r\n *\r\n * Listen for this event from the Key object instance directly:\r\n *\r\n * ```javascript\r\n * var spaceBar = this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.SPACE);\r\n *\r\n * spaceBar.on('down', listener)\r\n * ```\r\n *\r\n * You can also create a generic 'global' listener. See [Keyboard.Events.ANY_KEY_DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:ANY_KEY_DOWN} for details.\r\n *\r\n * @event Phaser.Input.Keyboard.Events#DOWN\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Keyboard.Key} key - The Key object that was pressed.\r\n * @param {KeyboardEvent} event - The native DOM Keyboard Event. You can inspect this to learn more about any modifiers, etc.\r\n */", "meta": { "filename": "DOWN_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\events", "code": {} }, "description": "The Key Down Event.\r\rThis event is dispatched by a [Key]{@link Phaser.Input.Keyboard.Key} object when it is pressed.\r\rListen for this event from the Key object instance directly:\r\r```javascript\rvar spaceBar = this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.SPACE);\r\rspaceBar.on('down', listener)\r```\r\rYou 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "description": "The Key object that was pressed.", "name": "key" }, { "type": { "names": [ "KeyboardEvent" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023293", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Input.Keyboard.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Input.Keyboard", "longname": "Phaser.Input.Keyboard.Events", "scope": "static", "___id": "T000002R023295", "___s": true }, { "comment": "/**\r\n * The Key Down Event.\r\n *\r\n * This event is dispatched by the Keyboard Plugin when any key on the keyboard is pressed down.\r\n *\r\n * Unlike the `ANY_KEY_DOWN` event, this one has a special dynamic event name. For example, to listen for the `A` key being pressed\r\n * use the following from within a Scene: `this.input.keyboard.on('keydown-A', listener)`. You can replace the `-A` part of the event\r\n * name with any valid [Key Code string]{@link Phaser.Input.Keyboard.KeyCodes}. For example, this will listen for the space bar:\r\n * `this.input.keyboard.on('keydown-SPACE', listener)`.\r\n *\r\n * You can also create a generic 'global' listener. See [Keyboard.Events.ANY_KEY_DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:ANY_KEY_DOWN} for details.\r\n *\r\n * Finally, 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.\r\n *\r\n * _Note_: Many keyboards are unable to process certain combinations of keys due to hardware limitations known as ghosting.\r\n * Read [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.\r\n *\r\n * Also, please be aware that some browser extensions can disable or override Phaser keyboard handling.\r\n * For example, the Chrome extension vimium is known to disable Phaser from using the D key, while EverNote disables the backtick key.\r\n * There are others. So, please check your extensions if you find you have specific keys that don't work.\r\n *\r\n * @event Phaser.Input.Keyboard.Events#KEY_DOWN\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {KeyboardEvent} event - The native DOM Keyboard Event. You can inspect this to learn more about the key that was pressed, any modifiers, etc.\r\n */", "meta": { "filename": "KEY_DOWN_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\events", "code": {} }, "description": "The Key Down Event.\r\rThis event is dispatched by the Keyboard Plugin when any key on the keyboard is pressed down.\r\rUnlike the `ANY_KEY_DOWN` event, this one has a special dynamic event name. For example, to listen for the `A` key being pressed\ruse the following from within a Scene: `this.input.keyboard.on('keydown-A', listener)`. You can replace the `-A` part of the event\rname with any valid [Key Code string]{@link Phaser.Input.Keyboard.KeyCodes}. For example, this will listen for the space bar:\r`this.input.keyboard.on('keydown-SPACE', listener)`.\r\rYou can also create a generic 'global' listener. See [Keyboard.Events.ANY_KEY_DOWN]{@linkcode Phaser.Input.Keyboard.Events#event:ANY_KEY_DOWN} for details.\r\rFinally, 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.\r\r_Note_: Many keyboards are unable to process certain combinations of keys due to hardware limitations known as ghosting.\rRead [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.\r\rAlso, please be aware that some browser extensions can disable or override Phaser keyboard handling.\rFor example, the Chrome extension vimium is known to disable Phaser from using the D key, while EverNote disables the backtick key.\rThere are others. So, please check your extensions if you find you have specific keys that don't work.", "kind": "event", "name": "KEY_DOWN", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "KeyboardEvent" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023304", "___s": true }, { "comment": "/**\r\n * The Key Up Event.\r\n *\r\n * This event is dispatched by the Keyboard Plugin when any key on the keyboard is released.\r\n *\r\n * Unlike the `ANY_KEY_UP` event, this one has a special dynamic event name. For example, to listen for the `A` key being released\r\n * use the following from within a Scene: `this.input.keyboard.on('keyup-A', listener)`. You can replace the `-A` part of the event\r\n * name with any valid [Key Code string]{@link Phaser.Input.Keyboard.KeyCodes}. For example, this will listen for the space bar:\r\n * `this.input.keyboard.on('keyup-SPACE', listener)`.\r\n *\r\n * You can also create a generic 'global' listener. See [Keyboard.Events.ANY_KEY_UP]{@linkcode Phaser.Input.Keyboard.Events#event:ANY_KEY_UP} for details.\r\n *\r\n * Finally, 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.\r\n *\r\n * @event Phaser.Input.Keyboard.Events#KEY_UP\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {KeyboardEvent} event - The native DOM Keyboard Event. You can inspect this to learn more about the key that was released, any modifiers, etc.\r\n */", "meta": { "filename": "KEY_UP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\events", "code": {} }, "description": "The Key Up Event.\r\rThis event is dispatched by the Keyboard Plugin when any key on the keyboard is released.\r\rUnlike the `ANY_KEY_UP` event, this one has a special dynamic event name. For example, to listen for the `A` key being released\ruse the following from within a Scene: `this.input.keyboard.on('keyup-A', listener)`. You can replace the `-A` part of the event\rname with any valid [Key Code string]{@link Phaser.Input.Keyboard.KeyCodes}. For example, this will listen for the space bar:\r`this.input.keyboard.on('keyup-SPACE', listener)`.\r\rYou can also create a generic 'global' listener. See [Keyboard.Events.ANY_KEY_UP]{@linkcode Phaser.Input.Keyboard.Events#event:ANY_KEY_UP} for details.\r\rFinally, 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "KeyboardEvent" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023306", "___s": true }, { "comment": "/**\r\n * The Key Up Event.\r\n *\r\n * This event is dispatched by a [Key]{@link Phaser.Input.Keyboard.Key} object when it is released.\r\n *\r\n * Listen for this event from the Key object instance directly:\r\n *\r\n * ```javascript\r\n * var spaceBar = this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.SPACE);\r\n *\r\n * spaceBar.on('up', listener)\r\n * ```\r\n *\r\n * You can also create a generic 'global' listener. See [Keyboard.Events.ANY_KEY_UP]{@linkcode Phaser.Input.Keyboard.Events#event:ANY_KEY_UP} for details.\r\n *\r\n * @event Phaser.Input.Keyboard.Events#UP\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Keyboard.Key} key - The Key object that was released.\r\n * @param {KeyboardEvent} event - The native DOM Keyboard Event. You can inspect this to learn more about any modifiers, etc.\r\n */", "meta": { "filename": "UP_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\events", "code": {} }, "description": "The Key Up Event.\r\rThis event is dispatched by a [Key]{@link Phaser.Input.Keyboard.Key} object when it is released.\r\rListen for this event from the Key object instance directly:\r\r```javascript\rvar spaceBar = this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.SPACE);\r\rspaceBar.on('up', listener)\r```\r\rYou 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "description": "The Key object that was released.", "name": "key" }, { "type": { "names": [ "KeyboardEvent" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023308", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Input.Keyboard\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "kind": "namespace", "name": "Keyboard", "memberof": "Phaser.Input", "longname": "Phaser.Input.Keyboard", "scope": "static", "___id": "T000002R023310", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Keyboard Manager is a helper class that belongs to the global Input Manager.\r\n *\r\n * Its role is to listen for native DOM Keyboard Events and then store them for further processing by the Keyboard Plugin.\r\n *\r\n * You do not need to create this class directly, the Input Manager will create an instance of it automatically if keyboard\r\n * input has been enabled in the Game Config.\r\n *\r\n * @class KeyboardManager\r\n * @memberof Phaser.Input.Keyboard\r\n * @constructor\r\n * @since 3.16.0\r\n *\r\n * @param {Phaser.Input.InputManager} inputManager - A reference to the Input Manager.\r\n */", "meta": { "filename": "KeyboardManager.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "classdesc": "The Keyboard Manager is a helper class that belongs to the global Input Manager.\r\rIts role is to listen for native DOM Keyboard Events and then store them for further processing by the Keyboard Plugin.\r\rYou do not need to create this class directly, the Input Manager will create an instance of it automatically if keyboard\rinput 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputManager" } }, "description": "A reference to the Input Manager.", "name": "inputManager" } ], "scope": "static", "longname": "Phaser.Input.Keyboard.KeyboardManager", "___id": "T000002R023331", "___s": true }, { "comment": "/**\r\n * A reference to the Input Manager.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardManager#manager\r\n * @type {Phaser.Input.InputManager}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "KeyboardManager.js", "lineno": 36, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "A reference to the Input Manager.", "name": "manager", "type": { "names": [ "Phaser.Input.InputManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputManager" } }, "since": "3.16.0", "memberof": "Phaser.Input.Keyboard.KeyboardManager", "longname": "Phaser.Input.Keyboard.KeyboardManager#manager", "scope": "instance", "kind": "member", "___id": "T000002R023334", "___s": true }, { "comment": "/**\r\n * A flag that controls if the non-modified keys, matching those stored in the `captures` array,\r\n * have `preventDefault` called on them or not.\r\n *\r\n * A non-modified key is one that doesn't have a modifier key held down with it. The modifier keys are\r\n * shift, control, alt and the meta key (Command on a Mac, the Windows Key on Windows).\r\n * Therefore, if the user presses shift + r, it won't prevent this combination, because of the modifier.\r\n * However, if the user presses just the r key on its own, it will have its event prevented.\r\n *\r\n * If you wish to stop capturing the keys, for example switching out to a DOM based element, then\r\n * you can toggle this property at run-time.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardManager#preventDefault\r\n * @type {boolean}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "KeyboardManager.js", "lineno": 55, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "A flag that controls if the non-modified keys, matching those stored in the `captures` array,\rhave `preventDefault` called on them or not.\r\rA non-modified key is one that doesn't have a modifier key held down with it. The modifier keys are\rshift, control, alt and the meta key (Command on a Mac, the Windows Key on Windows).\rTherefore, if the user presses shift + r, it won't prevent this combination, because of the modifier.\rHowever, if the user presses just the r key on its own, it will have its event prevented.\r\rIf you wish to stop capturing the keys, for example switching out to a DOM based element, then\ryou can toggle this property at run-time.", "name": "preventDefault", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.16.0", "memberof": "Phaser.Input.Keyboard.KeyboardManager", "longname": "Phaser.Input.Keyboard.KeyboardManager#preventDefault", "scope": "instance", "kind": "member", "___id": "T000002R023338", "___s": true }, { "comment": "/**\r\n * An array of Key Code values that will automatically have `preventDefault` called on them,\r\n * as long as the `KeyboardManager.preventDefault` boolean is set to `true`.\r\n *\r\n * By default the array is empty.\r\n *\r\n * The key must be non-modified when pressed in order to be captured.\r\n *\r\n * A non-modified key is one that doesn't have a modifier key held down with it. The modifier keys are\r\n * shift, control, alt and the meta key (Command on a Mac, the Windows Key on Windows).\r\n * Therefore, if the user presses shift + r, it won't prevent this combination, because of the modifier.\r\n * However, if the user presses just the r key on its own, it will have its event prevented.\r\n *\r\n * If you wish to stop capturing the keys, for example switching out to a DOM based element, then\r\n * you can toggle the `KeyboardManager.preventDefault` boolean at run-time.\r\n *\r\n * If you need more specific control, you can create Key objects and set the flag on each of those instead.\r\n *\r\n * This array can be populated via the Game Config by setting the `input.keyboard.capture` array, or you\r\n * can call the `addCapture` method. See also `removeCapture` and `clearCaptures`.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardManager#captures\r\n * @type {number[]}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "KeyboardManager.js", "lineno": 73, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "An array of Key Code values that will automatically have `preventDefault` called on them,\ras long as the `KeyboardManager.preventDefault` boolean is set to `true`.\r\rBy default the array is empty.\r\rThe key must be non-modified when pressed in order to be captured.\r\rA non-modified key is one that doesn't have a modifier key held down with it. The modifier keys are\rshift, control, alt and the meta key (Command on a Mac, the Windows Key on Windows).\rTherefore, if the user presses shift + r, it won't prevent this combination, because of the modifier.\rHowever, if the user presses just the r key on its own, it will have its event prevented.\r\rIf you wish to stop capturing the keys, for example switching out to a DOM based element, then\ryou can toggle the `KeyboardManager.preventDefault` boolean at run-time.\r\rIf you need more specific control, you can create Key objects and set the flag on each of those instead.\r\rThis array can be populated via the Game Config by setting the `input.keyboard.capture` array, or you\rcan call the `addCapture` method. See also `removeCapture` and `clearCaptures`.", "name": "captures", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "since": "3.16.0", "memberof": "Phaser.Input.Keyboard.KeyboardManager", "longname": "Phaser.Input.Keyboard.KeyboardManager#captures", "scope": "instance", "kind": "member", "___id": "T000002R023340", "___s": true }, { "comment": "/**\r\n * A boolean that controls if the Keyboard Manager is enabled or not.\r\n * Can be toggled on the fly.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardManager#enabled\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.16.0\r\n */", "meta": { "filename": "KeyboardManager.js", "lineno": 100, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "A boolean that controls if the Keyboard Manager is enabled or not.\rCan be toggled on the fly.", "name": "enabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.16.0", "memberof": "Phaser.Input.Keyboard.KeyboardManager", "longname": "Phaser.Input.Keyboard.KeyboardManager#enabled", "scope": "instance", "kind": "member", "___id": "T000002R023342", "___s": true }, { "comment": "/**\r\n * The Keyboard Event target, as defined in the Game Config.\r\n * Typically the window in which the game is rendering, but can be any interactive DOM element.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardManager#target\r\n * @type {any}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "KeyboardManager.js", "lineno": 111, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "The Keyboard Event target, as defined in the Game Config.\rTypically the window in which the game is rendering, but can be any interactive DOM element.", "name": "target", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.16.0", "memberof": "Phaser.Input.Keyboard.KeyboardManager", "longname": "Phaser.Input.Keyboard.KeyboardManager#target", "scope": "instance", "kind": "member", "___id": "T000002R023344", "___s": true }, { "comment": "/**\r\n * The Key Down Event handler.\r\n * This function is sent the native DOM KeyEvent.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardManager#onKeyDown\r\n * @type {function}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "KeyboardManager.js", "lineno": 121, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "The Key Down Event handler.\rThis function is sent the native DOM KeyEvent.\rInitially empty and bound in the `startListeners` method.", "name": "onKeyDown", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.16.0", "memberof": "Phaser.Input.Keyboard.KeyboardManager", "longname": "Phaser.Input.Keyboard.KeyboardManager#onKeyDown", "scope": "instance", "kind": "member", "___id": "T000002R023346", "___s": true }, { "comment": "/**\r\n * The Key Up Event handler.\r\n * This function is sent the native DOM KeyEvent.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardManager#onKeyUp\r\n * @type {function}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "KeyboardManager.js", "lineno": 132, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "The Key Up Event handler.\rThis function is sent the native DOM KeyEvent.\rInitially empty and bound in the `startListeners` method.", "name": "onKeyUp", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.16.0", "memberof": "Phaser.Input.Keyboard.KeyboardManager", "longname": "Phaser.Input.Keyboard.KeyboardManager#onKeyUp", "scope": "instance", "kind": "member", "___id": "T000002R023348", "___s": true }, { "comment": "/**\r\n * Starts the Keyboard Event listeners running.\r\n * This is called automatically and does not need to be manually invoked.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardManager#startListeners\r\n * @since 3.16.0\r\n */", "meta": { "filename": "KeyboardManager.js", "lineno": 175, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "Starts the Keyboard Event listeners running.\rThis 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", "___id": "T000002R023356", "___s": true }, { "comment": "/**\r\n * Stops the Key Event listeners.\r\n * This is called automatically and does not need to be manually invoked.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardManager#stopListeners\r\n * @since 3.16.0\r\n */", "meta": { "filename": "KeyboardManager.js", "lineno": 237, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "Stops the Key Event listeners.\rThis 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", "___id": "T000002R023365", "___s": true }, { "comment": "/**\r\n * By default when a key is pressed Phaser will not stop the event from propagating up to the browser.\r\n * There are some keys this can be annoying for, like the arrow keys or space bar, which make the browser window scroll.\r\n *\r\n * This `addCapture` method enables consuming keyboard events for specific keys so they don't bubble up to the browser\r\n * and cause the default browser behavior.\r\n *\r\n * Please note that keyboard captures are global. This means that if you call this method from within a Scene, to say prevent\r\n * the SPACE BAR from triggering a page scroll, then it will prevent it for any Scene in your game, not just the calling one.\r\n *\r\n * You can pass in a single key code value, or an array of key codes, or a string:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.addCapture(62);\r\n * ```\r\n *\r\n * An array of key codes:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.addCapture([ 62, 63, 64 ]);\r\n * ```\r\n *\r\n * Or a string:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.addCapture('W,S,A,D');\r\n * ```\r\n *\r\n * To use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\r\n *\r\n * You can also provide an array mixing both strings and key code integers.\r\n *\r\n * If there are active captures after calling this method, the `preventDefault` property is set to `true`.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardManager#addCapture\r\n * @since 3.16.0\r\n *\r\n * @param {(string|number|number[]|any[])} keycode - The Key Codes to enable capture for, preventing them reaching the browser.\r\n */", "meta": { "filename": "KeyboardManager.js", "lineno": 267, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "By default when a key is pressed Phaser will not stop the event from propagating up to the browser.\rThere are some keys this can be annoying for, like the arrow keys or space bar, which make the browser window scroll.\r\rThis `addCapture` method enables consuming keyboard events for specific keys so they don't bubble up to the browser\rand cause the default browser behavior.\r\rPlease note that keyboard captures are global. This means that if you call this method from within a Scene, to say prevent\rthe SPACE BAR from triggering a page scroll, then it will prevent it for any Scene in your game, not just the calling one.\r\rYou can pass in a single key code value, or an array of key codes, or a string:\r\r```javascript\rthis.input.keyboard.addCapture(62);\r```\r\rAn array of key codes:\r\r```javascript\rthis.input.keyboard.addCapture([ 62, 63, 64 ]);\r```\r\rOr a string:\r\r```javascript\rthis.input.keyboard.addCapture('W,S,A,D');\r```\r\rTo use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\r\rYou can also provide an array mixing both strings and key code integers.\r\rIf 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", "number", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "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", "___id": "T000002R023372", "___s": true }, { "comment": "/**\r\n * Removes an existing key capture.\r\n *\r\n * Please note that keyboard captures are global. This means that if you call this method from within a Scene, to remove\r\n * the capture of a key, then it will remove it for any Scene in your game, not just the calling one.\r\n *\r\n * You can pass in a single key code value, or an array of key codes, or a string:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.removeCapture(62);\r\n * ```\r\n *\r\n * An array of key codes:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.removeCapture([ 62, 63, 64 ]);\r\n * ```\r\n *\r\n * Or a string:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.removeCapture('W,S,A,D');\r\n * ```\r\n *\r\n * To use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\r\n *\r\n * You can also provide an array mixing both strings and key code integers.\r\n *\r\n * If there are no captures left after calling this method, the `preventDefault` property is set to `false`.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardManager#removeCapture\r\n * @since 3.16.0\r\n *\r\n * @param {(string|number|number[]|any[])} keycode - The Key Codes to disable capture for, allowing them reaching the browser again.\r\n */", "meta": { "filename": "KeyboardManager.js", "lineno": 338, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "Removes an existing key capture.\r\rPlease note that keyboard captures are global. This means that if you call this method from within a Scene, to remove\rthe capture of a key, then it will remove it for any Scene in your game, not just the calling one.\r\rYou can pass in a single key code value, or an array of key codes, or a string:\r\r```javascript\rthis.input.keyboard.removeCapture(62);\r```\r\rAn array of key codes:\r\r```javascript\rthis.input.keyboard.removeCapture([ 62, 63, 64 ]);\r```\r\rOr a string:\r\r```javascript\rthis.input.keyboard.removeCapture('W,S,A,D');\r```\r\rTo use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\r\rYou can also provide an array mixing both strings and key code integers.\r\rIf 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", "number", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "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", "___id": "T000002R023381", "___s": true }, { "comment": "/**\r\n * Removes all keyboard captures and sets the `preventDefault` property to `false`.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardManager#clearCaptures\r\n * @since 3.16.0\r\n */", "meta": { "filename": "KeyboardManager.js", "lineno": 402, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "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", "___id": "T000002R023390", "___s": true }, { "comment": "/**\r\n * Destroys this Keyboard Manager instance.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardManager#destroy\r\n * @since 3.16.0\r\n */", "meta": { "filename": "KeyboardManager.js", "lineno": 415, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "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", "___id": "T000002R023394", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Keyboard Plugin is an input plugin that belongs to the Scene-owned Input system.\r\n *\r\n * Its role is to listen for native DOM Keyboard Events and then process them.\r\n *\r\n * You do not need to create this class directly, the Input system will create an instance of it automatically.\r\n *\r\n * You can access it from within a Scene using `this.input.keyboard`. For example, you can do:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.on('keydown', callback, context);\r\n * ```\r\n *\r\n * Or, to listen for a specific key:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.on('keydown-A', callback, context);\r\n * ```\r\n *\r\n * You can also create Key objects, which you can then poll in your game loop:\r\n *\r\n * ```javascript\r\n * var spaceBar = this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.SPACE);\r\n * ```\r\n *\r\n * If you have multiple parallel Scenes, each trying to get keyboard input, be sure to disable capture on them to stop them from\r\n * stealing input from another Scene in the list. You can do this with `this.input.keyboard.enabled = false` within the\r\n * Scene to stop all input, or `this.input.keyboard.preventDefault = false` to stop a Scene halting input on another Scene.\r\n *\r\n * _Note_: Many keyboards are unable to process certain combinations of keys due to hardware limitations known as ghosting.\r\n * See http://www.html5gamedevs.com/topic/4876-impossible-to-use-more-than-2-keyboard-input-buttons-at-the-same-time/ for more details\r\n * and use the site https://w3c.github.io/uievents/tools/key-event-viewer.html to test your n-key support in browser.\r\n *\r\n * Also please be aware that certain browser extensions can disable or override Phaser keyboard handling.\r\n * For example the Chrome extension vimium is known to disable Phaser from using the D key, while EverNote disables the backtick key.\r\n * And there are others. So, please check your extensions before opening Phaser issues about keys that don't work.\r\n *\r\n * @class KeyboardPlugin\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Input.Keyboard\r\n * @constructor\r\n * @since 3.10.0\r\n *\r\n * @param {Phaser.Input.InputPlugin} sceneInputPlugin - A reference to the Scene Input Plugin that the KeyboardPlugin belongs to.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 21, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "classdesc": "The Keyboard Plugin is an input plugin that belongs to the Scene-owned Input system.\r\rIts role is to listen for native DOM Keyboard Events and then process them.\r\rYou do not need to create this class directly, the Input system will create an instance of it automatically.\r\rYou can access it from within a Scene using `this.input.keyboard`. For example, you can do:\r\r```javascript\rthis.input.keyboard.on('keydown', callback, context);\r```\r\rOr, to listen for a specific key:\r\r```javascript\rthis.input.keyboard.on('keydown-A', callback, context);\r```\r\rYou can also create Key objects, which you can then poll in your game loop:\r\r```javascript\rvar spaceBar = this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.SPACE);\r```\r\rIf you have multiple parallel Scenes, each trying to get keyboard input, be sure to disable capture on them to stop them from\rstealing input from another Scene in the list. You can do this with `this.input.keyboard.enabled = false` within the\rScene to stop all input, or `this.input.keyboard.preventDefault = false` to stop a Scene halting input on another Scene.\r\r_Note_: Many keyboards are unable to process certain combinations of keys due to hardware limitations known as ghosting.\rSee http://www.html5gamedevs.com/topic/4876-impossible-to-use-more-than-2-keyboard-input-buttons-at-the-same-time/ for more details\rand use the site https://w3c.github.io/uievents/tools/key-event-viewer.html to test your n-key support in browser.\r\rAlso please be aware that certain browser extensions can disable or override Phaser keyboard handling.\rFor example the Chrome extension vimium is known to disable Phaser from using the D key, while EverNote disables the backtick key.\rAnd 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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023414", "___s": true }, { "comment": "/**\r\n * A reference to the core game, so we can listen for visibility events.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardPlugin#game\r\n * @type {Phaser.Game}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 77, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "A reference to the core game, so we can listen for visibility events.", "name": "game", "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "since": "3.16.0", "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#game", "scope": "instance", "kind": "member", "___id": "T000002R023418", "___s": true }, { "comment": "/**\r\n * A reference to the Scene that this Input Plugin is responsible for.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardPlugin#scene\r\n * @type {Phaser.Scene}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "A reference to the Scene that this Input Plugin is responsible for.", "name": "scene", "type": { "names": [ "Phaser.Scene" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Scene" } }, "since": "3.10.0", "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#scene", "scope": "instance", "kind": "member", "___id": "T000002R023420", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Systems Settings.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardPlugin#settings\r\n * @type {Phaser.Types.Scenes.SettingsObject}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 95, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "A reference to the Scene Systems Settings.", "name": "settings", "type": { "names": [ "Phaser.Types.Scenes.SettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Scenes.SettingsObject" } }, "since": "3.10.0", "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#settings", "scope": "instance", "kind": "member", "___id": "T000002R023422", "___s": true }, { "comment": "/**\r\n * A reference to the Scene Input Plugin that created this Keyboard Plugin.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardPlugin#sceneInputPlugin\r\n * @type {Phaser.Input.InputPlugin}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 104, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "A reference to the Scene Input Plugin that created this Keyboard Plugin.", "name": "sceneInputPlugin", "type": { "names": [ "Phaser.Input.InputPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputPlugin" } }, "since": "3.10.0", "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#sceneInputPlugin", "scope": "instance", "kind": "member", "___id": "T000002R023424", "___s": true }, { "comment": "/**\r\n * A reference to the global Keyboard Manager.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardPlugin#manager\r\n * @type {Phaser.Input.Keyboard.KeyboardManager}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 113, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "A reference to the global Keyboard Manager.", "name": "manager", "type": { "names": [ "Phaser.Input.Keyboard.KeyboardManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.KeyboardManager" } }, "since": "3.16.0", "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#manager", "scope": "instance", "kind": "member", "___id": "T000002R023426", "___s": true }, { "comment": "/**\r\n * A boolean that controls if this Keyboard Plugin is enabled or not.\r\n * Can be toggled on the fly.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardPlugin#enabled\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.10.0\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 122, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "A boolean that controls if this Keyboard Plugin is enabled or not.\rCan be toggled on the fly.", "name": "enabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.10.0", "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#enabled", "scope": "instance", "kind": "member", "___id": "T000002R023428", "___s": true }, { "comment": "/**\r\n * An array of Key objects to process.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardPlugin#keys\r\n * @type {Phaser.Input.Keyboard.Key[]}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 133, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "An array of Key objects to process.", "name": "keys", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Input.Keyboard.Key", "type": "NameExpression" } ] } }, "since": "3.10.0", "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#keys", "scope": "instance", "kind": "member", "___id": "T000002R023430", "___s": true }, { "comment": "/**\r\n * An array of KeyCombo objects to process.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyboardPlugin#combos\r\n * @type {Phaser.Input.Keyboard.KeyCombo[]}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 142, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "An array of KeyCombo objects to process.", "name": "combos", "type": { "names": [ "Array." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Input.Keyboard.KeyCombo", "type": "NameExpression" } ] } }, "since": "3.10.0", "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#combos", "scope": "instance", "kind": "member", "___id": "T000002R023432", "___s": true }, { "comment": "/**\r\n * Checks to see if both this plugin and the Scene to which it belongs is active.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#isActive\r\n * @since 3.10.0\r\n *\r\n * @return {boolean} `true` if the plugin and the Scene it belongs to is active.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023447", "___s": true }, { "comment": "/**\r\n * By default when a key is pressed Phaser will not stop the event from propagating up to the browser.\r\n * There are some keys this can be annoying for, like the arrow keys or space bar, which make the browser window scroll.\r\n *\r\n * This `addCapture` method enables consuming keyboard events for specific keys, so they don't bubble up the browser\r\n * and cause the default behaviors.\r\n *\r\n * Please note that keyboard captures are global. This means that if you call this method from within a Scene, to say prevent\r\n * the SPACE BAR from triggering a page scroll, then it will prevent it for any Scene in your game, not just the calling one.\r\n *\r\n * You can pass a single key code value:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.addCapture(62);\r\n * ```\r\n *\r\n * An array of key codes:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.addCapture([ 62, 63, 64 ]);\r\n * ```\r\n *\r\n * Or, a comma-delimited string:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.addCapture('W,S,A,D');\r\n * ```\r\n *\r\n * To use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\r\n *\r\n * You can also provide an array mixing both strings and key code integers.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#addCapture\r\n * @since 3.16.0\r\n *\r\n * @param {(string|number|number[]|any[])} keycode - The Key Codes to enable event capture for.\r\n *\r\n * @return {this} This KeyboardPlugin object.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 243, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "By default when a key is pressed Phaser will not stop the event from propagating up to the browser.\rThere are some keys this can be annoying for, like the arrow keys or space bar, which make the browser window scroll.\r\rThis `addCapture` method enables consuming keyboard events for specific keys, so they don't bubble up the browser\rand cause the default behaviors.\r\rPlease note that keyboard captures are global. This means that if you call this method from within a Scene, to say prevent\rthe SPACE BAR from triggering a page scroll, then it will prevent it for any Scene in your game, not just the calling one.\r\rYou can pass a single key code value:\r\r```javascript\rthis.input.keyboard.addCapture(62);\r```\r\rAn array of key codes:\r\r```javascript\rthis.input.keyboard.addCapture([ 62, 63, 64 ]);\r```\r\rOr, a comma-delimited string:\r\r```javascript\rthis.input.keyboard.addCapture('W,S,A,D');\r```\r\rTo use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\r\rYou can also provide an array mixing both strings and key code integers.", "kind": "function", "name": "addCapture", "since": "3.16.0", "params": [ { "type": { "names": [ "string", "number", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The Key Codes to enable event capture for.", "name": "keycode" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This KeyboardPlugin object." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#addCapture", "scope": "instance", "___id": "T000002R023449", "___s": true }, { "comment": "/**\r\n * Removes an existing key capture.\r\n *\r\n * Please note that keyboard captures are global. This means that if you call this method from within a Scene, to remove\r\n * the capture of a key, then it will remove it for any Scene in your game, not just the calling one.\r\n *\r\n * You can pass a single key code value:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.removeCapture(62);\r\n * ```\r\n *\r\n * An array of key codes:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.removeCapture([ 62, 63, 64 ]);\r\n * ```\r\n *\r\n * Or, a comma-delimited string:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.removeCapture('W,S,A,D');\r\n * ```\r\n *\r\n * To use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\r\n *\r\n * You can also provide an array mixing both strings and key code integers.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#removeCapture\r\n * @since 3.16.0\r\n *\r\n * @param {(string|number|number[]|any[])} keycode - The Key Codes to disable event capture for.\r\n *\r\n * @return {this} This KeyboardPlugin object.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 289, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "Removes an existing key capture.\r\rPlease note that keyboard captures are global. This means that if you call this method from within a Scene, to remove\rthe capture of a key, then it will remove it for any Scene in your game, not just the calling one.\r\rYou can pass a single key code value:\r\r```javascript\rthis.input.keyboard.removeCapture(62);\r```\r\rAn array of key codes:\r\r```javascript\rthis.input.keyboard.removeCapture([ 62, 63, 64 ]);\r```\r\rOr, a comma-delimited string:\r\r```javascript\rthis.input.keyboard.removeCapture('W,S,A,D');\r```\r\rTo use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\r\rYou can also provide an array mixing both strings and key code integers.", "kind": "function", "name": "removeCapture", "since": "3.16.0", "params": [ { "type": { "names": [ "string", "number", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "any", "type": "NameExpression" } ] } ] } }, "description": "The Key Codes to disable event capture for.", "name": "keycode" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This KeyboardPlugin object." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#removeCapture", "scope": "instance", "___id": "T000002R023451", "___s": true }, { "comment": "/**\r\n * Returns an array that contains all of the keyboard captures currently enabled.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#getCaptures\r\n * @since 3.16.0\r\n *\r\n * @return {number[]} An array of all the currently capturing key codes.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 331, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "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." ], "parsedType": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] } }, "description": "An array of all the currently capturing key codes." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#getCaptures", "scope": "instance", "___id": "T000002R023453", "___s": true }, { "comment": "/**\r\n * Allows Phaser to prevent any key captures you may have defined from bubbling up the browser.\r\n * You can use this to re-enable event capturing if you had paused it via `disableGlobalCapture`.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#enableGlobalCapture\r\n * @since 3.16.0\r\n *\r\n * @return {this} This KeyboardPlugin object.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 344, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "Allows Phaser to prevent any key captures you may have defined from bubbling up the browser.\rYou 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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This KeyboardPlugin object." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#enableGlobalCapture", "scope": "instance", "___id": "T000002R023455", "___s": true }, { "comment": "/**\r\n * Disables Phaser from preventing any key captures you may have defined, without actually removing them.\r\n * You can use this to temporarily disable event capturing if, for example, you swap to a DOM element.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#disableGlobalCapture\r\n * @since 3.16.0\r\n *\r\n * @return {this} This KeyboardPlugin object.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 360, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "Disables Phaser from preventing any key captures you may have defined, without actually removing them.\rYou 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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This KeyboardPlugin object." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#disableGlobalCapture", "scope": "instance", "___id": "T000002R023458", "___s": true }, { "comment": "/**\r\n * Removes all keyboard captures.\r\n *\r\n * Note that this is a global change. It will clear all event captures across your game, not just for this specific Scene.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#clearCaptures\r\n * @since 3.16.0\r\n *\r\n * @return {this} This KeyboardPlugin object.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 376, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "Removes all keyboard captures.\r\rNote 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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This KeyboardPlugin object." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#clearCaptures", "scope": "instance", "___id": "T000002R023461", "___s": true }, { "comment": "/**\r\n * Creates and returns an object containing 6 hotkeys for Up, Down, Left and Right, and also Space Bar and Shift.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#createCursorKeys\r\n * @since 3.10.0\r\n *\r\n * @return {Phaser.Types.Input.Keyboard.CursorKeys} An object containing the properties: `up`, `down`, `left`, `right`, `space` and `shift`.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 393, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "Creates and returns an object containing 6 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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023463", "___s": true }, { "comment": "/**\r\n * A practical way to create an object containing user selected hotkeys.\r\n *\r\n * For example:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.addKeys({ 'up': Phaser.Input.Keyboard.KeyCodes.W, 'down': Phaser.Input.Keyboard.KeyCodes.S });\r\n * ```\r\n *\r\n * would return an object containing the properties (`up` and `down`) mapped to W and S {@link Phaser.Input.Keyboard.Key} objects.\r\n *\r\n * You can also pass in a comma-separated string:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.addKeys('W,S,A,D');\r\n * ```\r\n *\r\n * Which will return an object with the properties W, S, A and D mapped to the relevant Key objects.\r\n *\r\n * To use non-alpha numeric keys, use a string, such as 'UP', 'SPACE' or 'LEFT'.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#addKeys\r\n * @since 3.10.0\r\n *\r\n * @param {(object|string)} keys - An object containing Key Codes, or a comma-separated string.\r\n * @param {boolean} [enableCapture=true] - Automatically call `preventDefault` on the native DOM browser event for the key codes being added.\r\n * @param {boolean} [emitOnRepeat=false] - Controls if the Key will continuously emit a 'down' event while being held down (true), or emit the event just once (false, the default).\r\n *\r\n * @return {object} An object containing Key objects mapped to the input properties.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 413, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "A practical way to create an object containing user selected hotkeys.\r\rFor example:\r\r```javascript\rthis.input.keyboard.addKeys({ 'up': Phaser.Input.Keyboard.KeyCodes.W, 'down': Phaser.Input.Keyboard.KeyCodes.S });\r```\r\rwould return an object containing the properties (`up` and `down`) mapped to W and S {@link Phaser.Input.Keyboard.Key} objects.\r\rYou can also pass in a comma-separated string:\r\r```javascript\rthis.input.keyboard.addKeys('W,S,A,D');\r```\r\rWhich will return an object with the properties W, S, A and D mapped to the relevant Key objects.\r\rTo 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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "An object containing Key Codes, or a comma-separated string.", "name": "keys" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023471", "___s": true }, { "comment": "/**\r\n * Adds a Key object to this Keyboard Plugin.\r\n *\r\n * The given argument can be either an existing Key object, a string, such as `A` or `SPACE`, or a key code value.\r\n *\r\n * If a Key object is given, and one already exists matching the same key code, the existing one is replaced with the new one.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#addKey\r\n * @since 3.10.0\r\n *\r\n * @param {(Phaser.Input.Keyboard.Key|string|number)} key - Either a Key object, a string, such as `A` or `SPACE`, or a key code value.\r\n * @param {boolean} [enableCapture=true] - Automatically call `preventDefault` on the native DOM browser event for the key codes being added.\r\n * @param {boolean} [emitOnRepeat=false] - Controls if the Key will continuously emit a 'down' event while being held down (true), or emit the event just once (false, the default).\r\n *\r\n * @return {Phaser.Input.Keyboard.Key} The newly created Key object, or a reference to it if it already existed in the keys array.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 475, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "Adds a Key object to this Keyboard Plugin.\r\rThe given argument can be either an existing Key object, a string, such as `A` or `SPACE`, or a key code value.\r\rIf 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", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" }, { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "Either a Key object, a string, such as `A` or `SPACE`, or a key code value.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023482", "___s": true }, { "comment": "/**\r\n * Removes a Key object from this Keyboard Plugin.\r\n *\r\n * The given argument can be either a Key object, a string, such as `A` or `SPACE`, or a key code value.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#removeKey\r\n * @since 3.10.0\r\n *\r\n * @param {(Phaser.Input.Keyboard.Key|string|number)} key - Either a Key object, a string, such as `A` or `SPACE`, or a key code value.\r\n * @param {boolean} [destroy=false] - Call `Key.destroy` on the removed Key object?\r\n * @param {boolean} [removeCapture=false] - Remove this Key from being captured? Only applies if set to capture when created.\r\n *\r\n * @return {this} This KeyboardPlugin object.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 541, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "Removes a Key object from this Keyboard Plugin.\r\rThe 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", "number" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" }, { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "number" } ] } }, "description": "Either a Key object, a string, such as `A` or `SPACE`, or a key code value.", "name": "key" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Call `Key.destroy` on the removed Key object?", "name": "destroy" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Remove this Key from being captured? Only applies if set to capture when created.", "name": "removeCapture" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This KeyboardPlugin object." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#removeKey", "scope": "instance", "___id": "T000002R023492", "___s": true }, { "comment": "/**\r\n * Removes all Key objects created by _this_ Keyboard Plugin.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#removeAllKeys\r\n * @since 3.24.0\r\n *\r\n * @param {boolean} [destroy=false] - Call `Key.destroy` on each removed Key object?\r\n * @param {boolean} [removeCapture=false] - Remove all key captures for Key objects owned by this plugin?\r\n *\r\n * @return {this} This KeyboardPlugin object.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 604, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "Removes all Key objects created by _this_ Keyboard Plugin.", "kind": "function", "name": "removeAllKeys", "since": "3.24.0", "params": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Call `Key.destroy` on each removed Key object?", "name": "destroy" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "Remove all key captures for Key objects owned by this plugin?", "name": "removeCapture" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This KeyboardPlugin object." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#removeAllKeys", "scope": "instance", "___id": "T000002R023505", "___s": true }, { "comment": "/**\r\n * Creates a new KeyCombo.\r\n *\r\n * A KeyCombo will listen for a specific string of keys from the Keyboard, and when it receives them\r\n * it will emit a `keycombomatch` event from this Keyboard Plugin.\r\n *\r\n * The keys to be listened for can be defined as:\r\n *\r\n * A string (i.e. 'ATARI')\r\n * An array of either integers (key codes) or strings, or a mixture of both\r\n * An array of objects (such as Key objects) with a public 'keyCode' property\r\n *\r\n * For example, to listen for the Konami code (up, up, down, down, left, right, left, right, b, a, enter)\r\n * you could pass the following array of key codes:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.createCombo([ 38, 38, 40, 40, 37, 39, 37, 39, 66, 65, 13 ], { resetOnMatch: true });\r\n *\r\n * this.input.keyboard.on('keycombomatch', function (event) {\r\n * console.log('Konami Code entered!');\r\n * });\r\n * ```\r\n *\r\n * Or, to listen for the user entering the word PHASER:\r\n *\r\n * ```javascript\r\n * this.input.keyboard.createCombo('PHASER');\r\n * ```\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#createCombo\r\n * @since 3.10.0\r\n *\r\n * @param {(string|number[]|object[])} keys - The keys that comprise this combo.\r\n * @param {Phaser.Types.Input.Keyboard.KeyComboConfig} [config] - A Key Combo configuration object.\r\n *\r\n * @return {Phaser.Input.Keyboard.KeyCombo} The new KeyCombo object.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 645, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "Creates a new KeyCombo.\r\rA KeyCombo will listen for a specific string of keys from the Keyboard, and when it receives them\rit will emit a `keycombomatch` event from this Keyboard Plugin.\r\rThe keys to be listened for can be defined as:\r\rA string (i.e. 'ATARI')\rAn array of either integers (key codes) or strings, or a mixture of both\rAn array of objects (such as Key objects) with a public 'keyCode' property\r\rFor example, to listen for the Konami code (up, up, down, down, left, right, left, right, b, a, enter)\ryou could pass the following array of key codes:\r\r```javascript\rthis.input.keyboard.createCombo([ 38, 38, 40, 40, 37, 39, 37, 39, 66, 65, 13 ], { resetOnMatch: true });\r\rthis.input.keyboard.on('keycombomatch', function (event) {\r console.log('Konami Code entered!');\r});\r```\r\rOr, to listen for the user entering the word PHASER:\r\r```javascript\rthis.input.keyboard.createCombo('PHASER');\r```", "kind": "function", "name": "createCombo", "since": "3.10.0", "params": [ { "type": { "names": [ "string", "Array.", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "number", "type": "NameExpression" } ] }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "object", "type": "NameExpression" } ] } ] } }, "description": "The keys that comprise this combo.", "name": "keys" }, { "type": { "names": [ "Phaser.Types.Input.Keyboard.KeyComboConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.Keyboard.KeyComboConfig" } }, "optional": true, "description": "A Key Combo configuration object.", "name": "config" } ], "returns": [ { "type": { "names": [ "Phaser.Input.Keyboard.KeyCombo" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.KeyCombo" } }, "description": "The new KeyCombo object." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#createCombo", "scope": "instance", "___id": "T000002R023513", "___s": true }, { "comment": "/**\r\n * Checks if the given Key object is currently being held down.\r\n *\r\n * The difference between this method and checking the `Key.isDown` property directly is that you can provide\r\n * a duration to this method. For example, if you wanted a key press to fire a bullet, but you only wanted\r\n * it to be able to fire every 100ms, then you can call this method with a `duration` of 100 and it\r\n * will only return `true` every 100ms.\r\n *\r\n * If the Keyboard Plugin has been disabled, this method will always return `false`.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#checkDown\r\n * @since 3.11.0\r\n *\r\n * @param {Phaser.Input.Keyboard.Key} key - A Key object.\r\n * @param {number} [duration=0] - The duration which must have elapsed before this Key is considered as being down.\r\n *\r\n * @return {boolean} `true` if the Key is down within the duration specified, otherwise `false`.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 687, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "Checks if the given Key object is currently being held down.\r\rThe difference between this method and checking the `Key.isDown` property directly is that you can provide\ra duration to this method. For example, if you wanted a key press to fire a bullet, but you only wanted\rit to be able to fire every 100ms, then you can call this method with a `duration` of 100 and it\rwill only return `true` every 100ms.\r\rIf 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "description": "A Key object.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023515", "___s": true }, { "comment": "/**\r\n * Resets all Key objects created by _this_ Keyboard Plugin back to their default un-pressed states.\r\n * This can only reset keys created via the `addKey`, `addKeys` or `createCursorKeys` methods.\r\n * If you have created a Key object directly you'll need to reset it yourself.\r\n *\r\n * This method is called automatically when the Keyboard Plugin shuts down, but can be\r\n * invoked directly at any time you require.\r\n *\r\n * @method Phaser.Input.Keyboard.KeyboardPlugin#resetKeys\r\n * @since 3.15.0\r\n *\r\n * @return {this} This KeyboardPlugin object.\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 840, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "Resets all Key objects created by _this_ Keyboard Plugin back to their default un-pressed states.\rThis can only reset keys created via the `addKey`, `addKeys` or `createCursorKeys` methods.\rIf you have created a Key object directly you'll need to reset it yourself.\r\rThis method is called automatically when the Keyboard Plugin shuts down, but can be\rinvoked directly at any time you require.", "kind": "function", "name": "resetKeys", "since": "3.15.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This KeyboardPlugin object." } ], "memberof": "Phaser.Input.Keyboard.KeyboardPlugin", "longname": "Phaser.Input.Keyboard.KeyboardPlugin#resetKeys", "scope": "instance", "___id": "T000002R023540", "___s": true }, { "comment": "/**\r\n * An instance of the Keyboard Plugin class, if enabled via the `input.keyboard` Scene or Game Config property.\r\n * Use this to create Key objects and listen for keyboard specific events.\r\n *\r\n * @name Phaser.Input.InputPlugin#keyboard\r\n * @type {?Phaser.Input.Keyboard.KeyboardPlugin}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "KeyboardPlugin.js", "lineno": 946, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard", "code": {} }, "description": "An instance of the Keyboard Plugin class, if enabled via the `input.keyboard` Scene or Game Config property.\rUse this to create Key objects and listen for keyboard specific events.", "name": "keyboard", "type": { "names": [ "Phaser.Input.Keyboard.KeyboardPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.KeyboardPlugin", "nullable": true } }, "nullable": true, "since": "3.10.0", "memberof": "Phaser.Input.InputPlugin", "longname": "Phaser.Input.InputPlugin#keyboard", "scope": "instance", "kind": "member", "___id": "T000002R023561", "___s": true }, { "comment": "/**\r\n * Returns `true` if the Key was pressed down within the `duration` value given, based on the current\r\n * game clock time. Or `false` if it either isn't down, or was pressed down longer ago than the given duration.\r\n *\r\n * @function Phaser.Input.Keyboard.DownDuration\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Keyboard.Key} key - The Key object to test.\r\n * @param {number} [duration=50] - The duration, in ms, within which the key must have been pressed down.\r\n *\r\n * @return {boolean} `true` if the Key was pressed down within `duration` ms ago, otherwise `false`.\r\n */", "meta": { "filename": "DownDuration.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "Returns `true` if the Key was pressed down within the `duration` value given, based on the current\rgame 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "description": "The Key object to test.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 50, "description": "The duration, in ms, within which the key must have been pressed down.", "name": "duration" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023563", "___s": true }, { "comment": "/**\r\n * The justDown value allows you to test if this Key has just been pressed down or not.\r\n *\r\n * When you check this value it will return `true` if the Key is down, otherwise `false`.\r\n *\r\n * You can only call justDown once per key press. It will only return `true` once, until the Key is released and pressed down again.\r\n * This 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.\r\n *\r\n * @function Phaser.Input.Keyboard.JustDown\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Keyboard.Key} key - The Key to check to see if it's just down or not.\r\n *\r\n * @return {boolean} `true` if the Key was just pressed, otherwise `false`.\r\n */", "meta": { "filename": "JustDown.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The justDown value allows you to test if this Key has just been pressed down or not.\r\rWhen you check this value it will return `true` if the Key is down, otherwise `false`.\r\rYou can only call justDown once per key press. It will only return `true` once, until the Key is released and pressed down again.\rThis 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "description": "The Key to check to see if it's just down or not.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Key was just pressed, otherwise `false`." } ], "memberof": "Phaser.Input.Keyboard", "longname": "Phaser.Input.Keyboard.JustDown", "scope": "static", "___id": "T000002R023568", "___s": true }, { "comment": "/**\r\n * The justUp value allows you to test if this Key has just been released or not.\r\n *\r\n * When you check this value it will return `true` if the Key is up, otherwise `false`.\r\n *\r\n * You can only call JustUp once per key release. It will only return `true` once, until the Key is pressed down and released again.\r\n * This 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.\r\n *\r\n * @function Phaser.Input.Keyboard.JustUp\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Keyboard.Key} key - The Key to check to see if it's just up or not.\r\n *\r\n * @return {boolean} `true` if the Key was just released, otherwise `false`.\r\n */", "meta": { "filename": "JustUp.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The justUp value allows you to test if this Key has just been released or not.\r\rWhen you check this value it will return `true` if the Key is up, otherwise `false`.\r\rYou can only call JustUp once per key release. It will only return `true` once, until the Key is pressed down and released again.\rThis 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "description": "The Key to check to see if it's just up or not.", "name": "key" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the Key was just released, otherwise `false`." } ], "memberof": "Phaser.Input.Keyboard", "longname": "Phaser.Input.Keyboard.JustUp", "scope": "static", "___id": "T000002R023572", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * Represents a single key on the keyboard. Key objects are created by the Keyboard Plugin\r\n * via `addKey()` and track the state of a specific key, including whether it is currently\r\n * held down, the duration it has been held, timestamps for press and release events, and\r\n * repeat counts. You can poll Key objects directly in your game loop using properties like\r\n * `isDown` and `isUp`, or listen for events via the `on` method. The keyCode must be an\r\n * integer corresponding to a `Phaser.Input.Keyboard.KeyCodes` value.\r\n *\r\n * @class Key\r\n * @extends Phaser.Events.EventEmitter\r\n * @memberof Phaser.Input.Keyboard\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Keyboard.KeyboardPlugin} plugin - The Keyboard Plugin instance that owns this Key object.\r\n * @param {number} keyCode - The keycode of this key.\r\n */", "meta": { "filename": "Key.js", "lineno": 11, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "classdesc": "Represents a single key on the keyboard. Key objects are created by the Keyboard Plugin\rvia `addKey()` and track the state of a specific key, including whether it is currently\rheld down, the duration it has been held, timestamps for press and release events, and\rrepeat counts. You can poll Key objects directly in your game loop using properties like\r`isDown` and `isUp`, or listen for events via the `on` method. The keyCode must be an\rinteger corresponding to a `Phaser.Input.Keyboard.KeyCodes` value.", "kind": "class", "name": "Key", "augments": [ "Phaser.Events.EventEmitter" ], "memberof": "Phaser.Input.Keyboard", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.Keyboard.KeyboardPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.KeyboardPlugin" } }, "description": "The Keyboard Plugin instance that owns this Key object.", "name": "plugin" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The keycode of this key.", "name": "keyCode" } ], "scope": "static", "longname": "Phaser.Input.Keyboard.Key", "___id": "T000002R023579", "___s": true }, { "comment": "/**\r\n * The Keyboard Plugin instance that owns this Key object.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#plugin\r\n * @type {Phaser.Input.Keyboard.KeyboardPlugin}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "Key.js", "lineno": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The Keyboard Plugin instance that owns this Key object.", "name": "plugin", "type": { "names": [ "Phaser.Input.Keyboard.KeyboardPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.KeyboardPlugin" } }, "since": "3.17.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#plugin", "scope": "instance", "kind": "member", "___id": "T000002R023583", "___s": true }, { "comment": "/**\r\n * The keycode of this key.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#keyCode\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Key.js", "lineno": 48, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The keycode of this key.", "name": "keyCode", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#keyCode", "scope": "instance", "kind": "member", "___id": "T000002R023585", "___s": true }, { "comment": "/**\r\n * The original DOM event.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#originalEvent\r\n * @type {KeyboardEvent}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Key.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The original DOM event.", "name": "originalEvent", "type": { "names": [ "KeyboardEvent" ], "parsedType": { "type": "NameExpression", "name": "KeyboardEvent" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#originalEvent", "scope": "instance", "kind": "member", "___id": "T000002R023587", "___s": true }, { "comment": "/**\r\n * Can this Key be processed?\r\n *\r\n * @name Phaser.Input.Keyboard.Key#enabled\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Key.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "Can this Key be processed?", "name": "enabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#enabled", "scope": "instance", "kind": "member", "___id": "T000002R023589", "___s": true }, { "comment": "/**\r\n * The \"down\" state of the key. This will remain `true` for as long as the keyboard thinks this key is held down.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#isDown\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Key.js", "lineno": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#isDown", "scope": "instance", "kind": "member", "___id": "T000002R023591", "___s": true }, { "comment": "/**\r\n * The \"up\" state of the key. This will remain `true` for as long as the keyboard thinks this key is up.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#isUp\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Key.js", "lineno": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#isUp", "scope": "instance", "kind": "member", "___id": "T000002R023593", "___s": true }, { "comment": "/**\r\n * The down state of the ALT key, if pressed at the same time as this key.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#altKey\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Key.js", "lineno": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The down state of the ALT key, if pressed at the same time as this key.", "name": "altKey", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#altKey", "scope": "instance", "kind": "member", "___id": "T000002R023595", "___s": true }, { "comment": "/**\r\n * The down state of the CTRL key, if pressed at the same time as this key.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#ctrlKey\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Key.js", "lineno": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The down state of the CTRL key, if pressed at the same time as this key.", "name": "ctrlKey", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#ctrlKey", "scope": "instance", "kind": "member", "___id": "T000002R023597", "___s": true }, { "comment": "/**\r\n * The down state of the SHIFT key, if pressed at the same time as this key.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#shiftKey\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Key.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The down state of the SHIFT key, if pressed at the same time as this key.", "name": "shiftKey", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#shiftKey", "scope": "instance", "kind": "member", "___id": "T000002R023599", "___s": true }, { "comment": "/**\r\n * The down state of the Meta key, if pressed at the same time as this key.\r\n * On a Mac the Meta Key is the Command key. On Windows keyboards, it's the Windows key.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#metaKey\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Key.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The down state of the Meta key, if pressed at the same time as this key.\rOn a Mac the Meta Key is the Command key. On Windows keyboards, it's the Windows key.", "name": "metaKey", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.16.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#metaKey", "scope": "instance", "kind": "member", "___id": "T000002R023601", "___s": true }, { "comment": "/**\r\n * The location of the modifier key. 0 for standard (or unknown), 1 for left, 2 for right, 3 for numpad.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#location\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Key.js", "lineno": 137, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#location", "scope": "instance", "kind": "member", "___id": "T000002R023603", "___s": true }, { "comment": "/**\r\n * The timestamp when the key was last pressed down.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#timeDown\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Key.js", "lineno": 147, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The timestamp when the key was last pressed down.", "name": "timeDown", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#timeDown", "scope": "instance", "kind": "member", "___id": "T000002R023605", "___s": true }, { "comment": "/**\r\n * The number of milliseconds this key was held down for in the previous down - up sequence.\r\n * This value isn't updated every game step, only when the Key changes state.\r\n * To get the current duration use the `getDuration` method.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#duration\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Key.js", "lineno": 157, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The number of milliseconds this key was held down for in the previous down - up sequence.\rThis value isn't updated every game step, only when the Key changes state.\rTo get the current duration use the `getDuration` method.", "name": "duration", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#duration", "scope": "instance", "kind": "member", "___id": "T000002R023607", "___s": true }, { "comment": "/**\r\n * The timestamp when the key was last released.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#timeUp\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Key.js", "lineno": 169, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The timestamp when the key was last released.", "name": "timeUp", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#timeUp", "scope": "instance", "kind": "member", "___id": "T000002R023609", "___s": true }, { "comment": "/**\r\n * When a key is held down should it continuously fire the `down` event each time it repeats?\r\n *\r\n * By default it will emit the `down` event just once, but if you wish to receive the event\r\n * for each repeat as well, enable this property.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#emitOnRepeat\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Key.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "When a key is held down should it continuously fire the `down` event each time it repeats?\r\rBy default it will emit the `down` event just once, but if you wish to receive the event\rfor each repeat as well, enable this property.", "name": "emitOnRepeat", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.16.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#emitOnRepeat", "scope": "instance", "kind": "member", "___id": "T000002R023611", "___s": true }, { "comment": "/**\r\n * If a key is held down this holds the number of times the key has 'repeated'.\r\n *\r\n * @name Phaser.Input.Keyboard.Key#repeats\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Key.js", "lineno": 192, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "If a key is held down this holds the number of times the key has 'repeated'.", "name": "repeats", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#repeats", "scope": "instance", "kind": "member", "___id": "T000002R023613", "___s": true }, { "comment": "/**\r\n * Controls if this Key will continuously emit a `down` event while being held down (true),\r\n * or emit the event just once, on first press, and then skip future events (false).\r\n *\r\n * @method Phaser.Input.Keyboard.Key#setEmitOnRepeat\r\n * @since 3.16.0\r\n *\r\n * @param {boolean} value - Emit `down` events on repeated key down actions, or just once?\r\n *\r\n * @return {this} This Key instance.\r\n */", "meta": { "filename": "Key.js", "lineno": 235, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "Controls if this Key will continuously emit a `down` event while being held down (true),\ror 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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Emit `down` events on repeated key down actions, or just once?", "name": "value" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Key instance." } ], "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#setEmitOnRepeat", "scope": "instance", "___id": "T000002R023621", "___s": true }, { "comment": "/**\r\n * Processes the Key Down action for this Key.\r\n * Called automatically by the Keyboard Plugin.\r\n *\r\n * @method Phaser.Input.Keyboard.Key#onDown\r\n * @fires Phaser.Input.Keyboard.Events#DOWN\r\n * @since 3.16.0\r\n *\r\n * @param {KeyboardEvent} event - The native DOM Keyboard event.\r\n */", "meta": { "filename": "Key.js", "lineno": 253, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "Processes the Key Down action for this Key.\rCalled automatically by the Keyboard Plugin.", "kind": "function", "name": "onDown", "fires": [ "Phaser.Input.Keyboard.Events#event:DOWN" ], "since": "3.16.0", "params": [ { "type": { "names": [ "KeyboardEvent" ], "parsedType": { "type": "NameExpression", "name": "KeyboardEvent" } }, "description": "The native DOM Keyboard event.", "name": "event" } ], "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#onDown", "scope": "instance", "___id": "T000002R023624", "___s": true }, { "comment": "/**\r\n * Processes the Key Up action for this Key.\r\n * Called automatically by the Keyboard Plugin.\r\n *\r\n * @method Phaser.Input.Keyboard.Key#onUp\r\n * @fires Phaser.Input.Keyboard.Events#UP\r\n * @since 3.16.0\r\n *\r\n * @param {KeyboardEvent} event - The native DOM Keyboard event.\r\n */", "meta": { "filename": "Key.js", "lineno": 297, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "Processes the Key Up action for this Key.\rCalled automatically by the Keyboard Plugin.", "kind": "function", "name": "onUp", "fires": [ "Phaser.Input.Keyboard.Events#event:UP" ], "since": "3.16.0", "params": [ { "type": { "names": [ "KeyboardEvent" ], "parsedType": { "type": "NameExpression", "name": "KeyboardEvent" } }, "description": "The native DOM Keyboard event.", "name": "event" } ], "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#onUp", "scope": "instance", "___id": "T000002R023638", "___s": true }, { "comment": "/**\r\n * Resets this Key object back to its default un-pressed state.\r\n *\r\n * As of version 3.60.0 it no longer resets the `enabled` or `preventDefault` flags.\r\n *\r\n * @method Phaser.Input.Keyboard.Key#reset\r\n * @since 3.6.0\r\n *\r\n * @return {this} This Key instance.\r\n */", "meta": { "filename": "Key.js", "lineno": 329, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "Resets this Key object back to its default un-pressed state.\r\rAs of version 3.60.0 it no longer resets the `enabled` or `preventDefault` flags.", "kind": "function", "name": "reset", "since": "3.6.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Key instance." } ], "memberof": "Phaser.Input.Keyboard.Key", "longname": "Phaser.Input.Keyboard.Key#reset", "scope": "instance", "___id": "T000002R023649", "___s": true }, { "comment": "/**\r\n * Returns the duration, in ms, that the Key has been held down for.\r\n *\r\n * If the key is not currently down it will return zero.\r\n *\r\n * To get the duration the Key was held down for in the previous up-down cycle,\r\n * use the `Key.duration` property value instead.\r\n *\r\n * @method Phaser.Input.Keyboard.Key#getDuration\r\n * @since 3.17.0\r\n *\r\n * @return {number} The duration, in ms, that the Key has been held down for if currently down.\r\n */", "meta": { "filename": "Key.js", "lineno": 358, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "Returns the duration, in ms, that the Key has been held down for.\r\rIf the key is not currently down it will return zero.\r\rTo get the duration the Key was held down for in the previous up-down cycle,\ruse the `Key.duration` property value instead.", "kind": "function", "name": "getDuration", "since": "3.17.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023664", "___s": true }, { "comment": "/**\r\n * Removes any bound event handlers and removes local references.\r\n *\r\n * @method Phaser.Input.Keyboard.Key#destroy\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Key.js", "lineno": 383, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "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", "___id": "T000002R023666", "___s": true }, { "comment": "/**\r\n * A mapping of keyboard key names to their corresponding browser key codes, as reported by\r\n * `KeyboardEvent.keyCode`. Use these constants with `Phaser.Input.Keyboard.KeyboardPlugin`\r\n * methods such as `addKey` and `addKeys`, or when checking the state of `Phaser.Input.Keyboard.Key`\r\n * objects, to avoid hard-coding numeric values in your game code.\r\n *\r\n * Some entries include browser-specific variants (e.g. `SEMICOLON_FIREFOX`) to handle historical\r\n * differences in key code reporting across browsers.\r\n *\r\n * @namespace Phaser.Input.Keyboard.KeyCodes\r\n * @memberof Phaser.Input.Keyboard\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "A mapping of keyboard key names to their corresponding browser key codes, as reported by\r`KeyboardEvent.keyCode`. Use these constants with `Phaser.Input.Keyboard.KeyboardPlugin`\rmethods such as `addKey` and `addKeys`, or when checking the state of `Phaser.Input.Keyboard.Key`\robjects, to avoid hard-coding numeric values in your game code.\r\rSome entries include browser-specific variants (e.g. `SEMICOLON_FIREFOX`) to handle historical\rdifferences in key code reporting across browsers.", "kind": "namespace", "name": "KeyCodes", "memberof": "Phaser.Input.Keyboard", "since": "3.0.0", "longname": "Phaser.Input.Keyboard.KeyCodes", "scope": "static", "___id": "T000002R023671", "___s": true }, { "comment": "/**\r\n * The BACKSPACE key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.BACKSPACE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 23, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The BACKSPACE key.", "name": "BACKSPACE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.BACKSPACE", "scope": "static", "kind": "member", "___id": "T000002R023673", "___s": true }, { "comment": "/**\r\n * The TAB key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.TAB\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 32, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The TAB key.", "name": "TAB", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.TAB", "scope": "static", "kind": "member", "___id": "T000002R023675", "___s": true }, { "comment": "/**\r\n * The ENTER key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.ENTER\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 41, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The ENTER key.", "name": "ENTER", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.ENTER", "scope": "static", "kind": "member", "___id": "T000002R023677", "___s": true }, { "comment": "/**\r\n * The SHIFT key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.SHIFT\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 50, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The SHIFT key.", "name": "SHIFT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.SHIFT", "scope": "static", "kind": "member", "___id": "T000002R023679", "___s": true }, { "comment": "/**\r\n * The CTRL key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.CTRL\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 59, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The CTRL key.", "name": "CTRL", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.CTRL", "scope": "static", "kind": "member", "___id": "T000002R023681", "___s": true }, { "comment": "/**\r\n * The ALT key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.ALT\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 68, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The ALT key.", "name": "ALT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.ALT", "scope": "static", "kind": "member", "___id": "T000002R023683", "___s": true }, { "comment": "/**\r\n * The PAUSE key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.PAUSE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 77, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The PAUSE key.", "name": "PAUSE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.PAUSE", "scope": "static", "kind": "member", "___id": "T000002R023685", "___s": true }, { "comment": "/**\r\n * The CAPS_LOCK key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.CAPS_LOCK\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 86, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The CAPS_LOCK key.", "name": "CAPS_LOCK", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.CAPS_LOCK", "scope": "static", "kind": "member", "___id": "T000002R023687", "___s": true }, { "comment": "/**\r\n * The ESC key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.ESC\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 95, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The ESC key.", "name": "ESC", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.ESC", "scope": "static", "kind": "member", "___id": "T000002R023689", "___s": true }, { "comment": "/**\r\n * The SPACE key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.SPACE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 104, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The SPACE key.", "name": "SPACE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.SPACE", "scope": "static", "kind": "member", "___id": "T000002R023691", "___s": true }, { "comment": "/**\r\n * The PAGE_UP key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.PAGE_UP\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 113, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The PAGE_UP key.", "name": "PAGE_UP", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.PAGE_UP", "scope": "static", "kind": "member", "___id": "T000002R023693", "___s": true }, { "comment": "/**\r\n * The PAGE_DOWN key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.PAGE_DOWN\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 122, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The PAGE_DOWN key.", "name": "PAGE_DOWN", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.PAGE_DOWN", "scope": "static", "kind": "member", "___id": "T000002R023695", "___s": true }, { "comment": "/**\r\n * The END key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.END\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 131, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The END key.", "name": "END", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.END", "scope": "static", "kind": "member", "___id": "T000002R023697", "___s": true }, { "comment": "/**\r\n * The HOME key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.HOME\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 140, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The HOME key.", "name": "HOME", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.HOME", "scope": "static", "kind": "member", "___id": "T000002R023699", "___s": true }, { "comment": "/**\r\n * The LEFT key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.LEFT\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 149, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The LEFT key.", "name": "LEFT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.LEFT", "scope": "static", "kind": "member", "___id": "T000002R023701", "___s": true }, { "comment": "/**\r\n * The UP key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.UP\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 158, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The UP key.", "name": "UP", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.UP", "scope": "static", "kind": "member", "___id": "T000002R023703", "___s": true }, { "comment": "/**\r\n * The RIGHT key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.RIGHT\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 167, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The RIGHT key.", "name": "RIGHT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.RIGHT", "scope": "static", "kind": "member", "___id": "T000002R023705", "___s": true }, { "comment": "/**\r\n * The DOWN key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.DOWN\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 176, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The DOWN key.", "name": "DOWN", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.DOWN", "scope": "static", "kind": "member", "___id": "T000002R023707", "___s": true }, { "comment": "/**\r\n * The PRINT_SCREEN key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.PRINT_SCREEN\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 185, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The PRINT_SCREEN key.", "name": "PRINT_SCREEN", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.PRINT_SCREEN", "scope": "static", "kind": "member", "___id": "T000002R023709", "___s": true }, { "comment": "/**\r\n * The INSERT key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.INSERT\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 194, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The INSERT key.", "name": "INSERT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.INSERT", "scope": "static", "kind": "member", "___id": "T000002R023711", "___s": true }, { "comment": "/**\r\n * The DELETE key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.DELETE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 203, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The DELETE key.", "name": "DELETE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.DELETE", "scope": "static", "kind": "member", "___id": "T000002R023713", "___s": true }, { "comment": "/**\r\n * The ZERO key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.ZERO\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 212, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The ZERO key.", "name": "ZERO", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.ZERO", "scope": "static", "kind": "member", "___id": "T000002R023715", "___s": true }, { "comment": "/**\r\n * The ONE key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.ONE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 221, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The ONE key.", "name": "ONE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.ONE", "scope": "static", "kind": "member", "___id": "T000002R023717", "___s": true }, { "comment": "/**\r\n * The TWO key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.TWO\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 230, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The TWO key.", "name": "TWO", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.TWO", "scope": "static", "kind": "member", "___id": "T000002R023719", "___s": true }, { "comment": "/**\r\n * The THREE key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.THREE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 239, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The THREE key.", "name": "THREE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.THREE", "scope": "static", "kind": "member", "___id": "T000002R023721", "___s": true }, { "comment": "/**\r\n * The FOUR key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.FOUR\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 248, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The FOUR key.", "name": "FOUR", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.FOUR", "scope": "static", "kind": "member", "___id": "T000002R023723", "___s": true }, { "comment": "/**\r\n * The FIVE key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.FIVE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 257, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The FIVE key.", "name": "FIVE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.FIVE", "scope": "static", "kind": "member", "___id": "T000002R023725", "___s": true }, { "comment": "/**\r\n * The SIX key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.SIX\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 266, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The SIX key.", "name": "SIX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.SIX", "scope": "static", "kind": "member", "___id": "T000002R023727", "___s": true }, { "comment": "/**\r\n * The SEVEN key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.SEVEN\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 275, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The SEVEN key.", "name": "SEVEN", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.SEVEN", "scope": "static", "kind": "member", "___id": "T000002R023729", "___s": true }, { "comment": "/**\r\n * The EIGHT key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.EIGHT\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The EIGHT key.", "name": "EIGHT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.EIGHT", "scope": "static", "kind": "member", "___id": "T000002R023731", "___s": true }, { "comment": "/**\r\n * The NINE key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.NINE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 293, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The NINE key.", "name": "NINE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.NINE", "scope": "static", "kind": "member", "___id": "T000002R023733", "___s": true }, { "comment": "/**\r\n * The numeric keypad 0 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_ZERO\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 302, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The numeric keypad 0 key.", "name": "NUMPAD_ZERO", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.NUMPAD_ZERO", "scope": "static", "kind": "member", "___id": "T000002R023735", "___s": true }, { "comment": "/**\r\n * The numeric keypad 1 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_ONE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 311, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The numeric keypad 1 key.", "name": "NUMPAD_ONE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.NUMPAD_ONE", "scope": "static", "kind": "member", "___id": "T000002R023737", "___s": true }, { "comment": "/**\r\n * The numeric keypad 2 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_TWO\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 320, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The numeric keypad 2 key.", "name": "NUMPAD_TWO", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.NUMPAD_TWO", "scope": "static", "kind": "member", "___id": "T000002R023739", "___s": true }, { "comment": "/**\r\n * The numeric keypad 3 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_THREE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 329, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The numeric keypad 3 key.", "name": "NUMPAD_THREE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.NUMPAD_THREE", "scope": "static", "kind": "member", "___id": "T000002R023741", "___s": true }, { "comment": "/**\r\n * The numeric keypad 4 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_FOUR\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 338, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The numeric keypad 4 key.", "name": "NUMPAD_FOUR", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.NUMPAD_FOUR", "scope": "static", "kind": "member", "___id": "T000002R023743", "___s": true }, { "comment": "/**\r\n * The numeric keypad 5 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_FIVE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 347, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The numeric keypad 5 key.", "name": "NUMPAD_FIVE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.NUMPAD_FIVE", "scope": "static", "kind": "member", "___id": "T000002R023745", "___s": true }, { "comment": "/**\r\n * The numeric keypad 6 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_SIX\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 356, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The numeric keypad 6 key.", "name": "NUMPAD_SIX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.NUMPAD_SIX", "scope": "static", "kind": "member", "___id": "T000002R023747", "___s": true }, { "comment": "/**\r\n * The numeric keypad 7 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_SEVEN\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 365, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The numeric keypad 7 key.", "name": "NUMPAD_SEVEN", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.NUMPAD_SEVEN", "scope": "static", "kind": "member", "___id": "T000002R023749", "___s": true }, { "comment": "/**\r\n * The numeric keypad 8 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_EIGHT\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 374, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The numeric keypad 8 key.", "name": "NUMPAD_EIGHT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.NUMPAD_EIGHT", "scope": "static", "kind": "member", "___id": "T000002R023751", "___s": true }, { "comment": "/**\r\n * The numeric keypad 9 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_NINE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 383, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The numeric keypad 9 key.", "name": "NUMPAD_NINE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.NUMPAD_NINE", "scope": "static", "kind": "member", "___id": "T000002R023753", "___s": true }, { "comment": "/**\r\n * The Numpad Addition (+) key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_ADD\r\n * @type {number}\r\n * @since 3.21.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 392, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The Numpad Addition (+) key.", "name": "NUMPAD_ADD", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.21.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.NUMPAD_ADD", "scope": "static", "kind": "member", "___id": "T000002R023755", "___s": true }, { "comment": "/**\r\n * The Numpad Subtraction (-) key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_SUBTRACT\r\n * @type {number}\r\n * @since 3.21.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 401, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The Numpad Subtraction (-) key.", "name": "NUMPAD_SUBTRACT", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.21.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.NUMPAD_SUBTRACT", "scope": "static", "kind": "member", "___id": "T000002R023757", "___s": true }, { "comment": "/**\r\n * The A key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.A\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 410, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The A key.", "name": "A", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.A", "scope": "static", "kind": "member", "___id": "T000002R023759", "___s": true }, { "comment": "/**\r\n * The B key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.B\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 419, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The B key.", "name": "B", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.B", "scope": "static", "kind": "member", "___id": "T000002R023761", "___s": true }, { "comment": "/**\r\n * The C key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.C\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 428, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The C key.", "name": "C", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.C", "scope": "static", "kind": "member", "___id": "T000002R023763", "___s": true }, { "comment": "/**\r\n * The D key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.D\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 437, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The D key.", "name": "D", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.D", "scope": "static", "kind": "member", "___id": "T000002R023765", "___s": true }, { "comment": "/**\r\n * The E key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.E\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 446, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The E key.", "name": "E", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.E", "scope": "static", "kind": "member", "___id": "T000002R023767", "___s": true }, { "comment": "/**\r\n * The F key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.F\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 455, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The F key.", "name": "F", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.F", "scope": "static", "kind": "member", "___id": "T000002R023769", "___s": true }, { "comment": "/**\r\n * The G key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.G\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 464, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The G key.", "name": "G", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.G", "scope": "static", "kind": "member", "___id": "T000002R023771", "___s": true }, { "comment": "/**\r\n * The H key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.H\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 473, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The H key.", "name": "H", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.H", "scope": "static", "kind": "member", "___id": "T000002R023773", "___s": true }, { "comment": "/**\r\n * The I key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.I\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 482, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The I key.", "name": "I", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.I", "scope": "static", "kind": "member", "___id": "T000002R023775", "___s": true }, { "comment": "/**\r\n * The J key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.J\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 491, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The J key.", "name": "J", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.J", "scope": "static", "kind": "member", "___id": "T000002R023777", "___s": true }, { "comment": "/**\r\n * The K key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.K\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 500, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The K key.", "name": "K", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.K", "scope": "static", "kind": "member", "___id": "T000002R023779", "___s": true }, { "comment": "/**\r\n * The L key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.L\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 509, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The L key.", "name": "L", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.L", "scope": "static", "kind": "member", "___id": "T000002R023781", "___s": true }, { "comment": "/**\r\n * The M key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.M\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 518, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The M key.", "name": "M", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.M", "scope": "static", "kind": "member", "___id": "T000002R023783", "___s": true }, { "comment": "/**\r\n * The N key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.N\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 527, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The N key.", "name": "N", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.N", "scope": "static", "kind": "member", "___id": "T000002R023785", "___s": true }, { "comment": "/**\r\n * The O key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.O\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 536, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The O key.", "name": "O", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.O", "scope": "static", "kind": "member", "___id": "T000002R023787", "___s": true }, { "comment": "/**\r\n * The P key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.P\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 545, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The P key.", "name": "P", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.P", "scope": "static", "kind": "member", "___id": "T000002R023789", "___s": true }, { "comment": "/**\r\n * The Q key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.Q\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 554, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The Q key.", "name": "Q", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.Q", "scope": "static", "kind": "member", "___id": "T000002R023791", "___s": true }, { "comment": "/**\r\n * The R key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.R\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 563, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The R key.", "name": "R", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.R", "scope": "static", "kind": "member", "___id": "T000002R023793", "___s": true }, { "comment": "/**\r\n * The S key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.S\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 572, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The S key.", "name": "S", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.S", "scope": "static", "kind": "member", "___id": "T000002R023795", "___s": true }, { "comment": "/**\r\n * The T key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.T\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 581, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The T key.", "name": "T", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.T", "scope": "static", "kind": "member", "___id": "T000002R023797", "___s": true }, { "comment": "/**\r\n * The U key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.U\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 590, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The U key.", "name": "U", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.U", "scope": "static", "kind": "member", "___id": "T000002R023799", "___s": true }, { "comment": "/**\r\n * The V key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.V\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 599, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The V key.", "name": "V", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.V", "scope": "static", "kind": "member", "___id": "T000002R023801", "___s": true }, { "comment": "/**\r\n * The W key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.W\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 608, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The W key.", "name": "W", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.W", "scope": "static", "kind": "member", "___id": "T000002R023803", "___s": true }, { "comment": "/**\r\n * The X key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.X\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 617, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The X key.", "name": "X", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.X", "scope": "static", "kind": "member", "___id": "T000002R023805", "___s": true }, { "comment": "/**\r\n * The Y key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.Y\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 626, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The Y key.", "name": "Y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.Y", "scope": "static", "kind": "member", "___id": "T000002R023807", "___s": true }, { "comment": "/**\r\n * The Z key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.Z\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 635, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The Z key.", "name": "Z", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.Z", "scope": "static", "kind": "member", "___id": "T000002R023809", "___s": true }, { "comment": "/**\r\n * The F1 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.F1\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 644, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The F1 key.", "name": "F1", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.F1", "scope": "static", "kind": "member", "___id": "T000002R023811", "___s": true }, { "comment": "/**\r\n * The F2 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.F2\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 653, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The F2 key.", "name": "F2", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.F2", "scope": "static", "kind": "member", "___id": "T000002R023813", "___s": true }, { "comment": "/**\r\n * The F3 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.F3\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 662, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The F3 key.", "name": "F3", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.F3", "scope": "static", "kind": "member", "___id": "T000002R023815", "___s": true }, { "comment": "/**\r\n * The F4 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.F4\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 671, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The F4 key.", "name": "F4", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.F4", "scope": "static", "kind": "member", "___id": "T000002R023817", "___s": true }, { "comment": "/**\r\n * The F5 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.F5\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 680, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The F5 key.", "name": "F5", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.F5", "scope": "static", "kind": "member", "___id": "T000002R023819", "___s": true }, { "comment": "/**\r\n * The F6 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.F6\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 689, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The F6 key.", "name": "F6", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.F6", "scope": "static", "kind": "member", "___id": "T000002R023821", "___s": true }, { "comment": "/**\r\n * The F7 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.F7\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 698, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The F7 key.", "name": "F7", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.F7", "scope": "static", "kind": "member", "___id": "T000002R023823", "___s": true }, { "comment": "/**\r\n * The F8 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.F8\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 707, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The F8 key.", "name": "F8", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.F8", "scope": "static", "kind": "member", "___id": "T000002R023825", "___s": true }, { "comment": "/**\r\n * The F9 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.F9\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 716, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The F9 key.", "name": "F9", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.F9", "scope": "static", "kind": "member", "___id": "T000002R023827", "___s": true }, { "comment": "/**\r\n * The F10 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.F10\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 725, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The F10 key.", "name": "F10", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.F10", "scope": "static", "kind": "member", "___id": "T000002R023829", "___s": true }, { "comment": "/**\r\n * The F11 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.F11\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 734, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The F11 key.", "name": "F11", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.F11", "scope": "static", "kind": "member", "___id": "T000002R023831", "___s": true }, { "comment": "/**\r\n * The F12 key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.F12\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 743, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The F12 key.", "name": "F12", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.F12", "scope": "static", "kind": "member", "___id": "T000002R023833", "___s": true }, { "comment": "/**\r\n * The SEMICOLON key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.SEMICOLON\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 752, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The SEMICOLON key.", "name": "SEMICOLON", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.SEMICOLON", "scope": "static", "kind": "member", "___id": "T000002R023835", "___s": true }, { "comment": "/**\r\n * The PLUS key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.PLUS\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 761, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The PLUS key.", "name": "PLUS", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.PLUS", "scope": "static", "kind": "member", "___id": "T000002R023837", "___s": true }, { "comment": "/**\r\n * The COMMA key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.COMMA\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 770, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The COMMA key.", "name": "COMMA", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.COMMA", "scope": "static", "kind": "member", "___id": "T000002R023839", "___s": true }, { "comment": "/**\r\n * The MINUS key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.MINUS\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 779, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The MINUS key.", "name": "MINUS", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.MINUS", "scope": "static", "kind": "member", "___id": "T000002R023841", "___s": true }, { "comment": "/**\r\n * The PERIOD key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.PERIOD\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 788, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The PERIOD key.", "name": "PERIOD", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.PERIOD", "scope": "static", "kind": "member", "___id": "T000002R023843", "___s": true }, { "comment": "/**\r\n * The FORWARD_SLASH key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.FORWARD_SLASH\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 797, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The FORWARD_SLASH key.", "name": "FORWARD_SLASH", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.FORWARD_SLASH", "scope": "static", "kind": "member", "___id": "T000002R023845", "___s": true }, { "comment": "/**\r\n * The BACK_SLASH key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.BACK_SLASH\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 806, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The BACK_SLASH key.", "name": "BACK_SLASH", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.BACK_SLASH", "scope": "static", "kind": "member", "___id": "T000002R023847", "___s": true }, { "comment": "/**\r\n * The QUOTES key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.QUOTES\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 815, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The QUOTES key.", "name": "QUOTES", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.QUOTES", "scope": "static", "kind": "member", "___id": "T000002R023849", "___s": true }, { "comment": "/**\r\n * The BACKTICK key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.BACKTICK\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 824, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The BACKTICK key.", "name": "BACKTICK", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.BACKTICK", "scope": "static", "kind": "member", "___id": "T000002R023851", "___s": true }, { "comment": "/**\r\n * The OPEN_BRACKET key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.OPEN_BRACKET\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 833, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The OPEN_BRACKET key.", "name": "OPEN_BRACKET", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.OPEN_BRACKET", "scope": "static", "kind": "member", "___id": "T000002R023853", "___s": true }, { "comment": "/**\r\n * The CLOSED_BRACKET key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.CLOSED_BRACKET\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 842, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The CLOSED_BRACKET key.", "name": "CLOSED_BRACKET", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.CLOSED_BRACKET", "scope": "static", "kind": "member", "___id": "T000002R023855", "___s": true }, { "comment": "/**\r\n * The Firefox-specific alternate key code for the SEMICOLON (;) key. Firefox historically\r\n * reported key code 59 for this key, whereas other browsers use 186 (see `SEMICOLON`).\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.SEMICOLON_FIREFOX\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 851, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The Firefox-specific alternate key code for the SEMICOLON (;) key. Firefox historically\rreported key code 59 for this key, whereas other browsers use 186 (see `SEMICOLON`).", "name": "SEMICOLON_FIREFOX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.SEMICOLON_FIREFOX", "scope": "static", "kind": "member", "___id": "T000002R023857", "___s": true }, { "comment": "/**\r\n * The COLON (:) key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.COLON\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 861, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The COLON (:) key.", "name": "COLON", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.COLON", "scope": "static", "kind": "member", "___id": "T000002R023859", "___s": true }, { "comment": "/**\r\n * The Firefox on Windows-specific alternate key code for the less-than sign (<) key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.COMMA_FIREFOX_WINDOWS\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 870, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The Firefox on Windows-specific alternate key code for the less-than sign (<) key.", "name": "COMMA_FIREFOX_WINDOWS", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.COMMA_FIREFOX_WINDOWS", "scope": "static", "kind": "member", "___id": "T000002R023861", "___s": true }, { "comment": "/**\r\n * The Firefox-specific alternate key code for the greater-than sign (>) key.\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.COMMA_FIREFOX\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 879, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The Firefox-specific alternate key code for the greater-than sign (>) key.", "name": "COMMA_FIREFOX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.COMMA_FIREFOX", "scope": "static", "kind": "member", "___id": "T000002R023863", "___s": true }, { "comment": "/**\r\n * The Firefox-specific alternate key code for the right bracket (]) key. Firefox historically\r\n * reported key code 174 for this key, whereas other browsers use 221 (see `CLOSED_BRACKET`).\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.BRACKET_RIGHT_FIREFOX\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 888, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The Firefox-specific alternate key code for the right bracket (]) key. Firefox historically\rreported key code 174 for this key, whereas other browsers use 221 (see `CLOSED_BRACKET`).", "name": "BRACKET_RIGHT_FIREFOX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.BRACKET_RIGHT_FIREFOX", "scope": "static", "kind": "member", "___id": "T000002R023865", "___s": true }, { "comment": "/**\r\n * The Firefox-specific alternate key code for the left bracket ([) key. Firefox historically\r\n * reported key code 175 for this key, whereas other browsers use 219 (see `OPEN_BRACKET`).\r\n *\r\n * @name Phaser.Input.Keyboard.KeyCodes.BRACKET_LEFT_FIREFOX\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "KeyCodes.js", "lineno": 898, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "The Firefox-specific alternate key code for the left bracket ([) key. Firefox historically\rreported key code 175 for this key, whereas other browsers use 219 (see `OPEN_BRACKET`).", "name": "BRACKET_LEFT_FIREFOX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Keyboard.KeyCodes", "longname": "Phaser.Input.Keyboard.KeyCodes.BRACKET_LEFT_FIREFOX", "scope": "static", "kind": "member", "___id": "T000002R023867", "___s": true }, { "comment": "/**\r\n * Returns `true` if the Key was released within the `duration` value given, based on the current\r\n * game clock time. Or returns `false` if it either isn't up, or was released longer ago than the given duration.\r\n *\r\n * @function Phaser.Input.Keyboard.UpDuration\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.Keyboard.Key} key - The Key object to test.\r\n * @param {number} [duration=50] - The duration, in ms, within which the key must have been released.\r\n *\r\n * @return {boolean} `true` if the Key was released within `duration` ms ago, otherwise `false`.\r\n */", "meta": { "filename": "UpDuration.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\keys", "code": {} }, "description": "Returns `true` if the Key was released within the `duration` value given, based on the current\rgame 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "description": "The Key object to test.", "name": "key" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 50, "description": "The duration, in ms, within which the key must have been released.", "name": "duration" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023875", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Input.Keyboard.CursorKeys\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.Input.Keyboard.Key} up - A Key object mapping to the UP arrow key.\r\n * @property {Phaser.Input.Keyboard.Key} down - A Key object mapping to the DOWN arrow key.\r\n * @property {Phaser.Input.Keyboard.Key} left - A Key object mapping to the LEFT arrow key.\r\n * @property {Phaser.Input.Keyboard.Key} right - A Key object mapping to the RIGHT arrow key.\r\n * @property {Phaser.Input.Keyboard.Key} space - A Key object mapping to the SPACE BAR key.\r\n * @property {Phaser.Input.Keyboard.Key} shift - A Key object mapping to the SHIFT key.\r\n */", "meta": { "filename": "CursorKeys.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\typedefs", "code": {} }, "kind": "typedef", "name": "CursorKeys", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "description": "A Key object mapping to the UP arrow key.", "name": "up" }, { "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "description": "A Key object mapping to the DOWN arrow key.", "name": "down" }, { "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "description": "A Key object mapping to the LEFT arrow key.", "name": "left" }, { "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "description": "A Key object mapping to the RIGHT arrow key.", "name": "right" }, { "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "description": "A Key object mapping to the SPACE BAR key.", "name": "space" }, { "type": { "names": [ "Phaser.Input.Keyboard.Key" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.Keyboard.Key" } }, "description": "A Key object mapping to the SHIFT key.", "name": "shift" } ], "memberof": "Phaser.Types.Input.Keyboard", "longname": "Phaser.Types.Input.Keyboard.CursorKeys", "scope": "static", "___id": "T000002R023880", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Input.Keyboard\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\typedefs", "code": {} }, "kind": "namespace", "name": "Keyboard", "memberof": "Phaser.Types.Input", "longname": "Phaser.Types.Input.Keyboard", "scope": "static", "___id": "T000002R023881", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Input.Keyboard.KeyboardKeydownCallback\r\n * @since 3.0.0\r\n *\r\n * @param {KeyboardEvent} event - The Keyboard Event.\r\n */", "meta": { "filename": "KeyboardKeydownCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\typedefs", "code": {} }, "kind": "typedef", "name": "KeyboardKeydownCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "KeyboardEvent" ], "parsedType": { "type": "NameExpression", "name": "KeyboardEvent" } }, "description": "The Keyboard Event.", "name": "event" } ], "memberof": "Phaser.Types.Input.Keyboard", "longname": "Phaser.Types.Input.Keyboard.KeyboardKeydownCallback", "scope": "static", "___id": "T000002R023882", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Input.Keyboard.KeyComboConfig\r\n * @since 3.0.0\r\n *\r\n * @property {boolean} [resetOnWrongKey=true] - If they press the wrong key do we reset the combo?\r\n * @property {number} [maxKeyDelay=0] - The max delay in ms between each key press. Above this the combo is reset. 0 means disabled.\r\n * @property {boolean} [resetOnMatch=false] - If previously matched and they press the first key of the combo again, will it reset?\r\n * @property {boolean} [deleteOnMatch=false] - If the combo matches, will it delete itself?\r\n */", "meta": { "filename": "KeyComboConfig.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\keyboard\\typedefs", "code": {} }, "kind": "typedef", "name": "KeyComboConfig", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": true, "description": "If they press the wrong key do we reset the combo?", "name": "resetOnWrongKey" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R023883", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Input.Mouse\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "kind": "namespace", "name": "Mouse", "memberof": "Phaser.Input", "longname": "Phaser.Input.Mouse", "scope": "static", "___id": "T000002R023884", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Mouse Manager is a helper class that belongs to the Input Manager.\r\n *\r\n * Its role is to listen for native DOM Mouse Events and then pass them onto the Input Manager for further processing.\r\n *\r\n * You do not need to create this class directly, the Input Manager will create an instance of it automatically.\r\n *\r\n * @class MouseManager\r\n * @memberof Phaser.Input.Mouse\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.InputManager} inputManager - A reference to the Input Manager.\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "classdesc": "The Mouse Manager is a helper class that belongs to the Input Manager.\r\rIts role is to listen for native DOM Mouse Events and then pass them onto the Input Manager for further processing.\r\rYou 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputManager" } }, "description": "A reference to the Input Manager.", "name": "inputManager" } ], "scope": "static", "longname": "Phaser.Input.Mouse.MouseManager", "___id": "T000002R023891", "___s": true }, { "comment": "/**\r\n * A reference to the Input Manager.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#manager\r\n * @type {Phaser.Input.InputManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 36, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "A reference to the Input Manager.", "name": "manager", "type": { "names": [ "Phaser.Input.InputManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputManager" } }, "since": "3.0.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#manager", "scope": "instance", "kind": "member", "___id": "T000002R023894", "___s": true }, { "comment": "/**\r\n * If `true` the DOM `mousedown` event will have `preventDefault` set.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#preventDefaultDown\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.50.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "If `true` the DOM `mousedown` event will have `preventDefault` set.", "name": "preventDefaultDown", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.50.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#preventDefaultDown", "scope": "instance", "kind": "member", "___id": "T000002R023896", "___s": true }, { "comment": "/**\r\n * If `true` the DOM `mouseup` event will have `preventDefault` set.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#preventDefaultUp\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.50.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 55, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "If `true` the DOM `mouseup` event will have `preventDefault` set.", "name": "preventDefaultUp", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.50.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#preventDefaultUp", "scope": "instance", "kind": "member", "___id": "T000002R023898", "___s": true }, { "comment": "/**\r\n * If `true` the DOM `mousemove` event will have `preventDefault` set.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#preventDefaultMove\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.50.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 65, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "If `true` the DOM `mousemove` event will have `preventDefault` set.", "name": "preventDefaultMove", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.50.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#preventDefaultMove", "scope": "instance", "kind": "member", "___id": "T000002R023900", "___s": true }, { "comment": "/**\r\n * If `true` the DOM `wheel` event will have `preventDefault` set.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#preventDefaultWheel\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.50.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 75, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "If `true` the DOM `wheel` event will have `preventDefault` set.", "name": "preventDefaultWheel", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.50.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#preventDefaultWheel", "scope": "instance", "kind": "member", "___id": "T000002R023902", "___s": true }, { "comment": "/**\r\n * A boolean that controls if the Mouse Manager is enabled or not.\r\n * Can be toggled on the fly.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#enabled\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 85, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "A boolean that controls if the Mouse Manager is enabled or not.\rCan be toggled on the fly.", "name": "enabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#enabled", "scope": "instance", "kind": "member", "___id": "T000002R023904", "___s": true }, { "comment": "/**\r\n * The Mouse target, as defined in the Game Config.\r\n * Typically the canvas to which the game is rendering, but can be any interactive DOM element.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#target\r\n * @type {any}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "The Mouse target, as defined in the Game Config.\rTypically the canvas to which the game is rendering, but can be any interactive DOM element.", "name": "target", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.0.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#target", "scope": "instance", "kind": "member", "___id": "T000002R023906", "___s": true }, { "comment": "/**\r\n * If the mouse has been pointer locked successfully this will be set to true.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#locked\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "If the mouse has been pointer locked successfully this will be set to true.", "name": "locked", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#locked", "scope": "instance", "kind": "member", "___id": "T000002R023908", "___s": true }, { "comment": "/**\r\n * The Mouse Move Event handler.\r\n * This function is sent the native DOM MouseEvent.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#onMouseMove\r\n * @type {function}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "The Mouse Move Event handler.\rThis function is sent the native DOM MouseEvent.\rInitially empty and bound in the `startListeners` method.", "name": "onMouseMove", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.10.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#onMouseMove", "scope": "instance", "kind": "member", "___id": "T000002R023910", "___s": true }, { "comment": "/**\r\n * The Mouse Down Event handler.\r\n * This function is sent the native DOM MouseEvent.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#onMouseDown\r\n * @type {function}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 127, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "The Mouse Down Event handler.\rThis function is sent the native DOM MouseEvent.\rInitially empty and bound in the `startListeners` method.", "name": "onMouseDown", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.10.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#onMouseDown", "scope": "instance", "kind": "member", "___id": "T000002R023912", "___s": true }, { "comment": "/**\r\n * The Mouse Up Event handler.\r\n * This function is sent the native DOM MouseEvent.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#onMouseUp\r\n * @type {function}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 138, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "The Mouse Up Event handler.\rThis function is sent the native DOM MouseEvent.\rInitially empty and bound in the `startListeners` method.", "name": "onMouseUp", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.10.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#onMouseUp", "scope": "instance", "kind": "member", "___id": "T000002R023914", "___s": true }, { "comment": "/**\r\n * The Mouse Down Event handler specifically for events on the Window.\r\n * This function is sent the native DOM MouseEvent.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#onMouseDownWindow\r\n * @type {function}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "The Mouse Down Event handler specifically for events on the Window.\rThis function is sent the native DOM MouseEvent.\rInitially empty and bound in the `startListeners` method.", "name": "onMouseDownWindow", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.17.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#onMouseDownWindow", "scope": "instance", "kind": "member", "___id": "T000002R023916", "___s": true }, { "comment": "/**\r\n * The Mouse Up Event handler specifically for events on the Window.\r\n * This function is sent the native DOM MouseEvent.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#onMouseUpWindow\r\n * @type {function}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 160, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "The Mouse Up Event handler specifically for events on the Window.\rThis function is sent the native DOM MouseEvent.\rInitially empty and bound in the `startListeners` method.", "name": "onMouseUpWindow", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.17.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#onMouseUpWindow", "scope": "instance", "kind": "member", "___id": "T000002R023918", "___s": true }, { "comment": "/**\r\n * The Mouse Over Event handler.\r\n * This function is sent the native DOM MouseEvent.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#onMouseOver\r\n * @type {function}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 171, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "The Mouse Over Event handler.\rThis function is sent the native DOM MouseEvent.\rInitially empty and bound in the `startListeners` method.", "name": "onMouseOver", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.16.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#onMouseOver", "scope": "instance", "kind": "member", "___id": "T000002R023920", "___s": true }, { "comment": "/**\r\n * The Mouse Out Event handler.\r\n * This function is sent the native DOM MouseEvent.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#onMouseOut\r\n * @type {function}\r\n * @since 3.16.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 182, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "The Mouse Out Event handler.\rThis function is sent the native DOM MouseEvent.\rInitially empty and bound in the `startListeners` method.", "name": "onMouseOut", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.16.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#onMouseOut", "scope": "instance", "kind": "member", "___id": "T000002R023922", "___s": true }, { "comment": "/**\r\n * The Mouse Wheel Event handler.\r\n * This function is sent the native DOM MouseEvent.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#onMouseWheel\r\n * @type {function}\r\n * @since 3.18.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 193, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "The Mouse Wheel Event handler.\rThis function is sent the native DOM MouseEvent.\rInitially empty and bound in the `startListeners` method.", "name": "onMouseWheel", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.18.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#onMouseWheel", "scope": "instance", "kind": "member", "___id": "T000002R023924", "___s": true }, { "comment": "/**\r\n * Internal pointerLockChange handler.\r\n * This function is sent the native DOM MouseEvent.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#pointerLockChange\r\n * @type {function}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 204, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "Internal pointerLockChange handler.\rThis function is sent the native DOM MouseEvent.\rInitially empty and bound in the `startListeners` method.", "name": "pointerLockChange", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.0.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#pointerLockChange", "scope": "instance", "kind": "member", "___id": "T000002R023926", "___s": true }, { "comment": "/**\r\n * Are the event listeners hooked into `window.top` or `window`?\r\n *\r\n * This is set during the `boot` sequence. If the browser does not have access to `window.top`,\r\n * such as in cross-origin iframe environments, this property gets set to `false` and the events\r\n * are hooked into `window` instead.\r\n *\r\n * @name Phaser.Input.Mouse.MouseManager#isTop\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.50.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 215, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "Are the event listeners hooked into `window.top` or `window`?\r\rThis is set during the `boot` sequence. If the browser does not have access to `window.top`,\rsuch as in cross-origin iframe environments, this property gets set to `false` and the events\rare hooked into `window` instead.", "name": "isTop", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.50.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#isTop", "scope": "instance", "kind": "member", "___id": "T000002R023928", "___s": true }, { "comment": "/**\r\n * Attempts to disable the context menu from appearing if you right-click on the game canvas, or specified input target.\r\n *\r\n * Works by listening for the `contextmenu` event and prevent defaulting it.\r\n *\r\n * Use this if you need to enable right-button mouse support in your game, and the context\r\n * menu keeps getting in the way.\r\n *\r\n * @method Phaser.Input.Mouse.MouseManager#disableContextMenu\r\n * @since 3.0.0\r\n *\r\n * @return {this} This Mouse Manager instance.\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "Attempts to disable the context menu from appearing if you right-click on the game canvas, or specified input target.\r\rWorks by listening for the `contextmenu` event and prevent defaulting it.\r\rUse this if you need to enable right-button mouse support in your game, and the context\rmenu keeps getting in the way.", "kind": "function", "name": "disableContextMenu", "since": "3.0.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Mouse Manager instance." } ], "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#disableContextMenu", "scope": "instance", "___id": "T000002R023942", "___s": true }, { "comment": "/**\r\n * If the browser supports it, you can request that the pointer be locked to the browser window.\r\n *\r\n * This is classically known as 'FPS controls', where the pointer can't leave the browser until\r\n * the user presses an exit key.\r\n *\r\n * If the browser successfully enters a locked state, a `POINTER_LOCK_CHANGE_EVENT` will be dispatched,\r\n * from the games Input Manager, with an `isPointerLocked` property.\r\n *\r\n * It is important to note that pointer lock can only be enabled after an 'engagement gesture',\r\n * see: https://w3c.github.io/pointerlock/#dfn-engagement-gesture.\r\n *\r\n * Note for Firefox: There is a bug in certain Firefox releases that cause native DOM events like\r\n * `mousemove` to fire continuously when in pointer lock mode. You can get around this by setting\r\n * `this.preventDefaultMove` to `false` in this class. You may also need to do the same for\r\n * `preventDefaultDown` and/or `preventDefaultUp`. Please test combinations of these if you encounter\r\n * the error.\r\n *\r\n * @method Phaser.Input.Mouse.MouseManager#requestPointerLock\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 296, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "If the browser supports it, you can request that the pointer be locked to the browser window.\r\rThis is classically known as 'FPS controls', where the pointer can't leave the browser until\rthe user presses an exit key.\r\rIf the browser successfully enters a locked state, a `POINTER_LOCK_CHANGE_EVENT` will be dispatched,\rfrom the games Input Manager, with an `isPointerLocked` property.\r\rIt is important to note that pointer lock can only be enabled after an 'engagement gesture',\rsee: https://w3c.github.io/pointerlock/#dfn-engagement-gesture.\r\rNote for Firefox: There is a bug in certain Firefox releases that cause native DOM events like\r`mousemove` to fire continuously when in pointer lock mode. You can get around this by setting\r`this.preventDefaultMove` to `false` in this class. You may also need to do the same for\r`preventDefaultDown` and/or `preventDefaultUp`. Please test combinations of these if you encounter\rthe error.", "kind": "function", "name": "requestPointerLock", "since": "3.0.0", "memberof": "Phaser.Input.Mouse.MouseManager", "longname": "Phaser.Input.Mouse.MouseManager#requestPointerLock", "scope": "instance", "___id": "T000002R023944", "___s": true }, { "comment": "/**\r\n * If the browser supports pointer lock, this will request that the pointer lock is released. If\r\n * the browser successfully exits the locked state, a 'POINTER_LOCK_CHANGE_EVENT' will be\r\n * dispatched - from the game's input manager - with an `isPointerLocked` property.\r\n *\r\n * @method Phaser.Input.Mouse.MouseManager#releasePointerLock\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 329, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "If the browser supports pointer lock, this will request that the pointer lock is released. If\rthe browser successfully exits the locked state, a 'POINTER_LOCK_CHANGE_EVENT' will be\rdispatched - 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", "___id": "T000002R023948", "___s": true }, { "comment": "/**\r\n * Starts the Mouse Event listeners running.\r\n * This is called automatically and does not need to be manually invoked.\r\n *\r\n * @method Phaser.Input.Mouse.MouseManager#startListeners\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 346, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "Starts the Mouse Event listeners running.\rThis 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", "___id": "T000002R023951", "___s": true }, { "comment": "/**\r\n * Stops the Mouse Event listeners.\r\n * This is called automatically and does not need to be manually invoked.\r\n *\r\n * @method Phaser.Input.Mouse.MouseManager#stopListeners\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 520, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "description": "Stops the Mouse Event listeners.\rThis 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", "___id": "T000002R023974", "___s": true }, { "comment": "/**\r\n * Destroys this Mouse Manager instance.\r\n *\r\n * @method Phaser.Input.Mouse.MouseManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "MouseManager.js", "lineno": 553, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\mouse", "code": {} }, "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", "___id": "T000002R023978", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Pointer object encapsulates both mouse and touch input within Phaser.\r\n *\r\n * By default, Phaser will create 2 pointers for your game to use. If you require more, i.e. for a multi-touch\r\n * game, then use the `InputPlugin.addPointer` method to do so, rather than instantiating this class directly,\r\n * otherwise it won't be managed by the input system.\r\n *\r\n * You can reference the current active pointer via `InputPlugin.activePointer`. You can also use the properties\r\n * `InputPlugin.pointer1` through to `pointer10`, for each pointer you have enabled in your game.\r\n *\r\n * The properties of this object are set by the Input Plugin during processing. This object is then sent in all\r\n * input related events that the Input Plugin emits, so you can reference properties from it directly in your\r\n * callbacks.\r\n *\r\n * @class Pointer\r\n * @memberof Phaser.Input\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.InputManager} manager - A reference to the Input Manager.\r\n * @param {number} id - The internal ID of this Pointer.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "classdesc": "A Pointer object encapsulates both mouse and touch input within Phaser.\r\rBy default, Phaser will create 2 pointers for your game to use. If you require more, i.e. for a multi-touch\rgame, then use the `InputPlugin.addPointer` method to do so, rather than instantiating this class directly,\rotherwise it won't be managed by the input system.\r\rYou can reference the current active pointer via `InputPlugin.activePointer`. You can also use the properties\r`InputPlugin.pointer1` through to `pointer10`, for each pointer you have enabled in your game.\r\rThe properties of this object are set by the Input Plugin during processing. This object is then sent in all\rinput related events that the Input Plugin emits, so you can reference properties from it directly in your\rcallbacks.", "kind": "class", "name": "Pointer", "memberof": "Phaser.Input", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Input.InputManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputManager" } }, "description": "A reference to the Input Manager.", "name": "manager" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The internal ID of this Pointer.", "name": "id" } ], "scope": "static", "longname": "Phaser.Input.Pointer", "___id": "T000002R023991", "___s": true }, { "comment": "/**\r\n * A reference to the Input Manager.\r\n *\r\n * @name Phaser.Input.Pointer#manager\r\n * @type {Phaser.Input.InputManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 44, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A reference to the Input Manager.", "name": "manager", "type": { "names": [ "Phaser.Input.InputManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputManager" } }, "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#manager", "scope": "instance", "kind": "member", "___id": "T000002R023994", "___s": true }, { "comment": "/**\r\n * The internal ID of this Pointer.\r\n *\r\n * @name Phaser.Input.Pointer#id\r\n * @type {number}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 53, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The internal ID of this Pointer.", "name": "id", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#id", "scope": "instance", "kind": "member", "___id": "T000002R023996", "___s": true }, { "comment": "/**\r\n * The most recent native DOM Event this Pointer has processed.\r\n *\r\n * @name Phaser.Input.Pointer#event\r\n * @type {(TouchEvent|MouseEvent|WheelEvent)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 63, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The most recent native DOM Event this Pointer has processed.", "name": "event", "type": { "names": [ "TouchEvent", "MouseEvent", "WheelEvent" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "TouchEvent" }, { "type": "NameExpression", "name": "MouseEvent" }, { "type": "NameExpression", "name": "WheelEvent" } ] } }, "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#event", "scope": "instance", "kind": "member", "___id": "T000002R023998", "___s": true }, { "comment": "/**\r\n * The DOM element the Pointer was pressed down on, taken from the DOM event.\r\n * In a default set-up this will be the Canvas that Phaser is rendering to, or the Window element.\r\n *\r\n * @name Phaser.Input.Pointer#downElement\r\n * @type {any}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 72, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The DOM element the Pointer was pressed down on, taken from the DOM event.\rIn a default set-up this will be the Canvas that Phaser is rendering to, or the Window element.", "name": "downElement", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#downElement", "scope": "instance", "kind": "member", "___id": "T000002R024000", "___s": true }, { "comment": "/**\r\n * The DOM element the Pointer was released on, taken from the DOM event.\r\n * In a default set-up this will be the Canvas that Phaser is rendering to, or the Window element.\r\n *\r\n * @name Phaser.Input.Pointer#upElement\r\n * @type {any}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 83, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The DOM element the Pointer was released on, taken from the DOM event.\rIn a default set-up this will be the Canvas that Phaser is rendering to, or the Window element.", "name": "upElement", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#upElement", "scope": "instance", "kind": "member", "___id": "T000002R024002", "___s": true }, { "comment": "/**\r\n * The camera the Pointer interacted with during its last update.\r\n *\r\n * A Pointer can only ever interact with one camera at once, which will be the top-most camera\r\n * in the list should multiple cameras be positioned on-top of each other.\r\n *\r\n * @name Phaser.Input.Pointer#camera\r\n * @type {Phaser.Cameras.Scene2D.Camera}\r\n * @default null\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 94, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The camera the Pointer interacted with during its last update.\r\rA Pointer can only ever interact with one camera at once, which will be the top-most camera\rin the list should multiple cameras be positioned on-top of each other.", "name": "camera", "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "defaultvalue": "null", "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#camera", "scope": "instance", "kind": "member", "___id": "T000002R024004", "___s": true }, { "comment": "/**\r\n * A read-only property that indicates which button was pressed, or released, on the pointer\r\n * during the most recent event. It is only set during `up` and `down` events.\r\n *\r\n * On Touch devices the value is always 0.\r\n *\r\n * Users may change the configuration of buttons on their pointing device so that if an event's button property\r\n * is zero, it may not have been caused by the button that is physically left–most on the pointing device;\r\n * however, it should behave as if the left button was clicked in the standard button layout.\r\n *\r\n * @name Phaser.Input.Pointer#button\r\n * @type {number}\r\n * @readonly\r\n * @default 0\r\n * @since 3.18.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 107, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A read-only property that indicates which button was pressed, or released, on the pointer\rduring the most recent event. It is only set during `up` and `down` events.\r\rOn Touch devices the value is always 0.\r\rUsers may change the configuration of buttons on their pointing device so that if an event's button property\ris zero, it may not have been caused by the button that is physically left–most on the pointing device;\rhowever, it should behave as if the left button was clicked in the standard button layout.", "name": "button", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "defaultvalue": "0", "since": "3.18.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#button", "scope": "instance", "kind": "member", "___id": "T000002R024006", "___s": true }, { "comment": "/**\r\n * A bitmask representing which mouse buttons are currently held down. The possible values are:\r\n *\r\n * 0: No button or un-initialized\r\n * 1: Left button\r\n * 2: Right button\r\n * 4: Wheel button or middle button\r\n * 8: 4th button (typically the \"Browser Back\" button)\r\n * 16: 5th button (typically the \"Browser Forward\" button)\r\n *\r\n * For a mouse configured for left-handed use, the button actions are reversed.\r\n * In this case, the values are read from right to left.\r\n *\r\n * @name Phaser.Input.Pointer#buttons\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 125, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "A bitmask representing which mouse buttons are currently held down. The possible values are:\r\r0: No button or un-initialized\r1: Left button\r2: Right button\r4: Wheel button or middle button\r8: 4th button (typically the \"Browser Back\" button)\r16: 5th button (typically the \"Browser Forward\" button)\r\rFor a mouse configured for left-handed use, the button actions are reversed.\rIn this case, the values are read from right to left.", "name": "buttons", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#buttons", "scope": "instance", "kind": "member", "___id": "T000002R024008", "___s": true }, { "comment": "/**\r\n * The position of the Pointer in screen space.\r\n *\r\n * @name Phaser.Input.Pointer#position\r\n * @type {Phaser.Math.Vector2}\r\n * @readonly\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 145, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The position of the Pointer in screen space.", "name": "position", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#position", "scope": "instance", "kind": "member", "___id": "T000002R024010", "___s": true }, { "comment": "/**\r\n * The previous position of the Pointer in screen space.\r\n *\r\n * The old x and y values are stored in here during the InputManager.transformPointer call.\r\n *\r\n * Use the properties `velocity`, `angle` and `distance` to create your own gesture recognition.\r\n *\r\n * @name Phaser.Input.Pointer#prevPosition\r\n * @type {Phaser.Math.Vector2}\r\n * @readonly\r\n * @since 3.11.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 155, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The previous position of the Pointer in screen space.\r\rThe old x and y values are stored in here during the InputManager.transformPointer call.\r\rUse the properties `velocity`, `angle` and `distance` to create your own gesture recognition.", "name": "prevPosition", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.11.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#prevPosition", "scope": "instance", "kind": "member", "___id": "T000002R024012", "___s": true }, { "comment": "/**\r\n * The current velocity of the Pointer, based on its current and previous positions.\r\n *\r\n * This value is smoothed out each frame, according to the `motionFactor` property.\r\n *\r\n * This property is updated whenever the Pointer moves, regardless of any button states. In other words,\r\n * it changes based on movement alone - a button doesn't have to be pressed first.\r\n *\r\n * @name Phaser.Input.Pointer#velocity\r\n * @type {Phaser.Math.Vector2}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 179, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The current velocity of the Pointer, based on its current and previous positions.\r\rThis value is smoothed out each frame, according to the `motionFactor` property.\r\rThis property is updated whenever the Pointer moves, regardless of any button states. In other words,\rit changes based on movement alone - a button doesn't have to be pressed first.", "name": "velocity", "type": { "names": [ "Phaser.Math.Vector2" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Math.Vector2" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#velocity", "scope": "instance", "kind": "member", "___id": "T000002R024016", "___s": true }, { "comment": "/**\r\n * The current angle the Pointer is moving, in radians, based on its previous and current position.\r\n *\r\n * The angle is based on the old position facing to the current position.\r\n *\r\n * This property is updated whenever the Pointer moves, regardless of any button states. In other words,\r\n * it changes based on movement alone - a button doesn't have to be pressed first.\r\n *\r\n * @name Phaser.Input.Pointer#angle\r\n * @type {number}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 194, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The current angle the Pointer is moving, in radians, based on its previous and current position.\r\rThe angle is based on the old position facing to the current position.\r\rThis property is updated whenever the Pointer moves, regardless of any button states. In other words,\rit changes based on movement alone - a button doesn't have to be pressed first.", "name": "angle", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#angle", "scope": "instance", "kind": "member", "___id": "T000002R024018", "___s": true }, { "comment": "/**\r\n * The distance the Pointer has moved, based on its previous and current position.\r\n *\r\n * This value is smoothed out each frame, according to the `motionFactor` property.\r\n *\r\n * This property is updated whenever the Pointer moves, regardless of any button states. In other words,\r\n * it changes based on movement alone - a button doesn't have to be pressed first.\r\n *\r\n * If you need the total distance travelled since the primary button was pressed down,\r\n * then use the `Pointer.getDistance` method.\r\n *\r\n * @name Phaser.Input.Pointer#distance\r\n * @type {number}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 209, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The distance the Pointer has moved, based on its previous and current position.\r\rThis value is smoothed out each frame, according to the `motionFactor` property.\r\rThis property is updated whenever the Pointer moves, regardless of any button states. In other words,\rit changes based on movement alone - a button doesn't have to be pressed first.\r\rIf you need the total distance travelled since the primary button was pressed down,\rthen use the `Pointer.getDistance` method.", "name": "distance", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#distance", "scope": "instance", "kind": "member", "___id": "T000002R024020", "___s": true }, { "comment": "/**\r\n * The smoothing factor to apply to the Pointer position.\r\n *\r\n * Due to their nature, pointer positions are inherently noisy. While this is fine for lots of games, if you need cleaner positions\r\n * then you can set this value to apply an automatic smoothing to the positions as they are recorded.\r\n *\r\n * The default value of zero means 'no smoothing'.\r\n * Set to a small value, such as 0.2, to apply an average level of smoothing between positions. You can do this by changing this\r\n * value directly, or by setting the `input.smoothFactor` property in the Game Config.\r\n *\r\n * Positions are only smoothed when the pointer moves. If the primary button on this Pointer enters an Up or Down state, then the position\r\n * is always precise, and not smoothed.\r\n *\r\n * @name Phaser.Input.Pointer#smoothFactor\r\n * @type {number}\r\n * @default 0\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 227, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The smoothing factor to apply to the Pointer position.\r\rDue to their nature, pointer positions are inherently noisy. While this is fine for lots of games, if you need cleaner positions\rthen you can set this value to apply an automatic smoothing to the positions as they are recorded.\r\rThe default value of zero means 'no smoothing'.\rSet to a small value, such as 0.2, to apply an average level of smoothing between positions. You can do this by changing this\rvalue directly, or by setting the `input.smoothFactor` property in the Game Config.\r\rPositions are only smoothed when the pointer moves. If the primary button on this Pointer enters an Up or Down state, then the position\ris always precise, and not smoothed.", "name": "smoothFactor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.16.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#smoothFactor", "scope": "instance", "kind": "member", "___id": "T000002R024022", "___s": true }, { "comment": "/**\r\n * The factor applied to the motion smoothing each frame.\r\n *\r\n * This value is passed to the Smooth Step Interpolation that is used to calculate the velocity,\r\n * angle and distance of the Pointer. It's applied every frame, until the midPoint reaches the current\r\n * position of the Pointer. 0.2 provides a good average but can be increased if you need a\r\n * quicker update and are working in a high performance environment. Never set this value to\r\n * zero.\r\n *\r\n * @name Phaser.Input.Pointer#motionFactor\r\n * @type {number}\r\n * @default 0.2\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 247, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The factor applied to the motion smoothing each frame.\r\rThis value is passed to the Smooth Step Interpolation that is used to calculate the velocity,\rangle and distance of the Pointer. It's applied every frame, until the midPoint reaches the current\rposition of the Pointer. 0.2 provides a good average but can be increased if you need a\rquicker update and are working in a high performance environment. Never set this value to\rzero.", "name": "motionFactor", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0.2", "since": "3.16.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#motionFactor", "scope": "instance", "kind": "member", "___id": "T000002R024024", "___s": true }, { "comment": "/**\r\n * The x position of this Pointer, translated into the coordinate space of the most recent Camera it interacted with.\r\n *\r\n * If you wish to use this value _outside_ of an input event handler then you should update it first by calling\r\n * the `Pointer.updateWorldPoint` method.\r\n *\r\n * @name Phaser.Input.Pointer#worldX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 263, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The x position of this Pointer, translated into the coordinate space of the most recent Camera it interacted with.\r\rIf you wish to use this value _outside_ of an input event handler then you should update it first by calling\rthe `Pointer.updateWorldPoint` method.", "name": "worldX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.10.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#worldX", "scope": "instance", "kind": "member", "___id": "T000002R024026", "___s": true }, { "comment": "/**\r\n * The y position of this Pointer, translated into the coordinate space of the most recent Camera it interacted with.\r\n *\r\n * If you wish to use this value _outside_ of an input event handler then you should update it first by calling\r\n * the `Pointer.updateWorldPoint` method.\r\n *\r\n * @name Phaser.Input.Pointer#worldY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 276, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The y position of this Pointer, translated into the coordinate space of the most recent Camera it interacted with.\r\rIf you wish to use this value _outside_ of an input event handler then you should update it first by calling\rthe `Pointer.updateWorldPoint` method.", "name": "worldY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.10.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#worldY", "scope": "instance", "kind": "member", "___id": "T000002R024028", "___s": true }, { "comment": "/**\r\n * Time when this Pointer was most recently moved (regardless of the state of its buttons, if any).\r\n *\r\n * @name Phaser.Input.Pointer#moveTime\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 289, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Time when this Pointer was most recently moved (regardless of the state of its buttons, if any).", "name": "moveTime", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#moveTime", "scope": "instance", "kind": "member", "___id": "T000002R024030", "___s": true }, { "comment": "/**\r\n * X coordinate of the Pointer when Button 1 (left button), or Touch, was pressed, used for dragging objects.\r\n *\r\n * @name Phaser.Input.Pointer#downX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 299, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "X coordinate of the Pointer when Button 1 (left button), or Touch, was pressed, used for dragging objects.", "name": "downX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#downX", "scope": "instance", "kind": "member", "___id": "T000002R024032", "___s": true }, { "comment": "/**\r\n * Y coordinate of the Pointer when Button 1 (left button), or Touch, was pressed, used for dragging objects.\r\n *\r\n * @name Phaser.Input.Pointer#downY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 309, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Y coordinate of the Pointer when Button 1 (left button), or Touch, was pressed, used for dragging objects.", "name": "downY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#downY", "scope": "instance", "kind": "member", "___id": "T000002R024034", "___s": true }, { "comment": "/**\r\n * The Event timestamp when the first button, or Touch input, was pressed. Used for dragging objects.\r\n *\r\n * @name Phaser.Input.Pointer#downTime\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 319, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The Event timestamp when the first button, or Touch input, was pressed. Used for dragging objects.", "name": "downTime", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#downTime", "scope": "instance", "kind": "member", "___id": "T000002R024036", "___s": true }, { "comment": "/**\r\n * X coordinate of the Pointer when Button 1 (left button), or Touch, was released, used for dragging objects.\r\n *\r\n * @name Phaser.Input.Pointer#upX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 329, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "X coordinate of the Pointer when Button 1 (left button), or Touch, was released, used for dragging objects.", "name": "upX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#upX", "scope": "instance", "kind": "member", "___id": "T000002R024038", "___s": true }, { "comment": "/**\r\n * Y coordinate of the Pointer when Button 1 (left button), or Touch, was released, used for dragging objects.\r\n *\r\n * @name Phaser.Input.Pointer#upY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 339, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Y coordinate of the Pointer when Button 1 (left button), or Touch, was released, used for dragging objects.", "name": "upY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#upY", "scope": "instance", "kind": "member", "___id": "T000002R024040", "___s": true }, { "comment": "/**\r\n * The Event timestamp when the final button, or Touch input, was released. Used for dragging objects.\r\n *\r\n * @name Phaser.Input.Pointer#upTime\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 349, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The Event timestamp when the final button, or Touch input, was released. Used for dragging objects.", "name": "upTime", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#upTime", "scope": "instance", "kind": "member", "___id": "T000002R024042", "___s": true }, { "comment": "/**\r\n * Is the primary button down? (usually button 0, the left mouse button)\r\n *\r\n * @name Phaser.Input.Pointer#primaryDown\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 359, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Is the primary button down? (usually button 0, the left mouse button)", "name": "primaryDown", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#primaryDown", "scope": "instance", "kind": "member", "___id": "T000002R024044", "___s": true }, { "comment": "/**\r\n * Is _any_ button on this pointer considered as being down?\r\n *\r\n * @name Phaser.Input.Pointer#isDown\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 369, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Is _any_ button on this pointer considered as being down?", "name": "isDown", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#isDown", "scope": "instance", "kind": "member", "___id": "T000002R024046", "___s": true }, { "comment": "/**\r\n * Did the previous input event come from a Touch input (true) or Mouse? (false)\r\n *\r\n * @name Phaser.Input.Pointer#wasTouch\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 379, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Did the previous input event come from a Touch input (true) or Mouse? (false)", "name": "wasTouch", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#wasTouch", "scope": "instance", "kind": "member", "___id": "T000002R024048", "___s": true }, { "comment": "/**\r\n * Did this Pointer get canceled by a touchcancel event?\r\n *\r\n * Note: \"canceled\" is the American-English spelling of \"cancelled\". Please don't submit PRs correcting it!\r\n *\r\n * @name Phaser.Input.Pointer#wasCanceled\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.15.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 389, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Did this Pointer get canceled by a touchcancel event?\r\rNote: \"canceled\" is the American-English spelling of \"cancelled\". Please don't submit PRs correcting it!", "name": "wasCanceled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.15.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#wasCanceled", "scope": "instance", "kind": "member", "___id": "T000002R024050", "___s": true }, { "comment": "/**\r\n * If the mouse is locked, the horizontal relative movement of the Pointer in pixels since last frame.\r\n *\r\n * @name Phaser.Input.Pointer#movementX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 401, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "If the mouse is locked, the horizontal relative movement of the Pointer in pixels since last frame.", "name": "movementX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#movementX", "scope": "instance", "kind": "member", "___id": "T000002R024052", "___s": true }, { "comment": "/**\r\n * If the mouse is locked, the vertical relative movement of the Pointer in pixels since last frame.\r\n *\r\n * @name Phaser.Input.Pointer#movementY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 411, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "If the mouse is locked, the vertical relative movement of the Pointer in pixels since last frame.", "name": "movementY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#movementY", "scope": "instance", "kind": "member", "___id": "T000002R024054", "___s": true }, { "comment": "/**\r\n * The identifier property of the Pointer as set by the DOM event when this Pointer is started.\r\n *\r\n * @name Phaser.Input.Pointer#identifier\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 421, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The identifier property of the Pointer as set by the DOM event when this Pointer is started.", "name": "identifier", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#identifier", "scope": "instance", "kind": "member", "___id": "T000002R024056", "___s": true }, { "comment": "/**\r\n * The pointerId property of the Pointer as set by the DOM event when this Pointer is started.\r\n * The browser can and will recycle this value.\r\n *\r\n * @name Phaser.Input.Pointer#pointerId\r\n * @type {number}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 430, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The pointerId property of the Pointer as set by the DOM event when this Pointer is started.\rThe browser can and will recycle this value.", "name": "pointerId", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.10.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#pointerId", "scope": "instance", "kind": "member", "___id": "T000002R024058", "___s": true }, { "comment": "/**\r\n * An active Pointer is one that is currently pressed down on the display.\r\n * A Mouse is always considered as active.\r\n *\r\n * @name Phaser.Input.Pointer#active\r\n * @type {boolean}\r\n * @since 3.10.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 440, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "An active Pointer is one that is currently pressed down on the display.\rA Mouse is always considered as active.", "name": "active", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.10.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#active", "scope": "instance", "kind": "member", "___id": "T000002R024060", "___s": true }, { "comment": "/**\r\n * Is this pointer Pointer Locked?\r\n *\r\n * Only a mouse pointer can be locked and it only becomes locked when requested via\r\n * the browsers Pointer Lock API.\r\n *\r\n * You can request this by calling the `this.input.mouse.requestPointerLock()` method from\r\n * a `pointerdown` or `pointerup` event handler.\r\n *\r\n * @name Phaser.Input.Pointer#locked\r\n * @readonly\r\n * @type {boolean}\r\n * @since 3.19.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 450, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Is this pointer Pointer Locked?\r\rOnly a mouse pointer can be locked and it only becomes locked when requested via\rthe browsers Pointer Lock API.\r\rYou can request this by calling the `this.input.mouse.requestPointerLock()` method from\ra `pointerdown` or `pointerup` event handler.", "name": "locked", "readonly": true, "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.19.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#locked", "scope": "instance", "kind": "member", "___id": "T000002R024062", "___s": true }, { "comment": "/**\r\n * The horizontal scroll amount that occurred due to the user moving a mouse wheel or similar input device.\r\n *\r\n * @name Phaser.Input.Pointer#deltaX\r\n * @type {number}\r\n * @default 0\r\n * @since 3.18.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 466, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The horizontal scroll amount that occurred due to the user moving a mouse wheel or similar input device.", "name": "deltaX", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.18.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#deltaX", "scope": "instance", "kind": "member", "___id": "T000002R024064", "___s": true }, { "comment": "/**\r\n * The vertical scroll amount that occurred due to the user moving a mouse wheel or similar input device.\r\n * This value will typically be less than 0 if the user scrolls up and greater than zero if scrolling down.\r\n *\r\n * @name Phaser.Input.Pointer#deltaY\r\n * @type {number}\r\n * @default 0\r\n * @since 3.18.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 476, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The vertical scroll amount that occurred due to the user moving a mouse wheel or similar input device.\rThis value will typically be less than 0 if the user scrolls up and greater than zero if scrolling down.", "name": "deltaY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.18.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#deltaY", "scope": "instance", "kind": "member", "___id": "T000002R024066", "___s": true }, { "comment": "/**\r\n * The z-axis scroll amount that occurred due to the user moving a mouse wheel or similar input device.\r\n *\r\n * @name Phaser.Input.Pointer#deltaZ\r\n * @type {number}\r\n * @default 0\r\n * @since 3.18.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 487, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.18.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#deltaZ", "scope": "instance", "kind": "member", "___id": "T000002R024068", "___s": true }, { "comment": "/**\r\n * Takes a Camera and updates this Pointer's `worldX` and `worldY` values so they are\r\n * the result of a translation through the given Camera.\r\n *\r\n * Note that the values will be automatically replaced the moment the Pointer is\r\n * updated by an input event, such as a mouse move, so should be used immediately.\r\n *\r\n * @method Phaser.Input.Pointer#updateWorldPoint\r\n * @since 3.19.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera which is being tested against.\r\n *\r\n * @return {this} This Pointer object.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 498, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Takes a Camera and updates this Pointer's `worldX` and `worldY` values so they are\rthe result of a translation through the given Camera.\r\rNote that the values will be automatically replaced the moment the Pointer is\rupdated 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera which is being tested against.", "name": "camera" } ], "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Pointer object." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#updateWorldPoint", "scope": "instance", "___id": "T000002R024070", "___s": true }, { "comment": "/**\r\n * Takes a Camera and returns a Vector2 containing the translated position of this Pointer\r\n * within that Camera. This can be used to convert this Pointers position into camera space.\r\n *\r\n * @method Phaser.Input.Pointer#positionToCamera\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to use for the translation.\r\n * @param {(Phaser.Math.Vector2|object)} [output] - A Vector2-like object in which to store the translated position.\r\n *\r\n * @return {(Phaser.Math.Vector2|object)} A Vector2 containing the translated coordinates of this Pointer, based on the given camera.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 523, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Takes a Camera and returns a Vector2 containing the translated position of this Pointer\rwithin 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The Camera to use for the translation.", "name": "camera" }, { "type": { "names": [ "Phaser.Math.Vector2", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "object" } ] } }, "optional": true, "description": "A Vector2-like object in which to store the translated position.", "name": "output" } ], "returns": [ { "type": { "names": [ "Phaser.Math.Vector2", "object" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Math.Vector2" }, { "type": "NameExpression", "name": "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", "___id": "T000002R024075", "___s": true }, { "comment": "/**\r\n * Checks to see if any buttons are being held down on this Pointer.\r\n *\r\n * @method Phaser.Input.Pointer#noButtonDown\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if no buttons are being held down.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 880, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if no buttons are being held down." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#noButtonDown", "scope": "instance", "___id": "T000002R024180", "___s": true }, { "comment": "/**\r\n * Checks to see if the left button is being held down on this Pointer.\r\n *\r\n * @method Phaser.Input.Pointer#leftButtonDown\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the left button is being held down.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 893, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the left button is being held down." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#leftButtonDown", "scope": "instance", "___id": "T000002R024182", "___s": true }, { "comment": "/**\r\n * Checks to see if the right button is being held down on this Pointer.\r\n *\r\n * @method Phaser.Input.Pointer#rightButtonDown\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the right button is being held down.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 906, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the right button is being held down." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#rightButtonDown", "scope": "instance", "___id": "T000002R024184", "___s": true }, { "comment": "/**\r\n * Checks to see if the middle button is being held down on this Pointer.\r\n *\r\n * @method Phaser.Input.Pointer#middleButtonDown\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the middle button is being held down.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 919, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the middle button is being held down." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#middleButtonDown", "scope": "instance", "___id": "T000002R024186", "___s": true }, { "comment": "/**\r\n * Checks to see if the back button is being held down on this Pointer.\r\n *\r\n * @method Phaser.Input.Pointer#backButtonDown\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the back button is being held down.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 932, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the back button is being held down." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#backButtonDown", "scope": "instance", "___id": "T000002R024188", "___s": true }, { "comment": "/**\r\n * Checks to see if the forward button is being held down on this Pointer.\r\n *\r\n * @method Phaser.Input.Pointer#forwardButtonDown\r\n * @since 3.0.0\r\n *\r\n * @return {boolean} `true` if the forward button is being held down.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 945, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the forward button is being held down." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#forwardButtonDown", "scope": "instance", "___id": "T000002R024190", "___s": true }, { "comment": "/**\r\n * Checks to see if the release of the left button was the most recent activity on this Pointer.\r\n *\r\n * @method Phaser.Input.Pointer#leftButtonReleased\r\n * @since 3.18.0\r\n *\r\n * @return {boolean} `true` if the release of the left button was the most recent activity on this Pointer.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 958, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Checks to see if the release of the left button was the most recent activity on this Pointer.", "kind": "function", "name": "leftButtonReleased", "since": "3.18.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the release of the left button was the most recent activity on this Pointer." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#leftButtonReleased", "scope": "instance", "___id": "T000002R024192", "___s": true }, { "comment": "/**\r\n * Checks to see if the release of the right button was the most recent activity on this Pointer.\r\n *\r\n * @method Phaser.Input.Pointer#rightButtonReleased\r\n * @since 3.18.0\r\n *\r\n * @return {boolean} `true` if the release of the right button was the most recent activity on this Pointer.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 971, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Checks to see if the release of the right button was the most recent activity on this Pointer.", "kind": "function", "name": "rightButtonReleased", "since": "3.18.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the release of the right button was the most recent activity on this Pointer." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#rightButtonReleased", "scope": "instance", "___id": "T000002R024194", "___s": true }, { "comment": "/**\r\n * Checks to see if the release of the middle button was the most recent activity on this Pointer.\r\n *\r\n * @method Phaser.Input.Pointer#middleButtonReleased\r\n * @since 3.18.0\r\n *\r\n * @return {boolean} `true` if the release of the middle button was the most recent activity on this Pointer.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 984, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Checks to see if the release of the middle button was the most recent activity on this Pointer.", "kind": "function", "name": "middleButtonReleased", "since": "3.18.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the release of the middle button was the most recent activity on this Pointer." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#middleButtonReleased", "scope": "instance", "___id": "T000002R024196", "___s": true }, { "comment": "/**\r\n * Checks to see if the release of the back button was the most recent activity on this Pointer.\r\n *\r\n * @method Phaser.Input.Pointer#backButtonReleased\r\n * @since 3.18.0\r\n *\r\n * @return {boolean} `true` if the release of the back button was the most recent activity on this Pointer.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 997, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Checks to see if the release of the back button was the most recent activity on this Pointer.", "kind": "function", "name": "backButtonReleased", "since": "3.18.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the release of the back button was the most recent activity on this Pointer." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#backButtonReleased", "scope": "instance", "___id": "T000002R024198", "___s": true }, { "comment": "/**\r\n * Checks to see if the release of the forward button was the most recent activity on this Pointer.\r\n *\r\n * @method Phaser.Input.Pointer#forwardButtonReleased\r\n * @since 3.18.0\r\n *\r\n * @return {boolean} `true` if the release of the forward button was the most recent activity on this Pointer.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 1010, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Checks to see if the release of the forward button was the most recent activity on this Pointer.", "kind": "function", "name": "forwardButtonReleased", "since": "3.18.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if the release of the forward button was the most recent activity on this Pointer." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#forwardButtonReleased", "scope": "instance", "___id": "T000002R024200", "___s": true }, { "comment": "/**\r\n * If the Pointer has a button pressed down at the time this method is called, it will return the\r\n * distance between the Pointer's `downX` and `downY` values and the current position.\r\n *\r\n * If no button is held down, it will return the last recorded distance, based on where\r\n * the Pointer was when the button was released.\r\n *\r\n * If you wish to get the distance being travelled currently, based on the velocity of the Pointer,\r\n * then see the `Pointer.distance` property.\r\n *\r\n * @method Phaser.Input.Pointer#getDistance\r\n * @since 3.13.0\r\n *\r\n * @return {number} The distance the Pointer moved.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 1023, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "If the Pointer has a button pressed down at the time this method is called, it will return the\rdistance between the Pointer's `downX` and `downY` values and the current position.\r\rIf no button is held down, it will return the last recorded distance, based on where\rthe Pointer was when the button was released.\r\rIf you wish to get the distance being travelled currently, based on the velocity of the Pointer,\rthen see the `Pointer.distance` property.", "kind": "function", "name": "getDistance", "since": "3.13.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The distance the Pointer moved." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#getDistance", "scope": "instance", "___id": "T000002R024202", "___s": true }, { "comment": "/**\r\n * If the Pointer has a button pressed down at the time this method is called, it will return the\r\n * horizontal distance between the Pointer's `downX` value and the current `x` position.\r\n *\r\n * If no button is held down, it will return the last recorded horizontal distance, based on where\r\n * the Pointer was when the button was released.\r\n *\r\n * @method Phaser.Input.Pointer#getDistanceX\r\n * @since 3.16.0\r\n *\r\n * @return {number} The horizontal distance the Pointer moved.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 1050, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "If the Pointer has a button pressed down at the time this method is called, it will return the\rhorizontal distance between the Pointer's `downX` value and the current `x` position.\r\rIf no button is held down, it will return the last recorded horizontal distance, based on where\rthe Pointer was when the button was released.", "kind": "function", "name": "getDistanceX", "since": "3.16.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The horizontal distance the Pointer moved." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#getDistanceX", "scope": "instance", "___id": "T000002R024204", "___s": true }, { "comment": "/**\r\n * If the Pointer has a button pressed down at the time this method is called, it will return the\r\n * vertical distance between the Pointer's `downY` value and the current `y` position.\r\n *\r\n * If no button is held down, it will return the last recorded vertical distance, based on where\r\n * the Pointer was when the button was released.\r\n *\r\n * @method Phaser.Input.Pointer#getDistanceY\r\n * @since 3.16.0\r\n *\r\n * @return {number} The vertical distance the Pointer moved.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 1074, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "If the Pointer has a button pressed down at the time this method is called, it will return the\rvertical distance between the Pointer's `downY` value and the current `y` position.\r\rIf no button is held down, it will return the last recorded vertical distance, based on where\rthe Pointer was when the button was released.", "kind": "function", "name": "getDistanceY", "since": "3.16.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The vertical distance the Pointer moved." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#getDistanceY", "scope": "instance", "___id": "T000002R024206", "___s": true }, { "comment": "/**\r\n * If the Pointer has a button pressed down at the time this method is called, it will return the\r\n * duration since the button was pressed down.\r\n *\r\n * If no button is held down, it will return the last recorded duration, based on the time\r\n * the last button on the Pointer was released.\r\n *\r\n * @method Phaser.Input.Pointer#getDuration\r\n * @since 3.16.0\r\n *\r\n * @return {number} The duration the Pointer was held down for in milliseconds.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 1098, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "If the Pointer has a button pressed down at the time this method is called, it will return the\rduration since the button was pressed down.\r\rIf no button is held down, it will return the last recorded duration, based on the time\rthe last button on the Pointer was released.", "kind": "function", "name": "getDuration", "since": "3.16.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The duration the Pointer was held down for in milliseconds." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#getDuration", "scope": "instance", "___id": "T000002R024208", "___s": true }, { "comment": "/**\r\n * If the Pointer has a button pressed down at the time this method is called, it will return the\r\n * angle between the Pointer's `downX` and `downY` values and the current position.\r\n *\r\n * If no button is held down, it will return the last recorded angle, based on where\r\n * the Pointer was when the button was released.\r\n *\r\n * The angle is based on the old position facing to the current position.\r\n *\r\n * If you wish to get the current angle, based on the velocity of the Pointer, then\r\n * see the `Pointer.angle` property.\r\n *\r\n * @method Phaser.Input.Pointer#getAngle\r\n * @since 3.16.0\r\n *\r\n * @return {number} The angle between the Pointer's coordinates in radians.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 1122, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "If the Pointer has a button pressed down at the time this method is called, it will return the\rangle between the Pointer's `downX` and `downY` values and the current position.\r\rIf no button is held down, it will return the last recorded angle, based on where\rthe Pointer was when the button was released.\r\rThe angle is based on the old position facing to the current position.\r\rIf you wish to get the current angle, based on the velocity of the Pointer, then\rsee the `Pointer.angle` property.", "kind": "function", "name": "getAngle", "since": "3.16.0", "returns": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The angle between the Pointer's coordinates in radians." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#getAngle", "scope": "instance", "___id": "T000002R024210", "___s": true }, { "comment": "/**\r\n * Takes the previous and current Pointer positions and then generates an array of interpolated values between\r\n * the two. The array will be populated up to the size of the `steps` argument.\r\n *\r\n * ```javascript\r\n * var points = pointer.getInterpolatedPosition(4);\r\n *\r\n * // points[0] = { x: 0, y: 0 }\r\n * // points[1] = { x: 2, y: 1 }\r\n * // points[2] = { x: 3, y: 2 }\r\n * // points[3] = { x: 6, y: 3 }\r\n * ```\r\n *\r\n * Use this if you need to get smoothed values between the previous and current pointer positions. DOM pointer\r\n * events can often fire faster than the main browser loop, and this will help you avoid janky movement\r\n * especially if you have an object following a Pointer.\r\n *\r\n * Note that if you provide an output array it will only be populated up to the number of steps provided.\r\n * It will not clear any previous data that may have existed beyond the range of the steps count.\r\n *\r\n * Internally it uses the Smooth Step interpolation calculation.\r\n *\r\n * @method Phaser.Input.Pointer#getInterpolatedPosition\r\n * @since 3.11.0\r\n *\r\n * @param {number} [steps=10] - The number of interpolation steps to use.\r\n * @param {array} [out] - An array to store the results in. If not provided a new one will be created.\r\n *\r\n * @return {array} An array of interpolated values.\r\n */", "meta": { "filename": "Pointer.js", "lineno": 1151, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Takes the previous and current Pointer positions and then generates an array of interpolated values between\rthe two. The array will be populated up to the size of the `steps` argument.\r\r```javascript\rvar points = pointer.getInterpolatedPosition(4);\r\r// points[0] = { x: 0, y: 0 }\r// points[1] = { x: 2, y: 1 }\r// points[2] = { x: 3, y: 2 }\r// points[3] = { x: 6, y: 3 }\r```\r\rUse this if you need to get smoothed values between the previous and current pointer positions. DOM pointer\revents can often fire faster than the main browser loop, and this will help you avoid janky movement\respecially if you have an object following a Pointer.\r\rNote that if you provide an output array it will only be populated up to the number of steps provided.\rIt will not clear any previous data that may have existed beyond the range of the steps count.\r\rInternally it uses the Smooth Step interpolation calculation.", "kind": "function", "name": "getInterpolatedPosition", "since": "3.11.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 10, "description": "The number of interpolation steps to use.", "name": "steps" }, { "type": { "names": [ "array" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "array" } }, "description": "An array of interpolated values." } ], "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#getInterpolatedPosition", "scope": "instance", "___id": "T000002R024212", "___s": true }, { "comment": "/**\r\n * Fully reset this Pointer back to its uninitialized state.\r\n *\r\n * @method Phaser.Input.Pointer#reset\r\n * @since 3.60.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 1202, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Fully reset this Pointer back to its uninitialized state.", "kind": "function", "name": "reset", "since": "3.60.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#reset", "scope": "instance", "___id": "T000002R024225", "___s": true }, { "comment": "/**\r\n * Destroys this Pointer instance and resets its external references.\r\n *\r\n * @method Phaser.Input.Pointer#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 1247, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "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", "___id": "T000002R024255", "___s": true }, { "comment": "/**\r\n * The x position of this Pointer.\r\n * The value is in screen space.\r\n * See `worldX` to get a camera converted position.\r\n *\r\n * @name Phaser.Input.Pointer#x\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 1260, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The x position of this Pointer.\rThe value is in screen space.\rSee `worldX` to get a camera converted position.", "name": "x", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#x", "scope": "instance", "kind": "member", "___id": "T000002R024260", "___s": true }, { "comment": "/**\r\n * The y position of this Pointer.\r\n * The value is in screen space.\r\n * See `worldY` to get a camera converted position.\r\n *\r\n * @name Phaser.Input.Pointer#y\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 1283, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "The y position of this Pointer.\rThe value is in screen space.\rSee `worldY` to get a camera converted position.", "name": "y", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#y", "scope": "instance", "kind": "member", "___id": "T000002R024265", "___s": true }, { "comment": "/**\r\n * Time when this Pointer was most recently updated by a DOM Event.\r\n * This comes directly from the `event.timeStamp` property.\r\n * If no event has yet taken place, it will return zero.\r\n *\r\n * @name Phaser.Input.Pointer#time\r\n * @type {number}\r\n * @readonly\r\n * @since 3.16.0\r\n */", "meta": { "filename": "Pointer.js", "lineno": 1306, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input", "code": {} }, "description": "Time when this Pointer was most recently updated by a DOM Event.\rThis comes directly from the `event.timeStamp` property.\rIf no event has yet taken place, it will return zero.", "name": "time", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "readonly": true, "since": "3.16.0", "memberof": "Phaser.Input.Pointer", "longname": "Phaser.Input.Pointer#time", "scope": "instance", "kind": "member", "___id": "T000002R024270", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Input.Touch\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "kind": "namespace", "name": "Touch", "memberof": "Phaser.Input", "longname": "Phaser.Input.Touch", "scope": "static", "___id": "T000002R024274", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The Touch Manager is a helper class that belongs to the Input Manager.\r\n *\r\n * Its role is to listen for native DOM Touch Events and then pass them onto the Input Manager for further processing.\r\n *\r\n * You do not need to create this class directly, the Input Manager will create an instance of it automatically.\r\n *\r\n * @class TouchManager\r\n * @memberof Phaser.Input.Touch\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Input.InputManager} inputManager - A reference to the Input Manager.\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "classdesc": "The Touch Manager is a helper class that belongs to the Input Manager.\r\rIts role is to listen for native DOM Touch Events and then pass them onto the Input Manager for further processing.\r\rYou 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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputManager" } }, "description": "A reference to the Input Manager.", "name": "inputManager" } ], "scope": "static", "longname": "Phaser.Input.Touch.TouchManager", "___id": "T000002R024280", "___s": true }, { "comment": "/**\r\n * A reference to the Input Manager.\r\n *\r\n * @name Phaser.Input.Touch.TouchManager#manager\r\n * @type {Phaser.Input.InputManager}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 36, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "A reference to the Input Manager.", "name": "manager", "type": { "names": [ "Phaser.Input.InputManager" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Input.InputManager" } }, "since": "3.0.0", "memberof": "Phaser.Input.Touch.TouchManager", "longname": "Phaser.Input.Touch.TouchManager#manager", "scope": "instance", "kind": "member", "___id": "T000002R024283", "___s": true }, { "comment": "/**\r\n * If true the DOM events will have event.preventDefault applied to them, if false they will propagate fully.\r\n *\r\n * @name Phaser.Input.Touch.TouchManager#capture\r\n * @type {boolean}\r\n * @default true\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 45, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "If true the DOM events will have event.preventDefault applied to them, if false they will propagate fully.", "name": "capture", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "true", "since": "3.0.0", "memberof": "Phaser.Input.Touch.TouchManager", "longname": "Phaser.Input.Touch.TouchManager#capture", "scope": "instance", "kind": "member", "___id": "T000002R024285", "___s": true }, { "comment": "/**\r\n * A boolean that controls if the Touch Manager is enabled or not.\r\n * Can be toggled on the fly.\r\n *\r\n * @name Phaser.Input.Touch.TouchManager#enabled\r\n * @type {boolean}\r\n * @default false\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 55, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "A boolean that controls if the Touch Manager is enabled or not.\rCan be toggled on the fly.", "name": "enabled", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "defaultvalue": "false", "since": "3.0.0", "memberof": "Phaser.Input.Touch.TouchManager", "longname": "Phaser.Input.Touch.TouchManager#enabled", "scope": "instance", "kind": "member", "___id": "T000002R024287", "___s": true }, { "comment": "/**\r\n * The Touch Event target, as defined in the Game Config.\r\n * Typically the canvas to which the game is rendering, but can be any interactive DOM element.\r\n *\r\n * @name Phaser.Input.Touch.TouchManager#target\r\n * @type {any}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 66, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "The Touch Event target, as defined in the Game Config.\rTypically the canvas to which the game is rendering, but can be any interactive DOM element.", "name": "target", "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "since": "3.0.0", "memberof": "Phaser.Input.Touch.TouchManager", "longname": "Phaser.Input.Touch.TouchManager#target", "scope": "instance", "kind": "member", "___id": "T000002R024289", "___s": true }, { "comment": "/**\r\n * The Touch Start event handler function.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Touch.TouchManager#onTouchStart\r\n * @type {function}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 76, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "The Touch Start event handler function.\rInitially empty and bound in the `startListeners` method.", "name": "onTouchStart", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.0.0", "memberof": "Phaser.Input.Touch.TouchManager", "longname": "Phaser.Input.Touch.TouchManager#onTouchStart", "scope": "instance", "kind": "member", "___id": "T000002R024291", "___s": true }, { "comment": "/**\r\n * The Touch Start event handler function specifically for events on the Window.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Touch.TouchManager#onTouchStartWindow\r\n * @type {function}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 86, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "The Touch Start event handler function specifically for events on the Window.\rInitially empty and bound in the `startListeners` method.", "name": "onTouchStartWindow", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.17.0", "memberof": "Phaser.Input.Touch.TouchManager", "longname": "Phaser.Input.Touch.TouchManager#onTouchStartWindow", "scope": "instance", "kind": "member", "___id": "T000002R024293", "___s": true }, { "comment": "/**\r\n * The Touch Move event handler function.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Touch.TouchManager#onTouchMove\r\n * @type {function}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 96, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "The Touch Move event handler function.\rInitially empty and bound in the `startListeners` method.", "name": "onTouchMove", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.0.0", "memberof": "Phaser.Input.Touch.TouchManager", "longname": "Phaser.Input.Touch.TouchManager#onTouchMove", "scope": "instance", "kind": "member", "___id": "T000002R024295", "___s": true }, { "comment": "/**\r\n * The Touch End event handler function.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Touch.TouchManager#onTouchEnd\r\n * @type {function}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 106, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "The Touch End event handler function.\rInitially empty and bound in the `startListeners` method.", "name": "onTouchEnd", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.0.0", "memberof": "Phaser.Input.Touch.TouchManager", "longname": "Phaser.Input.Touch.TouchManager#onTouchEnd", "scope": "instance", "kind": "member", "___id": "T000002R024297", "___s": true }, { "comment": "/**\r\n * The Touch End event handler function specifically for events on the Window.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Touch.TouchManager#onTouchEndWindow\r\n * @type {function}\r\n * @since 3.17.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "The Touch End event handler function specifically for events on the Window.\rInitially empty and bound in the `startListeners` method.", "name": "onTouchEndWindow", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.17.0", "memberof": "Phaser.Input.Touch.TouchManager", "longname": "Phaser.Input.Touch.TouchManager#onTouchEndWindow", "scope": "instance", "kind": "member", "___id": "T000002R024299", "___s": true }, { "comment": "/**\r\n * The Touch Cancel event handler function.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Touch.TouchManager#onTouchCancel\r\n * @type {function}\r\n * @since 3.15.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "The Touch Cancel event handler function.\rInitially empty and bound in the `startListeners` method.", "name": "onTouchCancel", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.15.0", "memberof": "Phaser.Input.Touch.TouchManager", "longname": "Phaser.Input.Touch.TouchManager#onTouchCancel", "scope": "instance", "kind": "member", "___id": "T000002R024301", "___s": true }, { "comment": "/**\r\n * The Touch Cancel event handler function specifically for events on the Window.\r\n * Initially empty and bound in the `startListeners` method.\r\n *\r\n * @name Phaser.Input.Touch.TouchManager#onTouchCancelWindow\r\n * @type {function}\r\n * @since 3.18.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 136, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "The Touch Cancel event handler function specifically for events on the Window.\rInitially empty and bound in the `startListeners` method.", "name": "onTouchCancelWindow", "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "since": "3.18.0", "memberof": "Phaser.Input.Touch.TouchManager", "longname": "Phaser.Input.Touch.TouchManager#onTouchCancelWindow", "scope": "instance", "kind": "member", "___id": "T000002R024303", "___s": true }, { "comment": "/**\r\n * Are the event listeners hooked into `window.top` or `window`?\r\n *\r\n * This is set during the `boot` sequence. If the browser does not have access to `window.top`,\r\n * such as in cross-origin iframe environments, this property gets set to `false` and the events\r\n * are hooked into `window` instead.\r\n *\r\n * @name Phaser.Input.Touch.TouchManager#isTop\r\n * @type {boolean}\r\n * @readonly\r\n * @since 3.60.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 146, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "Are the event listeners hooked into `window.top` or `window`?\r\rThis is set during the `boot` sequence. If the browser does not have access to `window.top`,\rsuch as in cross-origin iframe environments, this property gets set to `false` and the events\rare hooked into `window` instead.", "name": "isTop", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "readonly": true, "since": "3.60.0", "memberof": "Phaser.Input.Touch.TouchManager", "longname": "Phaser.Input.Touch.TouchManager#isTop", "scope": "instance", "kind": "member", "___id": "T000002R024305", "___s": true }, { "comment": "/**\r\n * Attempts to disable the context menu from appearing if you touch-hold on the browser.\r\n *\r\n * Works by listening for the `contextmenu` event and calling `preventDefault()` on it.\r\n *\r\n * Use this if you need to disable the OS context menu on mobile.\r\n *\r\n * @method Phaser.Input.Touch.TouchManager#disableContextMenu\r\n * @since 3.20.0\r\n *\r\n * @return {this} This Touch Manager instance.\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 198, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "Attempts to disable the context menu from appearing if you touch-hold on the browser.\r\rWorks by listening for the `contextmenu` event and calling `preventDefault()` on it.\r\rUse this if you need to disable the OS context menu on mobile.", "kind": "function", "name": "disableContextMenu", "since": "3.20.0", "returns": [ { "type": { "names": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "This Touch Manager instance." } ], "memberof": "Phaser.Input.Touch.TouchManager", "longname": "Phaser.Input.Touch.TouchManager#disableContextMenu", "scope": "instance", "___id": "T000002R024315", "___s": true }, { "comment": "/**\r\n * Starts the Touch Event listeners running as long as an input target is set.\r\n *\r\n * This method is called automatically if Touch Input is enabled in the game config,\r\n * which it is by default. However, you can call it manually should you need to\r\n * delay input capturing until later in the game.\r\n *\r\n * @method Phaser.Input.Touch.TouchManager#startListeners\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 221, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "Starts the Touch Event listeners running as long as an input target is set.\r\rThis method is called automatically if Touch Input is enabled in the game config,\rwhich it is by default. However, you can call it manually should you need to\rdelay 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", "___id": "T000002R024317", "___s": true }, { "comment": "/**\r\n * Stops the Touch Event listeners.\r\n * This is called automatically and does not need to be manually invoked.\r\n *\r\n * @method Phaser.Input.Touch.TouchManager#stopListeners\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 358, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "description": "Stops the Touch Event listeners.\rThis 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", "___id": "T000002R024338", "___s": true }, { "comment": "/**\r\n * Destroys this Touch Manager instance.\r\n *\r\n * @method Phaser.Input.Touch.TouchManager#destroy\r\n * @since 3.0.0\r\n */", "meta": { "filename": "TouchManager.js", "lineno": 384, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\input\\touch", "code": {} }, "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", "___id": "T000002R024342", "___s": true }, { "comment": "/**\r\n * A Phaser Input Event Data object.\r\n *\r\n * This object is passed to the registered event listeners and allows you to stop any further propagation.\r\n *\r\n * @typedef {object} Phaser.Types.Input.EventData\r\n * @since 3.15.1\r\n *\r\n * @property {boolean} [cancelled=false] - The cancelled state of this Event.\r\n * @property {function} stopPropagation - Call this method to stop this event from passing any further down the event chain.\r\n */", "meta": { "filename": "EventData.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\typedefs", "code": {} }, "description": "A Phaser Input Event Data object.\r\rThis object is passed to the registered event listeners and allows you to stop any further propagation.", "kind": "typedef", "name": "EventData", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.15.1", "properties": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "The cancelled state of this Event.", "name": "cancelled" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "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", "___id": "T000002R024348", "___s": true }, { "comment": "/**\r\n * @callback Phaser.Types.Input.HitAreaCallback\r\n * @since 3.0.0\r\n *\r\n * @param {any} hitArea - The hit area object.\r\n * @param {number} x - The translated x coordinate of the hit test event.\r\n * @param {number} y - The translated y coordinate of the hit test event.\r\n * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that invoked the hit test.\r\n *\r\n * @return {boolean} `true` if the coordinates fall within the space of the hitArea, otherwise `false`.\r\n */", "meta": { "filename": "HitAreaCallback.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\typedefs", "code": {} }, "kind": "typedef", "name": "HitAreaCallback", "type": { "names": [ "function" ] }, "since": "3.0.0", "params": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "description": "The hit area object.", "name": "hitArea" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The translated x coordinate of the hit test event.", "name": "x" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The translated y coordinate of the hit test event.", "name": "y" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object that invoked the hit test.", "name": "gameObject" } ], "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024349", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Types.Input\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\typedefs", "code": {} }, "kind": "namespace", "name": "Input", "memberof": "Phaser.Types", "longname": "Phaser.Types.Input", "scope": "static", "___id": "T000002R024350", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Input.InputConfiguration\r\n * @since 3.0.0\r\n *\r\n * @property {any} [hitArea] - The object / shape to use as the Hit Area. If not given it will try to create a Rectangle based on the texture frame.\r\n * @property {Phaser.Types.Input.HitAreaCallback} [hitAreaCallback] - The callback that determines if the pointer is within the Hit Area shape or not.\r\n * @property {boolean} [draggable=false] - If `true` the Interactive Object will be set to be draggable and emit drag events.\r\n * @property {boolean} [dropZone=false] - If `true` the Interactive Object will be set to be a drop zone for draggable objects.\r\n * @property {boolean} [useHandCursor=false] - 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'`.\r\n * @property {string} [cursor] - The CSS string to be used when the cursor is over this Interactive Object.\r\n * @property {boolean} [pixelPerfect=false] - If `true` a pixel perfect function will be set for the hit area callback. Only works with image texture based Game Objects, not Render Textures.\r\n * @property {number} [alphaTolerance=1] - If `pixelPerfect` is set, this is the alpha tolerance threshold value used in the callback. A value of 255 will match only fully opaque pixels.\r\n */", "meta": { "filename": "InputConfiguration.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\typedefs", "code": {} }, "kind": "typedef", "name": "InputConfiguration", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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": [ "Phaser.Types.Input.HitAreaCallback" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Input.HitAreaCallback" } }, "optional": true, "description": "The callback that determines if the pointer is within the Hit Area shape or not.", "name": "hitAreaCallback" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "optional": true, "description": "The CSS string to be used when the cursor is over this Interactive Object.", "name": "cursor" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "optional": true, "defaultvalue": false, "description": "If `true` a pixel perfect function will be set for the hit area callback. Only works with image texture based Game Objects, not Render Textures.", "name": "pixelPerfect" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "optional": true, "defaultvalue": 1, "description": "If `pixelPerfect` is set, this is the alpha tolerance threshold value used in the callback. A value of 255 will match only fully opaque pixels.", "name": "alphaTolerance" } ], "memberof": "Phaser.Types.Input", "longname": "Phaser.Types.Input.InputConfiguration", "scope": "static", "___id": "T000002R024351", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Input.InputPluginContainer\r\n * @since 3.0.0\r\n *\r\n * @property {string} key - The unique name of this plugin in the input plugin cache.\r\n * @property {function} plugin - The plugin to be stored. Should be the source object, not instantiated.\r\n * @property {string} [mapping] - If this plugin is to be injected into the Input Plugin, this is the property key map used.\r\n */", "meta": { "filename": "InputPluginContainer.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\typedefs", "code": {} }, "kind": "typedef", "name": "InputPluginContainer", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique name of this plugin in the input plugin cache.", "name": "key" }, { "type": { "names": [ "function" ], "parsedType": { "type": "FunctionType", "params": [] } }, "description": "The plugin to be stored. Should be the source object, not instantiated.", "name": "plugin" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024352", "___s": true }, { "comment": "/**\r\n * @typedef {object} Phaser.Types.Input.InteractiveObject\r\n * @since 3.0.0\r\n *\r\n * @property {Phaser.GameObjects.GameObject} gameObject - The Game Object to which this Interactive Object is bound.\r\n * @property {boolean} enabled - Is this Interactive Object currently enabled for input events?\r\n * @property {boolean} draggable - Is this Interactive Object draggable? Enable with `InputPlugin.setDraggable`.\r\n * @property {boolean} dropZone - Is this Interactive Object a drag-targets drop zone? Set when the object is created.\r\n * @property {(boolean|string)} cursor - Should this Interactive Object change the cursor (via css) when over? (desktop only)\r\n * @property {?Phaser.GameObjects.GameObject} target - An optional drop target for a draggable Interactive Object.\r\n * @property {Phaser.Cameras.Scene2D.Camera} camera - The most recent Camera to be tested against this Interactive Object.\r\n * @property {any} hitArea - The hit area for this Interactive Object. Typically a geometry shape, like a Rectangle or Circle.\r\n * @property {Phaser.Types.Input.HitAreaCallback} hitAreaCallback - The 'contains' check callback that the hit area shape will use for all hit tests.\r\n * @property {Phaser.GameObjects.Shape} hitAreaDebug - If this Interactive Object has been enabled for debug, via `InputPlugin.enableDebug` then this property holds its debug shape.\r\n * @property {boolean} customHitArea - Was the hitArea for this Interactive Object created based on texture size (false), or a custom shape? (true)\r\n * @property {number} localX - The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.\r\n * @property {number} localY - The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.\r\n * @property {(0|1|2)} dragState - The current drag state of this Interactive Object. 0 = Not being dragged, 1 = being checked for drag, or 2 = being actively dragged.\r\n * @property {number} dragStartX - The x coordinate of the Game Object that owns this Interactive Object when the drag started.\r\n * @property {number} dragStartY - The y coordinate of the Game Object that owns this Interactive Object when the drag started.\r\n * @property {number} dragStartXGlobal - The x coordinate that the Pointer started dragging this Interactive Object from.\r\n * @property {number} dragStartYGlobal - The y coordinate that the Pointer started dragging this Interactive Object from.\r\n * @property {number} dragX - The x coordinate that this Interactive Object is currently being dragged to.\r\n * @property {number} dragY - The y coordinate that this Interactive Object is currently being dragged to.\r\n */", "meta": { "filename": "InteractiveObject.js", "lineno": 1, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\input\\typedefs", "code": {} }, "kind": "typedef", "name": "InteractiveObject", "type": { "names": [ "object" ], "parsedType": { "type": "NameExpression", "name": "object" } }, "since": "3.0.0", "properties": [ { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject" } }, "description": "The Game Object to which this Interactive Object is bound.", "name": "gameObject" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this Interactive Object currently enabled for input events?", "name": "enabled" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this Interactive Object draggable? Enable with `InputPlugin.setDraggable`.", "name": "draggable" }, { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "Is this Interactive Object a drag-targets drop zone? Set when the object is created.", "name": "dropZone" }, { "type": { "names": [ "boolean", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "boolean" }, { "type": "NameExpression", "name": "string" } ] } }, "description": "Should this Interactive Object change the cursor (via css) when over? (desktop only)", "name": "cursor" }, { "type": { "names": [ "Phaser.GameObjects.GameObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.GameObjects.GameObject", "nullable": true } }, "nullable": true, "description": "An optional drop target for a draggable Interactive Object.", "name": "target" }, { "type": { "names": [ "Phaser.Cameras.Scene2D.Camera" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Cameras.Scene2D.Camera" } }, "description": "The most recent Camera to be tested against this Interactive Object.", "name": "camera" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "0" }, { "type": "NameExpression", "name": "1" }, { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate of the Game Object that owns this Interactive Object when the drag started.", "name": "dragStartX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate of the Game Object that owns this Interactive Object when the drag started.", "name": "dragStartY" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate that the Pointer started dragging this Interactive Object from.", "name": "dragStartXGlobal" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The y coordinate that the Pointer started dragging this Interactive Object from.", "name": "dragStartYGlobal" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The x coordinate that this Interactive Object is currently being dragged to.", "name": "dragX" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024353", "___s": true }, { "comment": "/**\r\n * The Loader is idle.\r\n *\r\n * @name Phaser.Loader.LOADER_IDLE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 9, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The Loader is idle.", "name": "LOADER_IDLE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.LOADER_IDLE", "scope": "static", "kind": "member", "___id": "T000002R024355", "___s": true }, { "comment": "/**\r\n * The Loader is actively loading.\r\n *\r\n * @name Phaser.Loader.LOADER_LOADING\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 18, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The Loader is actively loading.", "name": "LOADER_LOADING", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.LOADER_LOADING", "scope": "static", "kind": "member", "___id": "T000002R024357", "___s": true }, { "comment": "/**\r\n * The Loader is processing files it has loaded.\r\n *\r\n * @name Phaser.Loader.LOADER_PROCESSING\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 27, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The Loader is processing files it has loaded.", "name": "LOADER_PROCESSING", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.LOADER_PROCESSING", "scope": "static", "kind": "member", "___id": "T000002R024359", "___s": true }, { "comment": "/**\r\n * The Loader has completed loading and processing.\r\n *\r\n * @name Phaser.Loader.LOADER_COMPLETE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 36, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The Loader has completed loading and processing.", "name": "LOADER_COMPLETE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.LOADER_COMPLETE", "scope": "static", "kind": "member", "___id": "T000002R024361", "___s": true }, { "comment": "/**\r\n * The Loader is shutting down.\r\n *\r\n * @name Phaser.Loader.LOADER_SHUTDOWN\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 45, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The Loader is shutting down.", "name": "LOADER_SHUTDOWN", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.LOADER_SHUTDOWN", "scope": "static", "kind": "member", "___id": "T000002R024363", "___s": true }, { "comment": "/**\r\n * The Loader has been destroyed.\r\n *\r\n * @name Phaser.Loader.LOADER_DESTROYED\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 54, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The Loader has been destroyed.", "name": "LOADER_DESTROYED", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.LOADER_DESTROYED", "scope": "static", "kind": "member", "___id": "T000002R024365", "___s": true }, { "comment": "/**\r\n * File is in the load queue but not yet started.\r\n *\r\n * @name Phaser.Loader.FILE_PENDING\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 63, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "File is in the load queue but not yet started.", "name": "FILE_PENDING", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.FILE_PENDING", "scope": "static", "kind": "member", "___id": "T000002R024367", "___s": true }, { "comment": "/**\r\n * File has started loading by the loader (onLoad called).\r\n *\r\n * @name Phaser.Loader.FILE_LOADING\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 72, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "File has started loading by the loader (onLoad called).", "name": "FILE_LOADING", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.FILE_LOADING", "scope": "static", "kind": "member", "___id": "T000002R024369", "___s": true }, { "comment": "/**\r\n * File has loaded successfully, awaiting processing.\r\n *\r\n * @name Phaser.Loader.FILE_LOADED\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 81, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "File has loaded successfully, awaiting processing.", "name": "FILE_LOADED", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.FILE_LOADED", "scope": "static", "kind": "member", "___id": "T000002R024371", "___s": true }, { "comment": "/**\r\n * File failed to load.\r\n *\r\n * @name Phaser.Loader.FILE_FAILED\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 90, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "File failed to load.", "name": "FILE_FAILED", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.FILE_FAILED", "scope": "static", "kind": "member", "___id": "T000002R024373", "___s": true }, { "comment": "/**\r\n * File is being processed (onProcess callback).\r\n *\r\n * @name Phaser.Loader.FILE_PROCESSING\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 99, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "File is being processed (onProcess callback).", "name": "FILE_PROCESSING", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.FILE_PROCESSING", "scope": "static", "kind": "member", "___id": "T000002R024375", "___s": true }, { "comment": "/**\r\n * The file encountered an error during processing.\r\n *\r\n * @name Phaser.Loader.FILE_ERRORED\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 108, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The file encountered an error during processing.", "name": "FILE_ERRORED", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.FILE_ERRORED", "scope": "static", "kind": "member", "___id": "T000002R024377", "___s": true }, { "comment": "/**\r\n * File has finished processing.\r\n *\r\n * @name Phaser.Loader.FILE_COMPLETE\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 117, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "File has finished processing.", "name": "FILE_COMPLETE", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.FILE_COMPLETE", "scope": "static", "kind": "member", "___id": "T000002R024379", "___s": true }, { "comment": "/**\r\n * File has been destroyed.\r\n *\r\n * @name Phaser.Loader.FILE_DESTROYED\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 126, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "File has been destroyed.", "name": "FILE_DESTROYED", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.FILE_DESTROYED", "scope": "static", "kind": "member", "___id": "T000002R024381", "___s": true }, { "comment": "/**\r\n * File was populated from local data and doesn't need an HTTP request.\r\n *\r\n * @name Phaser.Loader.FILE_POPULATED\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "const.js", "lineno": 135, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "File was populated from local data and doesn't need an HTTP request.", "name": "FILE_POPULATED", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.FILE_POPULATED", "scope": "static", "kind": "member", "___id": "T000002R024383", "___s": true }, { "comment": "/**\r\n * File is pending destruction.\r\n *\r\n * @name Phaser.Loader.FILE_PENDING_DESTROY\r\n * @type {number}\r\n * @since 3.60.0\r\n */", "meta": { "filename": "const.js", "lineno": 144, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "File is pending destruction.", "name": "FILE_PENDING_DESTROY", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.60.0", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.FILE_PENDING_DESTROY", "scope": "static", "kind": "member", "___id": "T000002R024385", "___s": true }, { "comment": "/**\r\n * The Loader Plugin Add File Event.\r\n *\r\n * This event is dispatched when a new file is successfully added to the Loader and placed into the load queue.\r\n *\r\n * Listen to it from a Scene using: `this.load.on('addfile', listener)`.\r\n *\r\n * If you add lots of files to a Loader from a `preload` method, it will dispatch this event for each one of them.\r\n *\r\n * @event Phaser.Loader.Events#ADD\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The unique key of the file that was added to the Loader.\r\n * @param {string} type - The [file type]{@link Phaser.Loader.File#type} string of the file that was added to the Loader, i.e. `image`.\r\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader Plugin that dispatched this event.\r\n * @param {Phaser.Loader.File} file - A reference to the File which was added to the Loader.\r\n */", "meta": { "filename": "ADD_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\events", "code": {} }, "description": "The Loader Plugin Add File Event.\r\rThis event is dispatched when a new file is successfully added to the Loader and placed into the load queue.\r\rListen to it from a Scene using: `this.load.on('addfile', listener)`.\r\rIf 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The unique key of the file that was added to the Loader.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "description": "A reference to the Loader Plugin that dispatched this event.", "name": "loader" }, { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024388", "___s": true }, { "comment": "/**\r\n * The Loader Plugin Complete Event.\r\n *\r\n * This event is dispatched when the Loader has fully processed everything in the load queue.\r\n * By this point every loaded file will now be in its associated cache and ready for use.\r\n *\r\n * Listen to it from a Scene using: `this.load.on('complete', listener)`.\r\n *\r\n * @event Phaser.Loader.Events#COMPLETE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader Plugin that dispatched this event.\r\n * @param {number} totalComplete - The total number of files that successfully loaded.\r\n * @param {number} totalFailed - The total number of files that failed to load.\r\n */", "meta": { "filename": "COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\events", "code": {} }, "description": "The Loader Plugin Complete Event.\r\rThis event is dispatched when the Loader has fully processed everything in the load queue.\rBy this point every loaded file will now be in its associated cache and ready for use.\r\rListen to it from a Scene using: `this.load.on('complete', listener)`.", "kind": "event", "name": "COMPLETE", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "description": "A reference to the Loader Plugin that dispatched this event.", "name": "loader" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of files that successfully loaded.", "name": "totalComplete" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "description": "The total number of files that failed to load.", "name": "totalFailed" } ], "memberof": "Phaser.Loader.Events", "longname": "Phaser.Loader.Events#event:COMPLETE", "scope": "instance", "___id": "T000002R024390", "___s": true }, { "comment": "/**\r\n * The File Load Complete Event.\r\n *\r\n * This event is dispatched by the Loader Plugin when _any_ file in the queue finishes loading.\r\n *\r\n * Listen to it from a Scene using: `this.load.on('filecomplete', listener)`.\r\n *\r\n * Make sure you remove this listener when you have finished, or it will continue to fire if the Scene reloads.\r\n *\r\n * You can also listen for the completion of a specific file. See the [FILE_KEY_COMPLETE]{@linkcode Phaser.Loader.Events#event:FILE_KEY_COMPLETE} event.\r\n *\r\n * @event Phaser.Loader.Events#FILE_COMPLETE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key of the file that just loaded and finished processing.\r\n * @param {string} type - The [file type]{@link Phaser.Loader.File#type} of the file that just loaded, i.e. `image`.\r\n * @param {any} [data] - The raw data the file contained. If the file was a multi-file, like an atlas or bitmap font, this parameter will be undefined.\r\n */", "meta": { "filename": "FILE_COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\events", "code": {} }, "description": "The File Load Complete Event.\r\rThis event is dispatched by the Loader Plugin when _any_ file in the queue finishes loading.\r\rListen to it from a Scene using: `this.load.on('filecomplete', listener)`.\r\rMake sure you remove this listener when you have finished, or it will continue to fire if the Scene reloads.\r\rYou 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file that just loaded and finished processing.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The [file type]{@link Phaser.Loader.File#type} of the file that just loaded, i.e. `image`.", "name": "type" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The raw data the file contained. If the file was a multi-file, like an atlas or bitmap font, this parameter will be undefined.", "name": "data" } ], "memberof": "Phaser.Loader.Events", "longname": "Phaser.Loader.Events#event:FILE_COMPLETE", "scope": "instance", "___id": "T000002R024392", "___s": true }, { "comment": "/**\r\n * The File Load Complete Event.\r\n *\r\n * This event is dispatched by the Loader Plugin when any file in the queue finishes loading.\r\n *\r\n * It uses a special dynamic event name constructed from the key and type of the file.\r\n *\r\n * For example, if you have loaded an `image` with a key of `monster`, you can listen for it\r\n * using the following:\r\n *\r\n * ```javascript\r\n * this.load.on('filecomplete-image-monster', function (key, type, data) {\r\n * // Your handler code\r\n * });\r\n * ```\r\n *\r\n * Or, if you have loaded a texture `atlas` with a key of `Level1`:\r\n *\r\n * ```javascript\r\n * this.load.on('filecomplete-atlasjson-Level1', function (key, type, data) {\r\n * // Your handler code\r\n * });\r\n * ```\r\n *\r\n * Or, if you have loaded a sprite sheet with a key of `Explosion` and a prefix of `GAMEOVER`:\r\n *\r\n * ```javascript\r\n * this.load.on('filecomplete-spritesheet-GAMEOVERExplosion', function (key, type, data) {\r\n * // Your handler code\r\n * });\r\n * ```\r\n *\r\n * Make sure you remove your listeners when you have finished, or they will continue to fire if the Scene reloads.\r\n *\r\n * You can also listen for the generic completion of files. See the [FILE_COMPLETE]{@linkcode Phaser.Loader.Events#event:FILE_COMPLETE} event.\r\n *\r\n * @event Phaser.Loader.Events#FILE_KEY_COMPLETE\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {string} key - The key of the file that just loaded and finished processing.\r\n * @param {string} type - The [file type]{@link Phaser.Loader.File#type} of the file that just loaded, i.e. `image`.\r\n * @param {any} [data] - The raw data the file contained. If the file was a multi-file, like an atlas or bitmap font, this parameter will be undefined.\r\n */", "meta": { "filename": "FILE_KEY_COMPLETE_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\events", "code": {} }, "description": "The File Load Complete Event.\r\rThis event is dispatched by the Loader Plugin when any file in the queue finishes loading.\r\rIt uses a special dynamic event name constructed from the key and type of the file.\r\rFor example, if you have loaded an `image` with a key of `monster`, you can listen for it\rusing the following:\r\r```javascript\rthis.load.on('filecomplete-image-monster', function (key, type, data) {\r // Your handler code\r});\r```\r\rOr, if you have loaded a texture `atlas` with a key of `Level1`:\r\r```javascript\rthis.load.on('filecomplete-atlasjson-Level1', function (key, type, data) {\r // Your handler code\r});\r```\r\rOr, if you have loaded a sprite sheet with a key of `Explosion` and a prefix of `GAMEOVER`:\r\r```javascript\rthis.load.on('filecomplete-spritesheet-GAMEOVERExplosion', function (key, type, data) {\r // Your handler code\r});\r```\r\rMake sure you remove your listeners when you have finished, or they will continue to fire if the Scene reloads.\r\rYou 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", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key of the file that just loaded and finished processing.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The [file type]{@link Phaser.Loader.File#type} of the file that just loaded, i.e. `image`.", "name": "type" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The raw data the file contained. If the file was a multi-file, like an atlas or bitmap font, this parameter will be undefined.", "name": "data" } ], "memberof": "Phaser.Loader.Events", "longname": "Phaser.Loader.Events#event:FILE_KEY_COMPLETE", "scope": "instance", "___id": "T000002R024394", "___s": true }, { "comment": "/**\r\n * The File Load Error Event.\r\n *\r\n * This event is dispatched by the Loader Plugin when a file fails to load.\r\n *\r\n * Listen to it from a Scene using: `this.load.on('loaderror', listener)`.\r\n *\r\n * @event Phaser.Loader.Events#FILE_LOAD_ERROR\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.File} file - A reference to the File which errored during load.\r\n */", "meta": { "filename": "FILE_LOAD_ERROR_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\events", "code": {} }, "description": "The File Load Error Event.\r\rThis event is dispatched by the Loader Plugin when a file fails to load.\r\rListen to it from a Scene using: `this.load.on('loaderror', listener)`.", "kind": "event", "name": "FILE_LOAD_ERROR", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024396", "___s": true }, { "comment": "/**\r\n * The File Load Event.\r\n *\r\n * This event is dispatched by the Loader Plugin when a file finishes loading,\r\n * but _before_ it is processed and added to the internal Phaser caches.\r\n *\r\n * Listen to it from a Scene using: `this.load.on('load', listener)`.\r\n *\r\n * @event Phaser.Loader.Events#FILE_LOAD\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.File} file - A reference to the File which just finished loading.\r\n */", "meta": { "filename": "FILE_LOAD_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\events", "code": {} }, "description": "The File Load Event.\r\rThis event is dispatched by the Loader Plugin when a file finishes loading,\rbut _before_ it is processed and added to the internal Phaser caches.\r\rListen to it from a Scene using: `this.load.on('load', listener)`.", "kind": "event", "name": "FILE_LOAD", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024398", "___s": true }, { "comment": "/**\r\n * The File Load Progress Event.\r\n *\r\n * This event is dispatched by the Loader Plugin during the load of a file, if the browser receives a DOM ProgressEvent and\r\n * the `lengthComputable` event property is true. Depending on the size of the file and browser in use, this may, or may not happen.\r\n *\r\n * Listen to it from a Scene using: `this.load.on('fileprogress', listener)`.\r\n *\r\n * @event Phaser.Loader.Events#FILE_PROGRESS\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.File} file - A reference to the File for which progress has been updated.\r\n * @param {number} percentComplete - A value between 0 and 1 indicating how 'complete' this file is.\r\n */", "meta": { "filename": "FILE_PROGRESS_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\events", "code": {} }, "description": "The File Load Progress Event.\r\rThis event is dispatched by the Loader Plugin during the load of a file, if the browser receives a DOM ProgressEvent and\rthe `lengthComputable` event property is true. Depending on the size of the file and browser in use, this may, or may not happen.\r\rListen to it from a Scene using: `this.load.on('fileprogress', listener)`.", "kind": "event", "name": "FILE_PROGRESS", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "A reference to the File for which progress has been updated.", "name": "file" }, { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024400", "___s": true }, { "comment": "/**\r\n * @namespace Phaser.Loader.Events\r\n */", "meta": { "filename": "index.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\events", "code": {} }, "kind": "namespace", "name": "Events", "memberof": "Phaser.Loader", "longname": "Phaser.Loader.Events", "scope": "static", "___id": "T000002R024402", "___s": true }, { "comment": "/**\r\n * The Loader Plugin Post Process Event.\r\n *\r\n * This event is dispatched by the Loader Plugin when the Loader has finished loading everything in the load queue.\r\n * It is dispatched before the internal lists are cleared and each File is destroyed.\r\n *\r\n * Use this hook to perform any last minute processing of files that can only happen once the\r\n * Loader has completed, but prior to it emitting the `complete` event.\r\n *\r\n * Listen to it from a Scene using: `this.load.on('postprocess', listener)`.\r\n *\r\n * @event Phaser.Loader.Events#POST_PROCESS\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader Plugin that dispatched this event.\r\n */", "meta": { "filename": "POST_PROCESS_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\events", "code": {} }, "description": "The Loader Plugin Post Process Event.\r\rThis event is dispatched by the Loader Plugin when the Loader has finished loading everything in the load queue.\rIt is dispatched before the internal lists are cleared and each File is destroyed.\r\rUse this hook to perform any last minute processing of files that can only happen once the\rLoader has completed, but prior to it emitting the `complete` event.\r\rListen to it from a Scene using: `this.load.on('postprocess', listener)`.", "kind": "event", "name": "POST_PROCESS", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024414", "___s": true }, { "comment": "/**\r\n * The Loader Plugin Progress Event.\r\n *\r\n * This event is dispatched when the Loader updates its load progress, typically as a result of a file having completed loading.\r\n *\r\n * Listen to it from a Scene using: `this.load.on('progress', listener)`.\r\n *\r\n * @event Phaser.Loader.Events#PROGRESS\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {number} progress - The current progress of the load. A value between 0 and 1.\r\n */", "meta": { "filename": "PROGRESS_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\events", "code": {} }, "description": "The Loader Plugin Progress Event.\r\rThis event is dispatched when the Loader updates its load progress, typically as a result of a file having completed loading.\r\rListen to it from a Scene using: `this.load.on('progress', listener)`.", "kind": "event", "name": "PROGRESS", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024416", "___s": true }, { "comment": "/**\r\n * The Loader Plugin Start Event.\r\n *\r\n * This event is dispatched when the Loader starts running. At this point load progress is zero.\r\n *\r\n * This event is dispatched even if there aren't any files in the load queue.\r\n *\r\n * Listen to it from a Scene using: `this.load.on('start', listener)`.\r\n *\r\n * @event Phaser.Loader.Events#START\r\n * @type {string}\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader Plugin that dispatched this event.\r\n */", "meta": { "filename": "START_EVENT.js", "lineno": 7, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\events", "code": {} }, "description": "The Loader Plugin Start Event.\r\rThis event is dispatched when the Loader starts running. At this point load progress is zero.\r\rThis event is dispatched even if there aren't any files in the load queue.\r\rListen to it from a Scene using: `this.load.on('start', listener)`.", "kind": "event", "name": "START", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024418", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * The base File class used by all File Types that the Loader can support. It manages the lifecycle\r\n * of a single file from queue to download to processing to completion, handling XHR configuration,\r\n * URL resolution, progress tracking, and error states. You should not create an instance of a File\r\n * directly, but should extend it with your own class, setting a custom type and overriding the\r\n * `onProcess` method to handle the loaded data. See `Phaser.Loader.FileTypes` for built-in file\r\n * type examples.\r\n *\r\n * @class File\r\n * @memberof Phaser.Loader\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - The Loader that is going to load this File.\r\n * @param {Phaser.Types.Loader.FileConfig} fileConfig - The file configuration object, as created by the file type.\r\n */", "meta": { "filename": "File.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "classdesc": "The base File class used by all File Types that the Loader can support. It manages the lifecycle\rof a single file from queue to download to processing to completion, handling XHR configuration,\rURL resolution, progress tracking, and error states. You should not create an instance of a File\rdirectly, but should extend it with your own class, setting a custom type and overriding the\r`onProcess` method to handle the loaded data. See `Phaser.Loader.FileTypes` for built-in file\rtype examples.", "kind": "class", "name": "File", "memberof": "Phaser.Loader", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "description": "The Loader that is going to load this File.", "name": "loader" }, { "type": { "names": [ "Phaser.Types.Loader.FileConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileConfig" } }, "description": "The file configuration object, as created by the file type.", "name": "fileConfig" } ], "scope": "static", "longname": "Phaser.Loader.File", "___id": "T000002R024428", "___s": true }, { "comment": "/**\r\n * A reference to the Loader that is going to load this file.\r\n *\r\n * @name Phaser.Loader.File#loader\r\n * @type {Phaser.Loader.LoaderPlugin}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 39, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "A reference to the Loader that is going to load this file.", "name": "loader", "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#loader", "scope": "instance", "kind": "member", "___id": "T000002R024431", "___s": true }, { "comment": "/**\r\n * A reference to the Cache, or Texture Manager, that is going to store this file if it loads.\r\n *\r\n * @name Phaser.Loader.File#cache\r\n * @type {(Phaser.Cache.BaseCache|Phaser.Textures.TextureManager)}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "File.js", "lineno": 48, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Cache.BaseCache" }, { "type": "NameExpression", "name": "Phaser.Textures.TextureManager" } ] } }, "since": "3.7.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#cache", "scope": "instance", "kind": "member", "___id": "T000002R024433", "___s": true }, { "comment": "/**\r\n * The file type string (image, json, etc) for sorting within the Loader.\r\n *\r\n * @name Phaser.Loader.File#type\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 57, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The file type string (image, json, etc) for sorting within the Loader.", "name": "type", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#type", "scope": "instance", "kind": "member", "___id": "T000002R024435", "___s": true }, { "comment": "/**\r\n * Unique cache key (unique within its file type)\r\n *\r\n * @name Phaser.Loader.File#key\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 71, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Unique cache key (unique within its file type)", "name": "key", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#key", "scope": "instance", "kind": "member", "___id": "T000002R024437", "___s": true }, { "comment": "/**\r\n * The URL of the file, not including baseURL.\r\n *\r\n * Automatically has Loader.path prepended to it if a string.\r\n *\r\n * Can also be a JavaScript Object, such as the results of parsing JSON data.\r\n *\r\n * @name Phaser.Loader.File#url\r\n * @type {object|string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 103, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The URL of the file, not including baseURL.\r\rAutomatically has Loader.path prepended to it if a string.\r\rCan also be a JavaScript Object, such as the results of parsing JSON data.", "name": "url", "type": { "names": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "string" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#url", "scope": "instance", "kind": "member", "___id": "T000002R024444", "___s": true }, { "comment": "/**\r\n * The final URL this file will load from, including baseURL and path.\r\n * Set automatically when the Loader calls 'load' on this file.\r\n *\r\n * @name Phaser.Loader.File#src\r\n * @type {string}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 116, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The final URL this file will load from, including baseURL and path.\rSet automatically when the Loader calls 'load' on this file.", "name": "src", "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#src", "scope": "instance", "kind": "member", "___id": "T000002R024446", "___s": true }, { "comment": "/**\r\n * The merged XHRSettings for this file.\r\n *\r\n * @name Phaser.Loader.File#xhrSettings\r\n * @type {Phaser.Types.Loader.XHRSettingsObject}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 126, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The merged XHRSettings for this file.", "name": "xhrSettings", "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#xhrSettings", "scope": "instance", "kind": "member", "___id": "T000002R024448", "___s": true }, { "comment": "/**\r\n * The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.\r\n *\r\n * @name Phaser.Loader.File#xhrLoader\r\n * @type {?XMLHttpRequest}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 140, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.", "name": "xhrLoader", "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest", "nullable": true } }, "nullable": true, "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#xhrLoader", "scope": "instance", "kind": "member", "___id": "T000002R024451", "___s": true }, { "comment": "/**\r\n * The current state of the file. One of the FILE_CONST values.\r\n *\r\n * @name Phaser.Loader.File#state\r\n * @type {number}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 149, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The current state of the file. One of the FILE_CONST values.", "name": "state", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#state", "scope": "instance", "kind": "member", "___id": "T000002R024453", "___s": true }, { "comment": "/**\r\n * The total size of this file.\r\n * Set by onProgress and only if loading via XHR.\r\n *\r\n * @name Phaser.Loader.File#bytesTotal\r\n * @type {number}\r\n * @default 0\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 158, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The total size of this file.\rSet by onProgress and only if loading via XHR.", "name": "bytesTotal", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "0", "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#bytesTotal", "scope": "instance", "kind": "member", "___id": "T000002R024455", "___s": true }, { "comment": "/**\r\n * Updated as the file loads.\r\n * Only set if loading via XHR.\r\n *\r\n * @name Phaser.Loader.File#bytesLoaded\r\n * @type {number}\r\n * @default -1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 169, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Updated as the file loads.\rOnly set if loading via XHR.", "name": "bytesLoaded", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#bytesLoaded", "scope": "instance", "kind": "member", "___id": "T000002R024457", "___s": true }, { "comment": "/**\r\n * A percentage value between 0 and 1 indicating how much of this file has loaded.\r\n * Only set if loading via XHR.\r\n *\r\n * @name Phaser.Loader.File#percentComplete\r\n * @type {number}\r\n * @default -1\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 180, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "A percentage value between 0 and 1 indicating how much of this file has loaded.\rOnly set if loading via XHR.", "name": "percentComplete", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "-1", "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#percentComplete", "scope": "instance", "kind": "member", "___id": "T000002R024459", "___s": true }, { "comment": "/**\r\n * For CORS based loading.\r\n * If this is undefined then the File will check LoaderPlugin.crossOrigin and use that (if set)\r\n *\r\n * @name Phaser.Loader.File#crossOrigin\r\n * @type {(string|undefined)}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 191, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "For CORS based loading.\rIf this is undefined then the File will check LoaderPlugin.crossOrigin and use that (if set)", "name": "crossOrigin", "type": { "names": [ "string", "undefined" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "UndefinedLiteral" } ] } }, "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#crossOrigin", "scope": "instance", "kind": "member", "___id": "T000002R024461", "___s": true }, { "comment": "/**\r\n * The processed file data, stored here after the file has loaded.\r\n *\r\n * @name Phaser.Loader.File#data\r\n * @type {*}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 201, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The processed file data, stored here after the file has loaded.", "name": "data", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#data", "scope": "instance", "kind": "member", "___id": "T000002R024463", "___s": true }, { "comment": "/**\r\n * A config object that can be used by file types to store transitional data.\r\n *\r\n * @name Phaser.Loader.File#config\r\n * @type {*}\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 210, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "A config object that can be used by file types to store transitional data.", "name": "config", "type": { "names": [ "*" ], "parsedType": { "type": "AllLiteral" } }, "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#config", "scope": "instance", "kind": "member", "___id": "T000002R024465", "___s": true }, { "comment": "/**\r\n * If this is a multipart file, i.e. an atlas and its json together, then this is a reference\r\n * to the parent MultiFile. Set and used internally by the Loader or specific file types.\r\n *\r\n * @name Phaser.Loader.File#multiFile\r\n * @type {?Phaser.Loader.MultiFile}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "File.js", "lineno": 219, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "If this is a multipart file, i.e. an atlas and its json together, then this is a reference\rto the parent MultiFile. Set and used internally by the Loader or specific file types.", "name": "multiFile", "type": { "names": [ "Phaser.Loader.MultiFile" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.MultiFile", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#multiFile", "scope": "instance", "kind": "member", "___id": "T000002R024467", "___s": true }, { "comment": "/**\r\n * Does this file have an associated linked file? Such as an image and a normal map.\r\n * Atlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\r\n * actually bound by data, where-as a linkFile is.\r\n *\r\n * @name Phaser.Loader.File#linkFile\r\n * @type {?Phaser.Loader.File}\r\n * @since 3.7.0\r\n */", "meta": { "filename": "File.js", "lineno": 229, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Does this file have an associated linked file? Such as an image and a normal map.\rAtlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't\ractually bound by data, where-as a linkFile is.", "name": "linkFile", "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File", "nullable": true } }, "nullable": true, "since": "3.7.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#linkFile", "scope": "instance", "kind": "member", "___id": "T000002R024469", "___s": true }, { "comment": "/**\r\n * Does this File contain a data URI?\r\n *\r\n * @name Phaser.Loader.File#base64\r\n * @type {boolean}\r\n * @since 3.80.0\r\n */", "meta": { "filename": "File.js", "lineno": 240, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Does this File contain a data URI?", "name": "base64", "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "since": "3.80.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#base64", "scope": "instance", "kind": "member", "___id": "T000002R024471", "___s": true }, { "comment": "/**\r\n * The counter for the number of times to retry loading this file before it fails.\r\n * \r\n * You can set this property value in the FileConfig object. If not present,\r\n * this property is read from the `LoaderPlugin.maxRetries` property when\r\n * this File instance is created.\r\n * \r\n * You can set this value via the Game Config, or you can adjust the `LoaderPlugin` property\r\n * at any point after the Loader has started. However, it will not apply to files\r\n * that have already been added to the Loader, only those added after this value\r\n * is changed.\r\n *\r\n * @name Phaser.Loader.File#retryAttempts\r\n * @type {number}\r\n * @default 2\r\n * @since 3.85.0\r\n */", "meta": { "filename": "File.js", "lineno": 249, "columnno": 8, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "The counter for the number of times to retry loading this file before it fails.\r\rYou can set this property value in the FileConfig object. If not present,\rthis property is read from the `LoaderPlugin.maxRetries` property when\rthis File instance is created.\r\rYou can set this value via the Game Config, or you can adjust the `LoaderPlugin` property\rat any point after the Loader has started. However, it will not apply to files\rthat have already been added to the Loader, only those added after this value\ris changed.", "name": "retryAttempts", "type": { "names": [ "number" ], "parsedType": { "type": "NameExpression", "name": "number" } }, "defaultvalue": "2", "since": "3.85.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#retryAttempts", "scope": "instance", "kind": "member", "___id": "T000002R024473", "___s": true }, { "comment": "/**\r\n * Links this File with another, so they depend upon each other for loading and processing.\r\n *\r\n * @method Phaser.Loader.File#setLink\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} fileB - The file to link to this one.\r\n */", "meta": { "filename": "File.js", "lineno": 269, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The file to link to this one.", "name": "fileB" } ], "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#setLink", "scope": "instance", "___id": "T000002R024475", "___s": true }, { "comment": "/**\r\n * Clears the `onload`, `onerror`, and `onprogress` event handlers from the XHRLoader instance\r\n * this file is using, preventing stale callbacks from firing after the load has completed or errored.\r\n *\r\n * @method Phaser.Loader.File#resetXHR\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 284, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Clears the `onload`, `onerror`, and `onprogress` event handlers from the XHRLoader instance\rthis file is using, preventing stale callbacks from firing after the load has completed or errored.", "kind": "function", "name": "resetXHR", "since": "3.0.0", "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#resetXHR", "scope": "instance", "___id": "T000002R024479", "___s": true }, { "comment": "/**\r\n * Called by the Loader, starts the actual file downloading.\r\n * During the load the methods onLoad, onError and onProgress are called, based on the XHR events.\r\n * You shouldn't normally call this method directly, it's meant to be invoked by the Loader.\r\n *\r\n * @method Phaser.Loader.File#load\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 301, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Called by the Loader, starts the actual file downloading.\rDuring the load the methods onLoad, onError and onProgress are called, based on the XHR events.\rYou 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", "___id": "T000002R024484", "___s": true }, { "comment": "/**\r\n * Called when the file finishes loading, is sent a DOM ProgressEvent.\r\n *\r\n * @method Phaser.Loader.File#onLoad\r\n * @since 3.0.0\r\n *\r\n * @param {XMLHttpRequest} xhr - The XMLHttpRequest that caused this onload event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this load.\r\n */", "meta": { "filename": "File.js", "lineno": 336, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Called when the file finishes loading, is sent a DOM ProgressEvent.", "kind": "function", "name": "onLoad", "since": "3.0.0", "params": [ { "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest" } }, "description": "The XMLHttpRequest that caused this onload event.", "name": "xhr" }, { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent that resulted from this load.", "name": "event" } ], "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#onLoad", "scope": "instance", "___id": "T000002R024490", "___s": true }, { "comment": "/**\r\n * Called by the XHRLoader if it was given a File with base64 data to load.\r\n *\r\n * @method Phaser.Loader.File#onBase64Load\r\n * @since 3.80.0\r\n *\r\n * @param {XMLHttpRequest} xhr - The FakeXHR object containing the decoded base64 data.\r\n */", "meta": { "filename": "File.js", "lineno": 369, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Called by the XHRLoader if it was given a File with base64 data to load.", "kind": "function", "name": "onBase64Load", "since": "3.80.0", "params": [ { "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest" } }, "description": "The FakeXHR object containing the decoded base64 data.", "name": "xhr" } ], "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#onBase64Load", "scope": "instance", "___id": "T000002R024497", "___s": true }, { "comment": "/**\r\n * Called if the file errors while loading. Resets the XHR state, then either decrements\r\n * `retryAttempts` and retries the load, or signals failure to the Loader via `nextFile`\r\n * if no retry attempts remain.\r\n *\r\n * @method Phaser.Loader.File#onError\r\n * @since 3.0.0\r\n *\r\n * @param {XMLHttpRequest} xhr - The XMLHttpRequest that caused this onerror event.\r\n * @param {ProgressEvent} event - The DOM ProgressEvent that resulted from this error.\r\n */", "meta": { "filename": "File.js", "lineno": 390, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Called if the file errors while loading. Resets the XHR state, then either decrements\r`retryAttempts` and retries the load, or signals failure to the Loader via `nextFile`\rif no retry attempts remain.", "kind": "function", "name": "onError", "since": "3.0.0", "params": [ { "type": { "names": [ "XMLHttpRequest" ], "parsedType": { "type": "NameExpression", "name": "XMLHttpRequest" } }, "description": "The XMLHttpRequest that caused this onerror event.", "name": "xhr" }, { "type": { "names": [ "ProgressEvent" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent that resulted from this error.", "name": "event" } ], "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#onError", "scope": "instance", "___id": "T000002R024502", "___s": true }, { "comment": "/**\r\n * Called during the file load progress. Is sent a DOM ProgressEvent.\r\n *\r\n * @method Phaser.Loader.File#onProgress\r\n * @fires Phaser.Loader.Events#FILE_PROGRESS\r\n * @since 3.0.0\r\n *\r\n * @param {ProgressEvent} event - The DOM ProgressEvent.\r\n */", "meta": { "filename": "File.js", "lineno": 417, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "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" ], "parsedType": { "type": "NameExpression", "name": "ProgressEvent" } }, "description": "The DOM ProgressEvent.", "name": "event" } ], "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#onProgress", "scope": "instance", "___id": "T000002R024504", "___s": true }, { "comment": "/**\r\n * Usually overridden by the FileTypes and is called by Loader.nextFile.\r\n * This method controls what extra work this File does with its loaded data, for example a JSON file will parse itself during this stage.\r\n *\r\n * @method Phaser.Loader.File#onProcess\r\n * @since 3.0.0\r\n */", "meta": { "filename": "File.js", "lineno": 439, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Usually overridden by the FileTypes and is called by Loader.nextFile.\rThis 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", "___id": "T000002R024509", "___s": true }, { "comment": "/**\r\n * Called when the File has completed processing.\r\n * Checks on the state of its multifile, if set.\r\n *\r\n * @method Phaser.Loader.File#onProcessComplete\r\n * @since 3.7.0\r\n */", "meta": { "filename": "File.js", "lineno": 453, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Called when the File has completed processing.\rChecks 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", "___id": "T000002R024512", "___s": true }, { "comment": "/**\r\n * Called when the File has completed processing but it generated an error.\r\n * Checks on the state of its multifile, if set.\r\n *\r\n * @method Phaser.Loader.File#onProcessError\r\n * @since 3.7.0\r\n */", "meta": { "filename": "File.js", "lineno": 472, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Called when the File has completed processing but it generated an error.\rChecks 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", "___id": "T000002R024515", "___s": true }, { "comment": "/**\r\n * Checks if a key matching the one used by this file exists in the target Cache or not.\r\n * This is called automatically by the LoaderPlugin to decide if the file can be safely\r\n * loaded or will conflict.\r\n *\r\n * @method Phaser.Loader.File#hasCacheConflict\r\n * @since 3.7.0\r\n *\r\n * @return {boolean} `true` if adding this file will cause a conflict, otherwise `false`.\r\n */", "meta": { "filename": "File.js", "lineno": 494, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Checks if a key matching the one used by this file exists in the target Cache or not.\rThis is called automatically by the LoaderPlugin to decide if the file can be safely\rloaded or will conflict.", "kind": "function", "name": "hasCacheConflict", "since": "3.7.0", "returns": [ { "type": { "names": [ "boolean" ], "parsedType": { "type": "NameExpression", "name": "boolean" } }, "description": "`true` if adding this file will cause a conflict, otherwise `false`." } ], "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File#hasCacheConflict", "scope": "instance", "___id": "T000002R024518", "___s": true }, { "comment": "/**\r\n * Adds this file to its target cache upon successful loading and processing.\r\n * This method is often overridden by specific file types.\r\n *\r\n * @method Phaser.Loader.File#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "File.js", "lineno": 509, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Adds this file to its target cache upon successful loading and processing.\rThis 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", "___id": "T000002R024520", "___s": true }, { "comment": "/**\r\n * Called once the file has been added to its cache and is now ready for deletion from the Loader.\r\n * It will emit a `filecomplete` event from the LoaderPlugin.\r\n *\r\n * @method Phaser.Loader.File#pendingDestroy\r\n * @fires Phaser.Loader.Events#FILE_COMPLETE\r\n * @fires Phaser.Loader.Events#FILE_KEY_COMPLETE\r\n * @since 3.7.0\r\n */", "meta": { "filename": "File.js", "lineno": 524, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Called once the file has been added to its cache and is now ready for deletion from the Loader.\rIt 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", "___id": "T000002R024522", "___s": true }, { "comment": "/**\r\n * Destroy this File and any references it holds.\r\n *\r\n * @method Phaser.Loader.File#destroy\r\n * @since 3.7.0\r\n */", "meta": { "filename": "File.js", "lineno": 553, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "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", "___id": "T000002R024528", "___s": true }, { "comment": "/**\r\n * Static method for creating an object URL using the URL API and setting it as the image 'src' attribute.\r\n * If the URL API is not supported (usually on old browsers) it falls back to creating a Base64 encoded URL using FileReader.\r\n *\r\n * @method Phaser.Loader.File.createObjectURL\r\n * @static\r\n * @since 3.7.0\r\n *\r\n * @param {HTMLImageElement} image - Image object which 'src' attribute should be set to object URL.\r\n * @param {Blob} blob - A Blob object to create an object URL for.\r\n * @param {string} defaultType - Default mime type used if blob type is not available.\r\n */", "meta": { "filename": "File.js", "lineno": 571, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Static method for creating an object URL using the URL API and setting it as the image 'src' attribute.\rIf the URL API is not supported (usually on old browsers) it falls back to creating a Base64 encoded URL using FileReader.", "kind": "function", "name": "createObjectURL", "scope": "static", "since": "3.7.0", "params": [ { "type": { "names": [ "HTMLImageElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLImageElement" } }, "description": "Image object which 'src' attribute should be set to object URL.", "name": "image" }, { "type": { "names": [ "Blob" ], "parsedType": { "type": "NameExpression", "name": "Blob" } }, "description": "A Blob object to create an object URL for.", "name": "blob" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "Default mime type used if blob type is not available.", "name": "defaultType" } ], "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File.createObjectURL", "___id": "T000002R024536", "___s": true }, { "comment": "/**\r\n * Static method for releasing an existing object URL which was previously created\r\n * by calling {@link Phaser.Loader.File.createObjectURL} method.\r\n *\r\n * @method Phaser.Loader.File.revokeObjectURL\r\n * @static\r\n * @since 3.7.0\r\n *\r\n * @param {HTMLImageElement} image - Image object which 'src' attribute should be revoked.\r\n */", "meta": { "filename": "File.js", "lineno": 605, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader", "code": {} }, "description": "Static method for releasing an existing object URL which was previously created\rby calling {@link Phaser.Loader.File.createObjectURL} method.", "kind": "function", "name": "revokeObjectURL", "scope": "static", "since": "3.7.0", "params": [ { "type": { "names": [ "HTMLImageElement" ], "parsedType": { "type": "NameExpression", "name": "HTMLImageElement" } }, "description": "Image object which 'src' attribute should be revoked.", "name": "image" } ], "memberof": "Phaser.Loader.File", "longname": "Phaser.Loader.File.revokeObjectURL", "___id": "T000002R024543", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Animation JSON File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#animation method and are not typically created directly.\r\n *\r\n * For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#animation.\r\n *\r\n * @class AnimationJSONFile\r\n * @extends Phaser.Loader.File\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.\r\n * @param {(string|Phaser.Types.Loader.FileTypes.JSONFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {string} [url] - 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\".\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n * @param {string} [dataKey] - When the JSON file loads only this property will be stored in the Cache.\r\n */", "meta": { "filename": "AnimationJSONFile.js", "lineno": 12, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Animation JSON File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#animation method and are not typically created directly.\r\rFor 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.JSONFileConfig" } ] } }, "description": "The key to use for this file, or a file configuration object.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024550", "___s": true }, { "comment": "/**\r\n * Called automatically by Loader.nextFile.\r\n * This method controls what extra work this File does with its loaded data.\r\n *\r\n * @method Phaser.Loader.FileTypes.AnimationJSONFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "AnimationJSONFile.js", "lineno": 48, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Called automatically by Loader.nextFile.\rThis 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", "___id": "T000002R024555", "___s": true }, { "comment": "/**\r\n * Called at the end of the load process, after the Loader has finished all files in its queue.\r\n *\r\n * @method Phaser.Loader.FileTypes.AnimationJSONFile#onLoadComplete\r\n * @since 3.7.0\r\n */", "meta": { "filename": "AnimationJSONFile.js", "lineno": 64, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "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", "___id": "T000002R024557", "___s": true }, { "comment": "/**\r\n * Adds an Animation JSON Data file, or array of Animation JSON files, to the current load queue.\r\n *\r\n * You can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.animation('baddieAnims', 'files/BaddieAnims.json');\r\n * }\r\n * ```\r\n *\r\n * The file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\r\n * or if it's already running, when the next free load slot becomes available. This happens automatically if you\r\n * are calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\r\n * it means you cannot use the file immediately after calling this method, but must wait for the file to complete.\r\n * The typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\r\n * Scene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\r\n * loaded.\r\n *\r\n * If you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\r\n * its events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\r\n *\r\n * The key must be a unique String. It is used to add the file to the global JSON Cache upon a successful load.\r\n * The key should be unique both in terms of files being loaded and files already present in the JSON Cache.\r\n * Loading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\r\n * then remove it from the JSON Cache first, before loading a new one.\r\n *\r\n * Instead of passing arguments you can pass a configuration object, such as:\r\n *\r\n * ```javascript\r\n * this.load.animation({\r\n * key: 'baddieAnims',\r\n * url: 'files/BaddieAnims.json'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.JSONFileConfig` for more details.\r\n *\r\n * Once the file has finished loading it will automatically be passed to the global Animation Manager's `fromJSON` method.\r\n * This will parse all of the JSON data and create animation data from it. This process happens at the very end\r\n * of the Loader, once every other file in the load queue has finished. The reason for this is to allow you to load\r\n * both animation data and the images it relies upon in the same load call.\r\n *\r\n * Once the animation data has been parsed you will be able to play animations using that data.\r\n * Please see the Animation Manager `fromJSON` method for more details about the format and playback.\r\n *\r\n * You can also access the raw animation data from its Cache using its key:\r\n *\r\n * ```javascript\r\n * this.load.animation('baddieAnims', 'files/BaddieAnims.json');\r\n * // and later in your game ...\r\n * var data = this.cache.json.get('baddieAnims');\r\n * ```\r\n *\r\n * If you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\r\n * key. For example, if the prefix was `LEVEL1.` and the key was `Waves` the final key will be `LEVEL1.Waves` and\r\n * this is what you would use to retrieve the text from the JSON Cache.\r\n *\r\n * The URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\n *\r\n * If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"data\"\r\n * and no URL is given then the Loader will set the URL to be \"data.json\". It will always add `.json` as the extension, although\r\n * this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\r\n *\r\n * You 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,\r\n * rather than the whole file. For example, if your JSON data had a structure like this:\r\n *\r\n * ```json\r\n * {\r\n * \"level1\": {\r\n * \"baddies\": {\r\n * \"aliens\": {},\r\n * \"boss\": {}\r\n * }\r\n * },\r\n * \"level2\": {},\r\n * \"level3\": {}\r\n * }\r\n * ```\r\n *\r\n * And if you only wanted to create animations from the `boss` data, then you could pass `level1.baddies.boss` as the `dataKey`.\r\n *\r\n * Note: The ability to load this type of file will only be available if the JSON File type has been built into Phaser.\r\n * It is available in the default build but can be excluded from custom builds.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#animation\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.JSONFileConfig|Phaser.Types.Loader.FileTypes.JSONFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {string} [url] - 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\".\r\n * @param {string} [dataKey] - When the Animation JSON file loads only this property will be stored in the Cache and used to create animation data.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.\r\n *\r\n * @return {this} The Loader instance.\r\n */", "meta": { "filename": "AnimationJSONFile.js", "lineno": 77, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds an Animation JSON Data file, or array of Animation JSON files, to the current load queue.\r\rYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\r```javascript\rfunction preload ()\r{\r this.load.animation('baddieAnims', 'files/BaddieAnims.json');\r}\r```\r\rThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\ror if it's already running, when the next free load slot becomes available. This happens automatically if you\rare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\rit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\rThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\rScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\rloaded.\r\rIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\rits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\r\rThe key must be a unique String. It is used to add the file to the global JSON Cache upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the JSON Cache.\rLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\rthen remove it from the JSON Cache first, before loading a new one.\r\rInstead of passing arguments you can pass a configuration object, such as:\r\r```javascript\rthis.load.animation({\r key: 'baddieAnims',\r url: 'files/BaddieAnims.json'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.JSONFileConfig` for more details.\r\rOnce the file has finished loading it will automatically be passed to the global Animation Manager's `fromJSON` method.\rThis will parse all of the JSON data and create animation data from it. This process happens at the very end\rof the Loader, once every other file in the load queue has finished. The reason for this is to allow you to load\rboth animation data and the images it relies upon in the same load call.\r\rOnce the animation data has been parsed you will be able to play animations using that data.\rPlease see the Animation Manager `fromJSON` method for more details about the format and playback.\r\rYou can also access the raw animation data from its Cache using its key:\r\r```javascript\rthis.load.animation('baddieAnims', 'files/BaddieAnims.json');\r// and later in your game ...\rvar data = this.cache.json.get('baddieAnims');\r```\r\rIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\rkey. For example, if the prefix was `LEVEL1.` and the key was `Waves` the final key will be `LEVEL1.Waves` and\rthis is what you would use to retrieve the text from the JSON Cache.\r\rThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\rIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"data\"\rand no URL is given then the Loader will set the URL to be \"data.json\". It will always add `.json` as the extension, although\rthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\r\rYou 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,\rrather than the whole file. For example, if your JSON data had a structure like this:\r\r```json\r{\r \"level1\": {\r \"baddies\": {\r \"aliens\": {},\r \"boss\": {}\r }\r },\r \"level2\": {},\r \"level3\": {}\r}\r```\r\rAnd if you only wanted to create animations from the `boss` data, then you could pass `level1.baddies.boss` as the `dataKey`.\r\rNote: The ability to load this type of file will only be available if the JSON File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "animation", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.JSONFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.JSONFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.JSONFileConfig", "type": "NameExpression" } ] } ] } }, "description": "The key to use for this file, or a file configuration object, or array of them.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Loader instance." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#animation", "scope": "instance", "___id": "T000002R024559", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Aseprite Animation File suitable for loading by the Loader.\r\n *\r\n * Aseprite is an animated sprite editor and pixel art tool. This file type handles loading both\r\n * the Aseprite sprite sheet image and its accompanying JSON data file, which contains frame and\r\n * animation tag information. Once loaded, the texture and animation data are added to the Texture\r\n * Manager and can be used to create animations via `AnimationManager.createFromAseprite`.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#aseprite method and are not typically created directly.\r\n *\r\n * For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#aseprite.\r\n *\r\n * @class AsepriteFile\r\n * @extends Phaser.Loader.MultiFile\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.50.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.\r\n * @param {(string|Phaser.Types.Loader.FileTypes.AsepriteFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {string|string[]} [textureURL] - 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\".\r\n * @param {object|string} [atlasURL] - 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\". Or, a well formed JSON object.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - An XHR Settings configuration object for the atlas json file. Used in replacement of the Loaders default XHR Settings.\r\n */", "meta": { "filename": "AsepriteFile.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Aseprite Animation File suitable for loading by the Loader.\r\rAseprite is an animated sprite editor and pixel art tool. This file type handles loading both\rthe Aseprite sprite sheet image and its accompanying JSON data file, which contains frame and\ranimation tag information. Once loaded, the texture and animation data are added to the Texture\rManager and can be used to create animations via `AnimationManager.createFromAseprite`.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#aseprite method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#aseprite.", "kind": "class", "name": "AsepriteFile", "augments": [ "Phaser.Loader.MultiFile" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.50.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "description": "A reference to the Loader that is responsible for this file.", "name": "loader" }, { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.AsepriteFileConfig" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AsepriteFileConfig" } ] } }, "description": "The key to use for this file, or a file configuration object.", "name": "key" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "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": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "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\". Or, a well formed JSON object.", "name": "atlasURL" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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.AsepriteFile", "___id": "T000002R024569", "___s": true }, { "comment": "/**\r\n * Adds this file to its target cache upon successful loading and processing.\r\n *\r\n * @method Phaser.Loader.FileTypes.AsepriteFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "AsepriteFile.js", "lineno": 90, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "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.AsepriteFile", "longname": "Phaser.Loader.FileTypes.AsepriteFile#addToCache", "scope": "instance", "___id": "T000002R024590", "___s": true }, { "comment": "/**\r\n * Aseprite is a powerful animated sprite editor and pixel art tool.\r\n *\r\n * You can find more details at https://www.aseprite.org/\r\n *\r\n * Adds a JSON based Aseprite Animation, or array of animations, to the current load queue.\r\n *\r\n * You can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.aseprite('gladiator', 'images/Gladiator.png', 'images/Gladiator.json');\r\n * }\r\n * ```\r\n *\r\n * The file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\r\n * or if it's already running, when the next free load slot becomes available. This happens automatically if you\r\n * are calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\r\n * it means you cannot use the file immediately after calling this method, but must wait for the file to complete.\r\n * The typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\r\n * Scene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\r\n * loaded.\r\n *\r\n * If you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\r\n * its events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\r\n *\r\n * To export a compatible JSON file in Aseprite, please do the following:\r\n *\r\n * 1. Go to \"File - Export Sprite Sheet\"\r\n *\r\n * 2. On the **Layout** tab:\r\n * 2a. Set the \"Sheet type\" to \"Packed\"\r\n * 2b. Set the \"Constraints\" to \"None\"\r\n * 2c. Check the \"Merge Duplicates\" checkbox\r\n *\r\n * 3. On the **Sprite** tab:\r\n * 3a. Set \"Layers\" to \"Visible layers\"\r\n * 3b. Set \"Frames\" to \"All frames\", unless you only wish to export a sub-set of tags\r\n *\r\n * 4. On the **Borders** tab:\r\n * 4a. Check the \"Trim Sprite\" and \"Trim Cells\" options\r\n * 4b. Ensure \"Border Padding\", \"Spacing\" and \"Inner Padding\" are all > 0 (1 is usually enough)\r\n *\r\n * 5. On the **Output** tab:\r\n * 5a. Check \"Output File\", give your image a name and make sure you choose \"png files\" as the file type\r\n * 5b. Check \"JSON Data\" and give your json file a name\r\n * 5c. The JSON Data type can be either a Hash or Array, Phaser doesn't mind.\r\n * 5d. Make sure \"Tags\" is checked in the Meta options\r\n * 5e. In the \"Item Filename\" input box, make sure it says just \"{frame}\" and nothing more.\r\n *\r\n * 6. Click export\r\n *\r\n * This was tested with Aseprite 1.2.25.\r\n *\r\n * This will export a png and json file which you can load using the Aseprite Loader.\r\n *\r\n * The key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\r\n * The key should be unique both in terms of files being loaded and files already present in the Texture Manager.\r\n * Loading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\r\n * then remove it from the Texture Manager first, before loading a new one.\r\n *\r\n * Instead of passing arguments you can pass a configuration object, such as:\r\n *\r\n * ```javascript\r\n * this.load.aseprite({\r\n * key: 'gladiator',\r\n * textureURL: 'images/Gladiator.png',\r\n * atlasURL: 'images/Gladiator.json'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.AsepriteFileConfig` for more details.\r\n *\r\n * Instead of passing a URL for the JSON data you can also pass in a well formed JSON object instead.\r\n *\r\n * Once loaded, you can call this method from within a Scene with the 'atlas' key:\r\n *\r\n * ```javascript\r\n * this.anims.createFromAseprite('paladin');\r\n * ```\r\n *\r\n * Any animations defined in the JSON will now be available to use in Phaser and you play them\r\n * via their Tag name. For example, if you have an animation called 'War Cry' on your Aseprite timeline,\r\n * you can play it in Phaser using that Tag name:\r\n *\r\n * ```javascript\r\n * this.add.sprite(400, 300).play('War Cry');\r\n * ```\r\n *\r\n * When calling this method you can optionally provide an array of tag names, and only those animations\r\n * will be created. For example:\r\n *\r\n * ```javascript\r\n * this.anims.createFromAseprite('paladin', [ 'step', 'War Cry', 'Magnum Break' ]);\r\n * ```\r\n *\r\n * This will only create the 3 animations defined. Note that the tag names are case-sensitive.\r\n *\r\n * If you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\r\n * key. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\r\n * this is what you would use to retrieve the image from the Texture Manager.\r\n *\r\n * The URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\n *\r\n * If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\r\n * and no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\r\n * this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\r\n *\r\n * Note: The ability to load this type of file will only be available if the Aseprite File type has been built into Phaser.\r\n * It is available in the default build but can be excluded from custom builds.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#aseprite\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.50.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.AsepriteFileConfig|Phaser.Types.Loader.FileTypes.AsepriteFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {string|string[]} [textureURL] - 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\".\r\n * @param {object|string} [atlasURL] - 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\". Or, a well formed JSON object.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - An XHR Settings configuration object for the atlas json file. Used in replacement of the Loaders default XHR Settings.\r\n *\r\n * @return {this} The Loader instance.\r\n */", "meta": { "filename": "AsepriteFile.js", "lineno": 114, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Aseprite is a powerful animated sprite editor and pixel art tool.\r\rYou can find more details at https://www.aseprite.org/\r\rAdds a JSON based Aseprite Animation, or array of animations, to the current load queue.\r\rYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\r```javascript\rfunction preload ()\r{\r this.load.aseprite('gladiator', 'images/Gladiator.png', 'images/Gladiator.json');\r}\r```\r\rThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\ror if it's already running, when the next free load slot becomes available. This happens automatically if you\rare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\rit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\rThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\rScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\rloaded.\r\rIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\rits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\r\rTo export a compatible JSON file in Aseprite, please do the following:\r\r1. Go to \"File - Export Sprite Sheet\"\r\r2. On the **Layout** tab:\r2a. Set the \"Sheet type\" to \"Packed\"\r2b. Set the \"Constraints\" to \"None\"\r2c. Check the \"Merge Duplicates\" checkbox\r\r3. On the **Sprite** tab:\r3a. Set \"Layers\" to \"Visible layers\"\r3b. Set \"Frames\" to \"All frames\", unless you only wish to export a sub-set of tags\r\r4. On the **Borders** tab:\r4a. Check the \"Trim Sprite\" and \"Trim Cells\" options\r4b. Ensure \"Border Padding\", \"Spacing\" and \"Inner Padding\" are all > 0 (1 is usually enough)\r\r5. On the **Output** tab:\r5a. Check \"Output File\", give your image a name and make sure you choose \"png files\" as the file type\r5b. Check \"JSON Data\" and give your json file a name\r5c. The JSON Data type can be either a Hash or Array, Phaser doesn't mind.\r5d. Make sure \"Tags\" is checked in the Meta options\r5e. In the \"Item Filename\" input box, make sure it says just \"{frame}\" and nothing more.\r\r6. Click export\r\rThis was tested with Aseprite 1.2.25.\r\rThis will export a png and json file which you can load using the Aseprite Loader.\r\rThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\rLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\rthen remove it from the Texture Manager first, before loading a new one.\r\rInstead of passing arguments you can pass a configuration object, such as:\r\r```javascript\rthis.load.aseprite({\r key: 'gladiator',\r textureURL: 'images/Gladiator.png',\r atlasURL: 'images/Gladiator.json'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.AsepriteFileConfig` for more details.\r\rInstead of passing a URL for the JSON data you can also pass in a well formed JSON object instead.\r\rOnce loaded, you can call this method from within a Scene with the 'atlas' key:\r\r```javascript\rthis.anims.createFromAseprite('paladin');\r```\r\rAny animations defined in the JSON will now be available to use in Phaser and you play them\rvia their Tag name. For example, if you have an animation called 'War Cry' on your Aseprite timeline,\ryou can play it in Phaser using that Tag name:\r\r```javascript\rthis.add.sprite(400, 300).play('War Cry');\r```\r\rWhen calling this method you can optionally provide an array of tag names, and only those animations\rwill be created. For example:\r\r```javascript\rthis.anims.createFromAseprite('paladin', [ 'step', 'War Cry', 'Magnum Break' ]);\r```\r\rThis will only create the 3 animations defined. Note that the tag names are case-sensitive.\r\rIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\rkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\rthis is what you would use to retrieve the image from the Texture Manager.\r\rThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\rIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\rand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\rthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\r\rNote: The ability to load this type of file will only be available if the Aseprite File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "aseprite", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.50.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.AsepriteFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AsepriteFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.AsepriteFileConfig", "type": "NameExpression" } ] } ] } }, "description": "The key to use for this file, or a file configuration object, or array of them.", "name": "key" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "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": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "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\". Or, a well formed JSON object.", "name": "atlasURL" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Loader instance." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#aseprite", "scope": "instance", "___id": "T000002R024596", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single JSON based Texture Atlas File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#atlas method and are not typically created directly.\r\n *\r\n * For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#atlas.\r\n *\r\n * {@link https://www.codeandweb.com/texturepacker/tutorials/how-to-create-sprite-sheets-for-phaser3?source=photonstorm|Texture Packer - How to create sprite sheets for Phaser}\r\n *\r\n * @class AtlasJSONFile\r\n * @extends Phaser.Loader.MultiFile\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.\r\n * @param {(string|Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {string|string[]} [textureURL] - 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\".\r\n * @param {object|string} [atlasURL] - 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\". Or, a well formed JSON object.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - An XHR Settings configuration object for the atlas json file. Used in replacement of the Loaders default XHR Settings.\r\n */", "meta": { "filename": "AtlasJSONFile.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single JSON based Texture Atlas File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#atlas method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#atlas.\r\r{@link https://www.codeandweb.com/texturepacker/tutorials/how-to-create-sprite-sheets-for-phaser3?source=photonstorm|Texture Packer - How to create sprite sheets for Phaser}", "kind": "class", "name": "AtlasJSONFile", "augments": [ "Phaser.Loader.MultiFile" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig" } ] } }, "description": "The key to use for this file, or a file configuration object.", "name": "key" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "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": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "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\". Or, a well formed JSON object.", "name": "atlasURL" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024609", "___s": true }, { "comment": "/**\r\n * Adds this file to its target cache upon successful loading and processing.\r\n *\r\n * @method Phaser.Loader.FileTypes.AtlasJSONFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "AtlasJSONFile.js", "lineno": 87, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "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", "___id": "T000002R024630", "___s": true }, { "comment": "/**\r\n * Adds a JSON based Texture Atlas, or array of atlases, to the current load queue.\r\n *\r\n * You can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.atlas('mainmenu', 'images/MainMenu.png', 'images/MainMenu.json');\r\n * }\r\n * ```\r\n *\r\n * The file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\r\n * or if it's already running, when the next free load slot becomes available. This happens automatically if you\r\n * are calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\r\n * it means you cannot use the file immediately after calling this method, but must wait for the file to complete.\r\n * The typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\r\n * Scene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\r\n * loaded.\r\n *\r\n * If you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\r\n * its events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\r\n *\r\n * Phaser expects the atlas data to be provided in a JSON file, using either the JSON Hash or JSON Array format.\r\n *\r\n * These files are created by software such as:\r\n *\r\n * * [Texture Packer](https://www.codeandweb.com/texturepacker/tutorials/how-to-create-sprite-sheets-for-phaser3?source=photonstorm)\r\n * * [Shoebox](https://renderhjs.net/shoebox/)\r\n * * [Gamma Texture Packer](https://gammafp.com/tool/atlas-packer/)\r\n * * [Adobe Flash / Animate](https://www.adobe.com/uk/products/animate.html)\r\n * * [Free Texture Packer](http://free-tex-packer.com/)\r\n * * [Leshy SpriteSheet Tool](https://www.leshylabs.com/apps/sstool/)\r\n *\r\n * If you are using Texture Packer and have enabled multi-atlas support, then please use the Phaser Multi Atlas loader\r\n * instead of this one.\r\n *\r\n * Phaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\r\n *\r\n * The key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\r\n * The key should be unique both in terms of files being loaded and files already present in the Texture Manager.\r\n * Loading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\r\n * then remove it from the Texture Manager first, before loading a new one.\r\n *\r\n * Instead of passing arguments you can pass a configuration object, such as:\r\n *\r\n * ```javascript\r\n * this.load.atlas({\r\n * key: 'mainmenu',\r\n * textureURL: 'images/MainMenu.png',\r\n * atlasURL: 'images/MainMenu.json'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig` for more details.\r\n *\r\n * Instead of passing a URL for the atlas JSON data you can also pass in a well formed JSON object instead.\r\n *\r\n * Once the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:\r\n *\r\n * ```javascript\r\n * this.load.atlas('mainmenu', 'images/MainMenu.png', 'images/MainMenu.json');\r\n * // and later in your game ...\r\n * this.add.image(x, y, 'mainmenu', 'background');\r\n * ```\r\n *\r\n * To get a list of all available frames within an atlas please consult your Texture Atlas software.\r\n *\r\n * If you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\r\n * key. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\r\n * this is what you would use to retrieve the image from the Texture Manager.\r\n *\r\n * The URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\n *\r\n * If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\r\n * and no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\r\n * this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\r\n *\r\n * Phaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\r\n * then you can specify it by providing an array as the `url` where the second element is the normal map:\r\n *\r\n * ```javascript\r\n * this.load.atlas('mainmenu', [ 'images/MainMenu.png', 'images/MainMenu-n.png' ], 'images/MainMenu.json');\r\n * ```\r\n *\r\n * Or, if you are using a config object use the `normalMap` property:\r\n *\r\n * ```javascript\r\n * this.load.atlas({\r\n * key: 'mainmenu',\r\n * textureURL: 'images/MainMenu.png',\r\n * normalMap: 'images/MainMenu-n.png',\r\n * atlasURL: 'images/MainMenu.json'\r\n * });\r\n * ```\r\n *\r\n * The normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORS and XHR Settings.\r\n * Normal maps are a WebGL only feature.\r\n *\r\n * Note: The ability to load this type of file will only be available if the Atlas JSON File type has been built into Phaser.\r\n * It is available in the default build but can be excluded from custom builds.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#atlas\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig|Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {string|string[]} [textureURL] - 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\".\r\n * @param {object|string} [atlasURL] - 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\". Or, a well formed JSON object.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - An XHR Settings configuration object for the atlas json file. Used in replacement of the Loaders default XHR Settings.\r\n *\r\n * @return {this} The Loader instance.\r\n */", "meta": { "filename": "AtlasJSONFile.js", "lineno": 109, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a JSON based Texture Atlas, or array of atlases, to the current load queue.\r\rYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\r```javascript\rfunction preload ()\r{\r this.load.atlas('mainmenu', 'images/MainMenu.png', 'images/MainMenu.json');\r}\r```\r\rThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\ror if it's already running, when the next free load slot becomes available. This happens automatically if you\rare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\rit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\rThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\rScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\rloaded.\r\rIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\rits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\r\rPhaser expects the atlas data to be provided in a JSON file, using either the JSON Hash or JSON Array format.\r\rThese files are created by software such as:\r\r* [Texture Packer](https://www.codeandweb.com/texturepacker/tutorials/how-to-create-sprite-sheets-for-phaser3?source=photonstorm)\r* [Shoebox](https://renderhjs.net/shoebox/)\r* [Gamma Texture Packer](https://gammafp.com/tool/atlas-packer/)\r* [Adobe Flash / Animate](https://www.adobe.com/uk/products/animate.html)\r* [Free Texture Packer](http://free-tex-packer.com/)\r* [Leshy SpriteSheet Tool](https://www.leshylabs.com/apps/sstool/)\r\rIf you are using Texture Packer and have enabled multi-atlas support, then please use the Phaser Multi Atlas loader\rinstead of this one.\r\rPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\r\rThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\rLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\rthen remove it from the Texture Manager first, before loading a new one.\r\rInstead of passing arguments you can pass a configuration object, such as:\r\r```javascript\rthis.load.atlas({\r key: 'mainmenu',\r textureURL: 'images/MainMenu.png',\r atlasURL: 'images/MainMenu.json'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig` for more details.\r\rInstead of passing a URL for the atlas JSON data you can also pass in a well formed JSON object instead.\r\rOnce the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:\r\r```javascript\rthis.load.atlas('mainmenu', 'images/MainMenu.png', 'images/MainMenu.json');\r// and later in your game ...\rthis.add.image(x, y, 'mainmenu', 'background');\r```\r\rTo get a list of all available frames within an atlas please consult your Texture Atlas software.\r\rIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\rkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\rthis is what you would use to retrieve the image from the Texture Manager.\r\rThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\rIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\rand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\rthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\r\rPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\rthen you can specify it by providing an array as the `url` where the second element is the normal map:\r\r```javascript\rthis.load.atlas('mainmenu', [ 'images/MainMenu.png', 'images/MainMenu-n.png' ], 'images/MainMenu.json');\r```\r\rOr, if you are using a config object use the `normalMap` property:\r\r```javascript\rthis.load.atlas({\r key: 'mainmenu',\r textureURL: 'images/MainMenu.png',\r normalMap: 'images/MainMenu-n.png',\r atlasURL: 'images/MainMenu.json'\r});\r```\r\rThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORS and XHR Settings.\rNormal maps are a WebGL only feature.\r\rNote: The ability to load this type of file will only be available if the Atlas JSON File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "atlas", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig", "type": "NameExpression" } ] } ] } }, "description": "The key to use for this file, or a file configuration object, or array of them.", "name": "key" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "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": [ "object", "string" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "object" }, { "type": "NameExpression", "name": "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\". Or, a well formed JSON object.", "name": "atlasURL" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Loader instance." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#atlas", "scope": "instance", "___id": "T000002R024636", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An XML-based Texture Atlas File that coordinates the loading of both a texture image and its associated XML data\r\n * file as a single unit. Both files must load successfully before the atlas is registered with the Texture Manager.\r\n * Once registered, individual frames defined in the XML can be used as textures for Game Objects throughout your game.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#atlasXML method and are not typically created directly.\r\n *\r\n * For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#atlasXML.\r\n *\r\n * @class AtlasXMLFile\r\n * @extends Phaser.Loader.MultiFile\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.\r\n * @param {(string|Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {string|string[]} [textureURL] - 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\".\r\n * @param {string} [atlasURL] - 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\".\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - An XHR Settings configuration object for the atlas xml file. Used in replacement of the Loaders default XHR Settings.\r\n */", "meta": { "filename": "AtlasXMLFile.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "An XML-based Texture Atlas File that coordinates the loading of both a texture image and its associated XML data\rfile as a single unit. Both files must load successfully before the atlas is registered with the Texture Manager.\rOnce registered, individual frames defined in the XML can be used as textures for Game Objects throughout your game.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#atlasXML method and are not typically created directly.\r\rFor 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig" } ] } }, "description": "The key to use for this file, or a file configuration object.", "name": "key" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024649", "___s": true }, { "comment": "/**\r\n * Checks whether both the image and XML data files have finished loading, and if so, registers the texture atlas\r\n * with the Texture Manager. An optional normal map (the third file in the set) is also passed through if present.\r\n * Sets `complete` to `true` once the atlas has been added.\r\n *\r\n * @method Phaser.Loader.FileTypes.AtlasXMLFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "AtlasXMLFile.js", "lineno": 87, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Checks whether both the image and XML data files have finished loading, and if so, registers the texture atlas\rwith the Texture Manager. An optional normal map (the third file in the set) is also passed through if present.\rSets `complete` to `true` once the atlas has been added.", "kind": "function", "name": "addToCache", "since": "3.7.0", "memberof": "Phaser.Loader.FileTypes.AtlasXMLFile", "longname": "Phaser.Loader.FileTypes.AtlasXMLFile#addToCache", "scope": "instance", "___id": "T000002R024670", "___s": true }, { "comment": "/**\r\n * Adds an XML based Texture Atlas, or array of atlases, to the current load queue.\r\n *\r\n * You can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.atlasXML('mainmenu', 'images/MainMenu.png', 'images/MainMenu.xml');\r\n * }\r\n * ```\r\n *\r\n * The file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\r\n * or if it's already running, when the next free load slot becomes available. This happens automatically if you\r\n * are calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\r\n * it means you cannot use the file immediately after calling this method, but must wait for the file to complete.\r\n * The typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\r\n * Scene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\r\n * loaded.\r\n *\r\n * If you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\r\n * its events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\r\n *\r\n * Phaser expects the atlas data to be provided in an XML file format.\r\n * These files are created by software such as Shoebox and Adobe Flash / Animate.\r\n *\r\n * Phaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\r\n *\r\n * The key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\r\n * The key should be unique both in terms of files being loaded and files already present in the Texture Manager.\r\n * Loading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\r\n * then remove it from the Texture Manager first, before loading a new one.\r\n *\r\n * Instead of passing arguments you can pass a configuration object, such as:\r\n *\r\n * ```javascript\r\n * this.load.atlasXML({\r\n * key: 'mainmenu',\r\n * textureURL: 'images/MainMenu.png',\r\n * atlasURL: 'images/MainMenu.xml'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig` for more details.\r\n *\r\n * Once the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:\r\n *\r\n * ```javascript\r\n * this.load.atlasXML('mainmenu', 'images/MainMenu.png', 'images/MainMenu.xml');\r\n * // and later in your game ...\r\n * this.add.image(x, y, 'mainmenu', 'background');\r\n * ```\r\n *\r\n * To get a list of all available frames within an atlas please consult your Texture Atlas software.\r\n *\r\n * If you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\r\n * key. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\r\n * this is what you would use to retrieve the image from the Texture Manager.\r\n *\r\n * The URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\n *\r\n * If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\r\n * and no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\r\n * this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\r\n *\r\n * Phaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\r\n * then you can specify it by providing an array as the `url` where the second element is the normal map:\r\n *\r\n * ```javascript\r\n * this.load.atlasXML('mainmenu', [ 'images/MainMenu.png', 'images/MainMenu-n.png' ], 'images/MainMenu.xml');\r\n * ```\r\n *\r\n * Or, if you are using a config object use the `normalMap` property:\r\n *\r\n * ```javascript\r\n * this.load.atlasXML({\r\n * key: 'mainmenu',\r\n * textureURL: 'images/MainMenu.png',\r\n * normalMap: 'images/MainMenu-n.png',\r\n * atlasURL: 'images/MainMenu.xml'\r\n * });\r\n * ```\r\n *\r\n * The normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORS and XHR Settings.\r\n * Normal maps are a WebGL only feature.\r\n *\r\n * Note: The ability to load this type of file will only be available if the Atlas XML File type has been built into Phaser.\r\n * It is available in the default build but can be excluded from custom builds.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#atlasXML\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.7.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig|Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {string|string[]} [textureURL] - 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\".\r\n * @param {string} [atlasURL] - 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\".\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - An XHR Settings configuration object for the atlas xml file. Used in replacement of the Loaders default XHR Settings.\r\n *\r\n * @return {this} The Loader instance.\r\n */", "meta": { "filename": "AtlasXMLFile.js", "lineno": 111, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds an XML based Texture Atlas, or array of atlases, to the current load queue.\r\rYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\r```javascript\rfunction preload ()\r{\r this.load.atlasXML('mainmenu', 'images/MainMenu.png', 'images/MainMenu.xml');\r}\r```\r\rThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\ror if it's already running, when the next free load slot becomes available. This happens automatically if you\rare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\rit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\rThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\rScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\rloaded.\r\rIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\rits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\r\rPhaser expects the atlas data to be provided in an XML file format.\rThese files are created by software such as Shoebox and Adobe Flash / Animate.\r\rPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\r\rThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\rLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\rthen remove it from the Texture Manager first, before loading a new one.\r\rInstead of passing arguments you can pass a configuration object, such as:\r\r```javascript\rthis.load.atlasXML({\r key: 'mainmenu',\r textureURL: 'images/MainMenu.png',\r atlasURL: 'images/MainMenu.xml'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig` for more details.\r\rOnce the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:\r\r```javascript\rthis.load.atlasXML('mainmenu', 'images/MainMenu.png', 'images/MainMenu.xml');\r// and later in your game ...\rthis.add.image(x, y, 'mainmenu', 'background');\r```\r\rTo get a list of all available frames within an atlas please consult your Texture Atlas software.\r\rIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\rkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\rthis is what you would use to retrieve the image from the Texture Manager.\r\rThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\rIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\rand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\rthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\r\rPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\rthen you can specify it by providing an array as the `url` where the second element is the normal map:\r\r```javascript\rthis.load.atlasXML('mainmenu', [ 'images/MainMenu.png', 'images/MainMenu-n.png' ], 'images/MainMenu.xml');\r```\r\rOr, if you are using a config object use the `normalMap` property:\r\r```javascript\rthis.load.atlasXML({\r key: 'mainmenu',\r textureURL: 'images/MainMenu.png',\r normalMap: 'images/MainMenu-n.png',\r atlasURL: 'images/MainMenu.xml'\r});\r```\r\rThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORS and XHR Settings.\rNormal maps are a WebGL only feature.\r\rNote: The ability to load this type of file will only be available if the Atlas XML File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "atlasXML", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.7.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig", "type": "NameExpression" } ] } ] } }, "description": "The key to use for this file, or a file configuration object, or array of them.", "name": "key" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Loader instance." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#atlasXML", "scope": "instance", "___id": "T000002R024676", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Audio File suitable for loading by the Loader via the Web Audio API.\r\n *\r\n * This file type loads audio data as an ArrayBuffer over XHR and then decodes it into an AudioBuffer\r\n * using the Web Audio API's `decodeAudioData` method. The resulting AudioBuffer is stored in the\r\n * Phaser Audio Cache, ready for use by the Sound Manager.\r\n *\r\n * If the device does not support the Web Audio API, or if Web Audio has been disabled in the game\r\n * configuration, an `HTML5AudioFile` will be created instead. You do not need to choose between them\r\n * manually — use `Phaser.Loader.LoaderPlugin#audio` and Phaser will select the correct file type\r\n * automatically based on device capabilities.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#audio method and are not typically created directly.\r\n *\r\n * For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#audio.\r\n *\r\n * @class AudioFile\r\n * @extends Phaser.Loader.File\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.\r\n * @param {(string|Phaser.Types.Loader.FileTypes.AudioFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {Phaser.Types.Loader.FileTypes.AudioFileURLConfig} [urlConfig] - The absolute or relative URL to load this file from in a config object.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n * @param {AudioContext} [audioContext] - The AudioContext this file will use to process itself.\r\n */", "meta": { "filename": "AudioFile.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Audio File suitable for loading by the Loader via the Web Audio API.\r\rThis file type loads audio data as an ArrayBuffer over XHR and then decodes it into an AudioBuffer\rusing the Web Audio API's `decodeAudioData` method. The resulting AudioBuffer is stored in the\rPhaser Audio Cache, ready for use by the Sound Manager.\r\rIf the device does not support the Web Audio API, or if Web Audio has been disabled in the game\rconfiguration, an `HTML5AudioFile` will be created instead. You do not need to choose between them\rmanually — use `Phaser.Loader.LoaderPlugin#audio` and Phaser will select the correct file type\rautomatically based on device capabilities.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#audio method and are not typically created directly.\r\rFor 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AudioFileConfig" } ] } }, "description": "The key to use for this file, or a file configuration object.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.AudioFileURLConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AudioFileURLConfig" } }, "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" }, { "type": { "names": [ "AudioContext" ], "parsedType": { "type": "NameExpression", "name": "AudioContext" } }, "optional": true, "description": "The AudioContext this file will use to process itself.", "name": "audioContext" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.AudioFile", "___id": "T000002R024689", "___s": true }, { "comment": "/**\r\n * Called automatically by Loader.nextFile.\r\n * This method decodes the raw audio ArrayBuffer loaded via XHR using the Web Audio API's\r\n * `decodeAudioData` method. On success, the resulting AudioBuffer is stored in `this.data`\r\n * and `onProcessComplete` is called to advance the load queue. On failure, an error is logged\r\n * to the console and `onProcessError` is called. The AudioContext reference is released after\r\n * decoding begins to avoid retaining it unnecessarily.\r\n *\r\n * @method Phaser.Loader.FileTypes.AudioFile#onProcess\r\n * @since 3.0.0\r\n */", "meta": { "filename": "AudioFile.js", "lineno": 76, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Called automatically by Loader.nextFile.\rThis method decodes the raw audio ArrayBuffer loaded via XHR using the Web Audio API's\r`decodeAudioData` method. On success, the resulting AudioBuffer is stored in `this.data`\rand `onProcessComplete` is called to advance the load queue. On failure, an error is logged\rto the console and `onProcessError` is called. The AudioContext reference is released after\rdecoding begins to avoid retaining it unnecessarily.", "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", "___id": "T000002R024707", "___s": true }, { "comment": "/**\r\n * Static factory method that creates the correct type of audio file for the current device.\r\n *\r\n * Inspects the game's audio configuration and device capabilities to decide whether to return\r\n * a Web Audio API-based `AudioFile` or a fallback `HTML5AudioFile`. It first calls\r\n * `AudioFile.getAudioURL` to find a suitable URL from the provided list that the browser can\r\n * play. If no compatible URL is found, a warning is logged and `null` is returned.\r\n *\r\n * @function Phaser.Loader.FileTypes.AudioFile.create\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.\r\n * @param {(string|Phaser.Types.Loader.FileTypes.AudioFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {(string|string[]|Phaser.Types.Loader.FileTypes.AudioFileURLConfig|Phaser.Types.Loader.FileTypes.AudioFileURLConfig[])} [urls] - The absolute or relative URL(s) to load the audio from.\r\n * @param {any} [config] - An object containing an `instances` property for HTML5Audio. Defaults to 1.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n *\r\n * @return {?(Phaser.Loader.FileTypes.AudioFile|Phaser.Loader.FileTypes.HTML5AudioFile)} The created audio file instance, or `null` if no supported URL was found.\r\n */", "meta": { "filename": "AudioFile.js", "lineno": 115, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Static factory method that creates the correct type of audio file for the current device.\r\rInspects the game's audio configuration and device capabilities to decide whether to return\ra Web Audio API-based `AudioFile` or a fallback `HTML5AudioFile`. It first calls\r`AudioFile.getAudioURL` to find a suitable URL from the provided list that the browser can\rplay. If no compatible URL is found, a warning is logged and `null` is returned.", "kind": "function", "name": "create", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AudioFileConfig" } ] } }, "description": "The key to use for this file, or a file configuration object.", "name": "key" }, { "type": { "names": [ "string", "Array.", "Phaser.Types.Loader.FileTypes.AudioFileURLConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AudioFileURLConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.AudioFileURLConfig", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The absolute or relative URL(s) to load the audio from.", "name": "urls" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "An object containing an `instances` property for HTML5Audio. Defaults to 1.", "name": "config" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "returns": [ { "type": { "names": [ "Phaser.Loader.FileTypes.AudioFile", "Phaser.Loader.FileTypes.HTML5AudioFile" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "Phaser.Loader.FileTypes.AudioFile" }, { "type": "NameExpression", "name": "Phaser.Loader.FileTypes.HTML5AudioFile" } ], "nullable": true } }, "nullable": true, "description": "The created audio file instance, or `null` if no supported URL was found." } ], "memberof": "Phaser.Loader.FileTypes.AudioFile", "longname": "Phaser.Loader.FileTypes.AudioFile.create", "scope": "static", "___id": "T000002R024713", "___s": true }, { "comment": "/**\r\n * Takes an array of audio URLs and returns a URL config object for the first entry that\r\n * the current device is capable of playing, based on the audio format indicated by the\r\n * file extension or an explicit `type` property on the URL config object.\r\n *\r\n * Blob and data URIs are always accepted and returned immediately regardless of format.\r\n * For regular URLs, the extension is extracted from the filename and checked against\r\n * `game.device.audio`. If no supported URL is found, `null` is returned.\r\n *\r\n * @function Phaser.Loader.FileTypes.AudioFile.getAudioURL\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Game} game - A reference to the Phaser Game instance.\r\n * @param {(string|string[]|Phaser.Types.Loader.FileTypes.AudioFileURLConfig|Phaser.Types.Loader.FileTypes.AudioFileURLConfig[])} urls - One or more audio URLs to test for browser support.\r\n *\r\n * @return {?Phaser.Types.Loader.FileTypes.AudioFileURLConfig} A URL config object with `url` and `type` properties for the first supported audio URL, or `null` if none are supported.\r\n */", "meta": { "filename": "AudioFile.js", "lineno": 169, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Takes an array of audio URLs and returns a URL config object for the first entry that\rthe current device is capable of playing, based on the audio format indicated by the\rfile extension or an explicit `type` property on the URL config object.\r\rBlob and data URIs are always accepted and returned immediately regardless of format.\rFor regular URLs, the extension is extracted from the filename and checked against\r`game.device.audio`. If no supported URL is found, `null` is returned.", "kind": "function", "name": "getAudioURL", "since": "3.0.0", "params": [ { "type": { "names": [ "Phaser.Game" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Game" } }, "description": "A reference to the Phaser Game instance.", "name": "game" }, { "type": { "names": [ "string", "Array.", "Phaser.Types.Loader.FileTypes.AudioFileURLConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AudioFileURLConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.AudioFileURLConfig", "type": "NameExpression" } ] } ] } }, "description": "One or more audio URLs to test for browser support.", "name": "urls" } ], "returns": [ { "type": { "names": [ "Phaser.Types.Loader.FileTypes.AudioFileURLConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AudioFileURLConfig", "nullable": true } }, "nullable": true, "description": "A URL config object with `url` and `type` properties for the first supported audio URL, or `null` if none are supported." } ], "memberof": "Phaser.Loader.FileTypes.AudioFile", "longname": "Phaser.Loader.FileTypes.AudioFile.getAudioURL", "scope": "static", "___id": "T000002R024721", "___s": true }, { "comment": "/**\r\n * Adds an Audio or HTML5Audio file, or array of audio files, to the current load queue.\r\n *\r\n * You can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.audio('title', [ 'music/Title.ogg', 'music/Title.mp3', 'music/Title.m4a' ]);\r\n * }\r\n * ```\r\n *\r\n * The file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\r\n * or if it's already running, when the next free load slot becomes available. This happens automatically if you\r\n * are calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\r\n * it means you cannot use the file immediately after calling this method, but must wait for the file to complete.\r\n * The typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\r\n * Scene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\r\n * loaded.\r\n *\r\n * The key must be a unique String. It is used to add the file to the global Audio Cache upon a successful load.\r\n * The key should be unique both in terms of files being loaded and files already present in the Audio Cache.\r\n * Loading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\r\n * then remove it from the Audio Cache first, before loading a new one.\r\n *\r\n * Instead of passing arguments you can pass a configuration object, such as:\r\n *\r\n * ```javascript\r\n * this.load.audio({\r\n * key: 'title',\r\n * url: [ 'music/Title.ogg', 'music/Title.mp3', 'music/Title.m4a' ]\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.AudioFileConfig` for more details.\r\n *\r\n * The URLs can be relative or absolute. If the URLs are relative the `Loader.baseURL` and `Loader.path` values will be prepended to them.\r\n *\r\n * Due to different browsers supporting different audio file types you should usually provide your audio files in a variety of formats.\r\n * ogg, 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\r\n * browser support.\r\n *\r\n * If 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.\r\n *\r\n * Note: The ability to load this type of file will only be available if the Audio File type has been built into Phaser.\r\n * It is available in the default build but can be excluded from custom builds.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#audio\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.AudioFileConfig|Phaser.Types.Loader.FileTypes.AudioFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {(string|string[]|Phaser.Types.Loader.FileTypes.AudioFileURLConfig|Phaser.Types.Loader.FileTypes.AudioFileURLConfig[])} [urls] - The absolute or relative URL to load the audio files from.\r\n * @param {any} [config] - An object containing an `instances` property for HTML5Audio. Defaults to 1.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.\r\n *\r\n * @return {this} The Loader instance.\r\n */", "meta": { "filename": "AudioFile.js", "lineno": 221, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds an Audio or HTML5Audio file, or array of audio files, to the current load queue.\r\rYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\r```javascript\rfunction preload ()\r{\r this.load.audio('title', [ 'music/Title.ogg', 'music/Title.mp3', 'music/Title.m4a' ]);\r}\r```\r\rThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\ror if it's already running, when the next free load slot becomes available. This happens automatically if you\rare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\rit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\rThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\rScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\rloaded.\r\rThe key must be a unique String. It is used to add the file to the global Audio Cache upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the Audio Cache.\rLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\rthen remove it from the Audio Cache first, before loading a new one.\r\rInstead of passing arguments you can pass a configuration object, such as:\r\r```javascript\rthis.load.audio({\r key: 'title',\r url: [ 'music/Title.ogg', 'music/Title.mp3', 'music/Title.m4a' ]\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.AudioFileConfig` for more details.\r\rThe URLs can be relative or absolute. If the URLs are relative the `Loader.baseURL` and `Loader.path` values will be prepended to them.\r\rDue to different browsers supporting different audio file types you should usually provide your audio files in a variety of formats.\rogg, 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\rbrowser support.\r\rIf 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.\r\rNote: The ability to load this type of file will only be available if the Audio File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "audio", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.AudioFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AudioFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.AudioFileConfig", "type": "NameExpression" } ] } ] } }, "description": "The key to use for this file, or a file configuration object, or array of them.", "name": "key" }, { "type": { "names": [ "string", "Array.", "Phaser.Types.Loader.FileTypes.AudioFileURLConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AudioFileURLConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.AudioFileURLConfig", "type": "NameExpression" } ] } ] } }, "optional": true, "description": "The absolute or relative URL to load the audio files from.", "name": "urls" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "An object containing an `instances` property for HTML5Audio. Defaults to 1.", "name": "config" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Loader instance." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#audio", "scope": "instance", "___id": "T000002R024732", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * An Audio Sprite File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#audioSprite method and are not typically created directly.\r\n *\r\n * For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#audioSprite.\r\n *\r\n * @class AudioSpriteFile\r\n * @extends Phaser.Loader.MultiFile\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.\r\n * @param {(string|Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {string} jsonURL - The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.\r\n * @param {{(string|string[])}} [audioURL] - The absolute or relative URL to load the audio file from. If empty it will be obtained by parsing the JSON file.\r\n * @param {any} [audioConfig] - The audio configuration options.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [audioXhrSettings] - An XHR Settings configuration object for the audio file. Used in replacement of the Loaders default XHR Settings.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [jsonXhrSettings] - An XHR Settings configuration object for the json file. Used in replacement of the Loaders default XHR Settings.\r\n */", "meta": { "filename": "AudioSpriteFile.js", "lineno": 15, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "An Audio Sprite File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#audioSprite method and are not typically created directly.\r\rFor 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig" } ] } }, "description": "The key to use for this file, or a file configuration object.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "RecordType", "fields": [ { "type": "FieldType", "key": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } } ] } }, "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" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The audio configuration options.", "name": "audioConfig" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024748", "___s": true }, { "comment": "/**\r\n * Called by each File when it finishes loading.\r\n *\r\n * @method Phaser.Loader.FileTypes.AudioSpriteFile#onFileComplete\r\n * @since 3.7.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File that has completed processing.\r\n */", "meta": { "filename": "AudioSpriteFile.js", "lineno": 85, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Called by each File when it finishes loading.", "kind": "function", "name": "onFileComplete", "since": "3.7.0", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024767", "___s": true }, { "comment": "/**\r\n * Adds this file to its target cache upon successful loading and processing.\r\n *\r\n * @method Phaser.Loader.FileTypes.AudioSpriteFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "AudioSpriteFile.js", "lineno": 121, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "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", "___id": "T000002R024774", "___s": true }, { "comment": "/**\r\n * Adds a JSON based Audio Sprite, or array of audio sprites, to the current load queue.\r\n *\r\n * You can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.audioSprite('kyobi', 'kyobi.json', [\r\n * 'kyobi.ogg',\r\n * 'kyobi.mp3',\r\n * 'kyobi.m4a'\r\n * ]);\r\n * }\r\n * ```\r\n *\r\n * Audio Sprites are a combination of audio files and a JSON configuration.\r\n * The JSON follows the format of that created by https://github.com/tonistiigi/audiosprite\r\n *\r\n * If the JSON file includes a 'resource' object then you can let Phaser parse it and load the audio\r\n * files automatically based on its content. To do this exclude the audio URLs from the load:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.audioSprite('kyobi', 'kyobi.json');\r\n * }\r\n * ```\r\n *\r\n * The file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\r\n * or if it's already running, when the next free load slot becomes available. This happens automatically if you\r\n * are calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\r\n * it means you cannot use the file immediately after calling this method, but must wait for the file to complete.\r\n * The typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\r\n * Scene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\r\n * loaded.\r\n *\r\n * If you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\r\n * its events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\r\n *\r\n * The key must be a unique String. It is used to add the file to the global Audio Cache upon a successful load.\r\n * The key should be unique both in terms of files being loaded and files already present in the Audio Cache.\r\n * Loading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\r\n * then remove it from the Audio Cache first, before loading a new one.\r\n *\r\n * Instead of passing arguments you can pass a configuration object, such as:\r\n *\r\n * ```javascript\r\n * this.load.audioSprite({\r\n * key: 'kyobi',\r\n * jsonURL: 'audio/Kyobi.json',\r\n * audioURL: [\r\n * 'audio/Kyobi.ogg',\r\n * 'audio/Kyobi.mp3',\r\n * 'audio/Kyobi.m4a'\r\n * ]\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig` for more details.\r\n *\r\n * Instead of passing a URL for the audio JSON data you can also pass in a well formed JSON object instead.\r\n *\r\n * Once the audio has finished loading you can use it create an Audio Sprite by referencing its key:\r\n *\r\n * ```javascript\r\n * this.load.audioSprite('kyobi', 'kyobi.json');\r\n * // and later in your game ...\r\n * var music = this.sound.addAudioSprite('kyobi');\r\n * music.play('title');\r\n * ```\r\n *\r\n * If you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this file's\r\n * key. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\r\n * this is what you would use to retrieve the audio sprite from the Audio Cache.\r\n *\r\n * The URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\n *\r\n * Due to different browsers supporting different audio file types you should usually provide your audio files in a variety of formats.\r\n * ogg, 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\r\n * browser support.\r\n *\r\n * If 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.\r\n *\r\n * Note: The ability to load this type of file will only be available if the Audio Sprite File type has been built into Phaser.\r\n * It is available in the default build but can be excluded from custom builds.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#audioSprite\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig|Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig[])} key - The key to use for this file, or a file configuration object, or an array of objects.\r\n * @param {string} jsonURL - The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.\r\n * @param {(string|string[])} [audioURL] - The absolute or relative URL to load the audio file from. If empty it will be obtained by parsing the JSON file.\r\n * @param {any} [audioConfig] - The audio configuration options.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [audioXhrSettings] - An XHR Settings configuration object for the audio file. Used in replacement of the Loaders default XHR Settings.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [jsonXhrSettings] - An XHR Settings configuration object for the json file. Used in replacement of the Loaders default XHR Settings.\r\n *\r\n * @return {this} The Loader.\r\n */", "meta": { "filename": "AudioSpriteFile.js", "lineno": 143, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a JSON based Audio Sprite, or array of audio sprites, to the current load queue.\r\rYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\r```javascript\rfunction preload ()\r{\r this.load.audioSprite('kyobi', 'kyobi.json', [\r 'kyobi.ogg',\r 'kyobi.mp3',\r 'kyobi.m4a'\r ]);\r}\r```\r\rAudio Sprites are a combination of audio files and a JSON configuration.\rThe JSON follows the format of that created by https://github.com/tonistiigi/audiosprite\r\rIf the JSON file includes a 'resource' object then you can let Phaser parse it and load the audio\rfiles automatically based on its content. To do this exclude the audio URLs from the load:\r\r```javascript\rfunction preload ()\r{\r this.load.audioSprite('kyobi', 'kyobi.json');\r}\r```\r\rThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\ror if it's already running, when the next free load slot becomes available. This happens automatically if you\rare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\rit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\rThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\rScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\rloaded.\r\rIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\rits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\r\rThe key must be a unique String. It is used to add the file to the global Audio Cache upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the Audio Cache.\rLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\rthen remove it from the Audio Cache first, before loading a new one.\r\rInstead of passing arguments you can pass a configuration object, such as:\r\r```javascript\rthis.load.audioSprite({\r key: 'kyobi',\r jsonURL: 'audio/Kyobi.json',\r audioURL: [\r 'audio/Kyobi.ogg',\r 'audio/Kyobi.mp3',\r 'audio/Kyobi.m4a'\r ]\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig` for more details.\r\rInstead of passing a URL for the audio JSON data you can also pass in a well formed JSON object instead.\r\rOnce the audio has finished loading you can use it create an Audio Sprite by referencing its key:\r\r```javascript\rthis.load.audioSprite('kyobi', 'kyobi.json');\r// and later in your game ...\rvar music = this.sound.addAudioSprite('kyobi');\rmusic.play('title');\r```\r\rIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this file's\rkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\rthis is what you would use to retrieve the audio sprite from the Audio Cache.\r\rThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\rDue to different browsers supporting different audio file types you should usually provide your audio files in a variety of formats.\rogg, 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\rbrowser support.\r\rIf 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.\r\rNote: The ability to load this type of file will only be available if the Audio Sprite File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "audioSprite", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig", "type": "NameExpression" } ] } ] } }, "description": "The key to use for this file, or a file configuration object, or an array of objects.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "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" ], "parsedType": { "type": "NameExpression", "name": "any" } }, "optional": true, "description": "The audio configuration options.", "name": "audioConfig" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Loader." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#audioSprite", "scope": "instance", "___id": "T000002R024779", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Binary File suitable for loading by the Loader.\r\n *\r\n * Binary files are used to load raw binary data, such as custom level formats, game data archives, or any file\r\n * whose contents must be handled as an `ArrayBuffer` rather than parsed text or an image. Once loaded, the data\r\n * is stored in the Binary Cache and can optionally be cast to a typed array (e.g. `Uint8Array`) automatically\r\n * by providing a `dataType` constructor.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#binary method and are not typically created directly.\r\n *\r\n * For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#binary.\r\n *\r\n * @class BinaryFile\r\n * @extends Phaser.Loader.File\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.\r\n * @param {(string|Phaser.Types.Loader.FileTypes.BinaryFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {string} [url] - 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\".\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n * @param {any} [dataType] - Optional type to cast the binary file to once loaded. For example, `Uint8Array`.\r\n */", "meta": { "filename": "BinaryFile.js", "lineno": 14, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Binary File suitable for loading by the Loader.\r\rBinary files are used to load raw binary data, such as custom level formats, game data archives, or any file\rwhose contents must be handled as an `ArrayBuffer` rather than parsed text or an image. Once loaded, the data\ris stored in the Binary Cache and can optionally be cast to a typed array (e.g. `Uint8Array`) automatically\rby providing a `dataType` constructor.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#binary method and are not typically created directly.\r\rFor 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.BinaryFileConfig" } ] } }, "description": "The key to use for this file, or a file configuration object.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" }, { "type": { "names": [ "any" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024793", "___s": true }, { "comment": "/**\r\n * Called automatically by Loader.nextFile.\r\n * This method processes the raw XHR response: if a `dataType` constructor was specified (e.g. `Uint8Array`),\r\n * it wraps the `ArrayBuffer` response in a new instance of that type; otherwise the raw `ArrayBuffer` is\r\n * stored directly as the file's data.\r\n *\r\n * @method Phaser.Loader.FileTypes.BinaryFile#onProcess\r\n * @since 3.7.0\r\n */", "meta": { "filename": "BinaryFile.js", "lineno": 74, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Called automatically by Loader.nextFile.\rThis method processes the raw XHR response: if a `dataType` constructor was specified (e.g. `Uint8Array`),\rit wraps the `ArrayBuffer` response in a new instance of that type; otherwise the raw `ArrayBuffer` is\rstored directly as the file's 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", "___id": "T000002R024814", "___s": true }, { "comment": "/**\r\n * Adds a Binary file, or array of Binary files, to the current load queue.\r\n *\r\n * You can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.binary('doom', 'files/Doom.wad');\r\n * }\r\n * ```\r\n *\r\n * The file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\r\n * or if it's already running, when the next free load slot becomes available. This happens automatically if you\r\n * are calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\r\n * it means you cannot use the file immediately after calling this method, but must wait for the file to complete.\r\n * The typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\r\n * Scene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\r\n * loaded.\r\n *\r\n * The key must be a unique String. It is used to add the file to the global Binary Cache upon a successful load.\r\n * The key should be unique both in terms of files being loaded and files already present in the Binary Cache.\r\n * Loading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\r\n * then remove it from the Binary Cache first, before loading a new one.\r\n *\r\n * Instead of passing arguments you can pass a configuration object, such as:\r\n *\r\n * ```javascript\r\n * this.load.binary({\r\n * key: 'doom',\r\n * url: 'files/Doom.wad',\r\n * dataType: Uint8Array\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.BinaryFileConfig` for more details.\r\n *\r\n * Once the file has finished loading you can access it from its Cache using its key:\r\n *\r\n * ```javascript\r\n * this.load.binary('doom', 'files/Doom.wad');\r\n * // and later in your game ...\r\n * var data = this.cache.binary.get('doom');\r\n * ```\r\n *\r\n * If you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\r\n * key. For example, if the prefix was `LEVEL1.` and the key was `Data` the final key will be `LEVEL1.Data` and\r\n * this is what you would use to retrieve the text from the Binary Cache.\r\n *\r\n * The URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\n *\r\n * If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"doom\"\r\n * and no URL is given then the Loader will set the URL to be \"doom.bin\". It will always add `.bin` as the extension, although\r\n * this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\r\n *\r\n * Note: The ability to load this type of file will only be available if the Binary File type has been built into Phaser.\r\n * It is available in the default build but can be excluded from custom builds.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#binary\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.BinaryFileConfig|Phaser.Types.Loader.FileTypes.BinaryFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {string} [url] - 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\".\r\n * @param {any} [dataType] - Optional type to cast the binary file to once loaded. For example, `Uint8Array`.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.\r\n *\r\n * @return {this} The Loader instance.\r\n */", "meta": { "filename": "BinaryFile.js", "lineno": 96, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a Binary file, or array of Binary files, to the current load queue.\r\rYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\r```javascript\rfunction preload ()\r{\r this.load.binary('doom', 'files/Doom.wad');\r}\r```\r\rThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\ror if it's already running, when the next free load slot becomes available. This happens automatically if you\rare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\rit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\rThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\rScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\rloaded.\r\rThe key must be a unique String. It is used to add the file to the global Binary Cache upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the Binary Cache.\rLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\rthen remove it from the Binary Cache first, before loading a new one.\r\rInstead of passing arguments you can pass a configuration object, such as:\r\r```javascript\rthis.load.binary({\r key: 'doom',\r url: 'files/Doom.wad',\r dataType: Uint8Array\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.BinaryFileConfig` for more details.\r\rOnce the file has finished loading you can access it from its Cache using its key:\r\r```javascript\rthis.load.binary('doom', 'files/Doom.wad');\r// and later in your game ...\rvar data = this.cache.binary.get('doom');\r```\r\rIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\rkey. For example, if the prefix was `LEVEL1.` and the key was `Data` the final key will be `LEVEL1.Data` and\rthis is what you would use to retrieve the text from the Binary Cache.\r\rThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\rIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"doom\"\rand no URL is given then the Loader will set the URL to be \"doom.bin\". It will always add `.bin` as the extension, although\rthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\r\rNote: The ability to load this type of file will only be available if the Binary File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "binary", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.BinaryFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.BinaryFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.BinaryFileConfig", "type": "NameExpression" } ] } ] } }, "description": "The key to use for this file, or a file configuration object, or array of them.", "name": "key" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Loader instance." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#binary", "scope": "instance", "___id": "T000002R024819", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single Bitmap Font based File suitable for loading by the Loader.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#bitmapFont method and are not typically created directly.\r\n *\r\n * For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#bitmapFont.\r\n *\r\n * @class BitmapFontFile\r\n * @extends Phaser.Loader.MultiFile\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.0.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.\r\n * @param {(string|Phaser.Types.Loader.FileTypes.BitmapFontFileConfig)} key - The key to use for this file, or a file configuration object.\r\n * @param {string|string[]} [textureURL] - 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\".\r\n * @param {string} [fontDataURL] - 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\".\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - An XHR Settings configuration object for the font image file. Used in replacement of the Loaders default XHR Settings.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [fontDataXhrSettings] - An XHR Settings configuration object for the font data xml file. Used in replacement of the Loaders default XHR Settings.\r\n */", "meta": { "filename": "BitmapFontFile.js", "lineno": 16, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A single Bitmap Font based File suitable for loading by the Loader.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#bitmapFont method and are not typically created directly.\r\rFor 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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.BitmapFontFileConfig" } ] } }, "description": "The key to use for this file, or a file configuration object.", "name": "key" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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", "___id": "T000002R024830", "___s": true }, { "comment": "/**\r\n * Adds this file to its target cache upon successful loading and processing.\r\n *\r\n * @method Phaser.Loader.FileTypes.BitmapFontFile#addToCache\r\n * @since 3.7.0\r\n */", "meta": { "filename": "BitmapFontFile.js", "lineno": 86, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "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", "___id": "T000002R024851", "___s": true }, { "comment": "/**\r\n * Adds an XML based Bitmap Font, or array of fonts, to the current load queue.\r\n *\r\n * You can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\n *\r\n * ```javascript\r\n * function preload ()\r\n * {\r\n * this.load.bitmapFont('goldenFont', 'images/GoldFont.png', 'images/GoldFont.xml');\r\n * }\r\n * ```\r\n *\r\n * The file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\r\n * or if it's already running, when the next free load slot becomes available. This happens automatically if you\r\n * are calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\r\n * it means you cannot use the file immediately after calling this method, but must wait for the file to complete.\r\n * The typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\r\n * Scene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\r\n * loaded.\r\n *\r\n * If you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\r\n * its events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\r\n *\r\n * Phaser expects the font data to be provided in an XML file format.\r\n * These files are created by software such as the [Angelcode Bitmap Font Generator](http://www.angelcode.com/products/bmfont/),\r\n * [Littera](http://kvazars.com/littera/) or [Glyph Designer](https://71squared.com/glyphdesigner)\r\n *\r\n * Phaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\r\n *\r\n * The key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\r\n * The key should be unique both in terms of files being loaded and files already present in the Texture Manager.\r\n * Loading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\r\n * then remove it from the Texture Manager first, before loading a new one.\r\n *\r\n * Instead of passing arguments you can pass a configuration object, such as:\r\n *\r\n * ```javascript\r\n * this.load.bitmapFont({\r\n * key: 'goldenFont',\r\n * textureURL: 'images/GoldFont.png',\r\n * fontDataURL: 'images/GoldFont.xml'\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.BitmapFontFileConfig` for more details.\r\n *\r\n * Once the bitmap font has finished loading you can use the key of it when creating a Bitmap Text Game Object:\r\n *\r\n * ```javascript\r\n * this.load.bitmapFont('goldenFont', 'images/GoldFont.png', 'images/GoldFont.xml');\r\n * // and later in your game ...\r\n * this.add.bitmapText(x, y, 'goldenFont', 'Hello World');\r\n * ```\r\n *\r\n * If you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\r\n * key. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\r\n * this is what you would use when creating a Bitmap Text object.\r\n *\r\n * The URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\n *\r\n * If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\r\n * and no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\r\n * this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\r\n *\r\n * Phaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\r\n * then you can specify it by providing an array as the `url` where the second element is the normal map:\r\n *\r\n * ```javascript\r\n * this.load.bitmapFont('goldenFont', [ 'images/GoldFont.png', 'images/GoldFont-n.png' ], 'images/GoldFont.xml');\r\n * ```\r\n *\r\n * Or, if you are using a config object use the `normalMap` property:\r\n *\r\n * ```javascript\r\n * this.load.bitmapFont({\r\n * key: 'goldenFont',\r\n * textureURL: 'images/GoldFont.png',\r\n * normalMap: 'images/GoldFont-n.png',\r\n * fontDataURL: 'images/GoldFont.xml'\r\n * });\r\n * ```\r\n *\r\n * The normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.\r\n * Normal maps are a WebGL only feature.\r\n *\r\n * Note: The ability to load this type of file will only be available if the Bitmap Font File type has been built into Phaser.\r\n * It is available in the default build but can be excluded from custom builds.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#bitmapFont\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.0.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.BitmapFontFileConfig|Phaser.Types.Loader.FileTypes.BitmapFontFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {string|string[]} [textureURL] - 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\".\r\n * @param {string} [fontDataURL] - 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\".\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - An XHR Settings configuration object for the font image file. Used in replacement of the Loaders default XHR Settings.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [fontDataXhrSettings] - An XHR Settings configuration object for the font data xml file. Used in replacement of the Loaders default XHR Settings.\r\n *\r\n * @return {this} The Loader instance.\r\n */", "meta": { "filename": "BitmapFontFile.js", "lineno": 113, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds an XML based Bitmap Font, or array of fonts, to the current load queue.\r\rYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\r```javascript\rfunction preload ()\r{\r this.load.bitmapFont('goldenFont', 'images/GoldFont.png', 'images/GoldFont.xml');\r}\r```\r\rThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\ror if it's already running, when the next free load slot becomes available. This happens automatically if you\rare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\rit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\rThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\rScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\rloaded.\r\rIf you call this from outside of `preload` then you are responsible for starting the Loader afterwards and monitoring\rits events to know when it's safe to use the asset. Please see the Phaser.Loader.LoaderPlugin class for more details.\r\rPhaser expects the font data to be provided in an XML file format.\rThese files are created by software such as the [Angelcode Bitmap Font Generator](http://www.angelcode.com/products/bmfont/),\r[Littera](http://kvazars.com/littera/) or [Glyph Designer](https://71squared.com/glyphdesigner)\r\rPhaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.\r\rThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\rLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\rthen remove it from the Texture Manager first, before loading a new one.\r\rInstead of passing arguments you can pass a configuration object, such as:\r\r```javascript\rthis.load.bitmapFont({\r key: 'goldenFont',\r textureURL: 'images/GoldFont.png',\r fontDataURL: 'images/GoldFont.xml'\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.BitmapFontFileConfig` for more details.\r\rOnce the bitmap font has finished loading you can use the key of it when creating a Bitmap Text Game Object:\r\r```javascript\rthis.load.bitmapFont('goldenFont', 'images/GoldFont.png', 'images/GoldFont.xml');\r// and later in your game ...\rthis.add.bitmapText(x, y, 'goldenFont', 'Hello World');\r```\r\rIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files\rkey. For example, if the prefix was `MENU.` and the key was `Background` the final key will be `MENU.Background` and\rthis is what you would use when creating a Bitmap Text object.\r\rThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\rIf the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is \"alien\"\rand no URL is given then the Loader will set the URL to be \"alien.png\". It will always add `.png` as the extension, although\rthis can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.\r\rPhaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,\rthen you can specify it by providing an array as the `url` where the second element is the normal map:\r\r```javascript\rthis.load.bitmapFont('goldenFont', [ 'images/GoldFont.png', 'images/GoldFont-n.png' ], 'images/GoldFont.xml');\r```\r\rOr, if you are using a config object use the `normalMap` property:\r\r```javascript\rthis.load.bitmapFont({\r key: 'goldenFont',\r textureURL: 'images/GoldFont.png',\r normalMap: 'images/GoldFont-n.png',\r fontDataURL: 'images/GoldFont.xml'\r});\r```\r\rThe normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.\rNormal maps are a WebGL only feature.\r\rNote: The ability to load this type of file will only be available if the Bitmap Font File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "bitmapFont", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.0.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.BitmapFontFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.BitmapFontFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.BitmapFontFileConfig", "type": "NameExpression" } ] } ] } }, "description": "The key to use for this file, or a file configuration object, or array of them.", "name": "key" }, { "type": { "names": [ "string", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "string", "type": "NameExpression" } ] } ] } }, "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Loader instance." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#bitmapFont", "scope": "instance", "___id": "T000002R024861", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A Compressed Texture File is a special MultiFile that handles loading GPU-native compressed texture formats such\r\n * as PVR and KTX container files. It supports a range of internal compression formats including ASTC, S3TC, ETC,\r\n * PVRTC, and others, selecting the best format supported by the current GPU at load time.\r\n *\r\n * It can load a single compressed texture, a compressed texture with an accompanying JSON atlas, or a multi-atlas\r\n * as exported by Texture Packer Pro. An `IMG` fallback entry may also be provided for browsers or GPUs that do\r\n * not support any of the compressed formats.\r\n *\r\n * These are created when you use the Phaser.Loader.LoaderPlugin#texture method and are not typically created directly.\r\n *\r\n * For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#texture.\r\n *\r\n * @class CompressedTextureFile\r\n * @extends Phaser.Loader.MultiFile\r\n * @memberof Phaser.Loader.FileTypes\r\n * @constructor\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.\r\n * @param {string} key - The key to use for this file.\r\n * @param {Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry} entry - The compressed texture file entry to load.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.\r\n */", "meta": { "filename": "CompressedTextureFile.js", "lineno": 22, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "classdesc": "A Compressed Texture File is a special MultiFile that handles loading GPU-native compressed texture formats such\ras PVR and KTX container files. It supports a range of internal compression formats including ASTC, S3TC, ETC,\rPVRTC, and others, selecting the best format supported by the current GPU at load time.\r\rIt can load a single compressed texture, a compressed texture with an accompanying JSON atlas, or a multi-atlas\ras exported by Texture Packer Pro. An `IMG` fallback entry may also be provided for browsers or GPUs that do\rnot support any of the compressed formats.\r\rThese are created when you use the Phaser.Loader.LoaderPlugin#texture method and are not typically created directly.\r\rFor documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#texture.", "kind": "class", "name": "CompressedTextureFile", "augments": [ "Phaser.Loader.MultiFile" ], "memberof": "Phaser.Loader.FileTypes", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Loader.LoaderPlugin" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.LoaderPlugin" } }, "description": "A reference to the Loader that is responsible for this file.", "name": "loader" }, { "type": { "names": [ "string" ], "parsedType": { "type": "NameExpression", "name": "string" } }, "description": "The key to use for this file.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry" } }, "description": "The compressed texture file entry to load.", "name": "entry" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.XHRSettingsObject" } }, "optional": true, "description": "Extra XHR Settings specifically for this file.", "name": "xhrSettings" } ], "scope": "static", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile", "___id": "T000002R024881", "___s": true }, { "comment": "/**\r\n * Called by each File when it finishes loading. Decrements the pending file count and, when loading\r\n * a multi-atlas configuration, parses the completed JSON manifest to dynamically queue additional\r\n * BinaryFile instances for each texture referenced in the atlas, along with any associated normal maps.\r\n * The loader's base URL, path, and prefix are temporarily adjusted to the multi-atlas settings during\r\n * this process and then restored afterwards.\r\n *\r\n * @method Phaser.Loader.FileTypes.CompressedTextureFile#onFileComplete\r\n * @since 3.60.0\r\n *\r\n * @param {Phaser.Loader.File} file - The File that has completed processing.\r\n */", "meta": { "filename": "CompressedTextureFile.js", "lineno": 103, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Called by each File when it finishes loading. Decrements the pending file count and, when loading\ra multi-atlas configuration, parses the completed JSON manifest to dynamically queue additional\rBinaryFile instances for each texture referenced in the atlas, along with any associated normal maps.\rThe loader's base URL, path, and prefix are temporarily adjusted to the multi-atlas settings during\rthis process and then restored afterwards.", "kind": "function", "name": "onFileComplete", "since": "3.60.0", "params": [ { "type": { "names": [ "Phaser.Loader.File" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Loader.File" } }, "description": "The File that has completed processing.", "name": "file" } ], "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#onFileComplete", "scope": "instance", "overrides": "Phaser.Loader.MultiFile#onFileComplete", "___id": "T000002R024904", "___s": true }, { "comment": "/**\r\n * Adds this file to its target cache upon successful loading and processing. If the file is a\r\n * multi-atlas it delegates to `addMultiToCache`. Otherwise, it parses the binary texture data\r\n * using either the PVR or KTX parser, verifies that the texture dimensions meet the requirements\r\n * of the compression format, and checks that the GPU supports the internal format. If all checks\r\n * pass the texture is added to the Texture Manager, optionally with JSON atlas data if one was\r\n * loaded alongside it. A console warning is issued for any texture that fails validation.\r\n *\r\n * @method Phaser.Loader.FileTypes.CompressedTextureFile#addToCache\r\n * @since 3.60.0\r\n */", "meta": { "filename": "CompressedTextureFile.js", "lineno": 196, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds this file to its target cache upon successful loading and processing. If the file is a\rmulti-atlas it delegates to `addMultiToCache`. Otherwise, it parses the binary texture data\rusing either the PVR or KTX parser, verifies that the texture dimensions meet the requirements\rof the compression format, and checks that the GPU supports the internal format. If all checks\rpass the texture is added to the Texture Manager, optionally with JSON atlas data if one was\rloaded alongside it. A console warning is issued for any texture that fails validation.", "kind": "function", "name": "addToCache", "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#addToCache", "scope": "instance", "___id": "T000002R024923", "___s": true }, { "comment": "/**\r\n * Adds all of the multi-file entries to their target caches upon successful loading and processing.\r\n * Iterates over each binary texture file in the multi-atlas, parses it using the PVR or KTX parser,\r\n * and matches it against its corresponding entry in the JSON manifest. Only textures whose compression\r\n * format is supported by the current GPU are included. Any associated normal maps are collected and\r\n * passed through as well. The resulting images, atlas data, and normal maps are registered together\r\n * with the Texture Manager as a JSON array atlas.\r\n *\r\n * @method Phaser.Loader.FileTypes.CompressedTextureFile#addMultiToCache\r\n * @since 3.60.0\r\n */", "meta": { "filename": "CompressedTextureFile.js", "lineno": 272, "columnno": 4, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds all of the multi-file entries to their target caches upon successful loading and processing.\rIterates over each binary texture file in the multi-atlas, parses it using the PVR or KTX parser,\rand matches it against its corresponding entry in the JSON manifest. Only textures whose compression\rformat is supported by the current GPU are included. Any associated normal maps are collected and\rpassed through as well. The resulting images, atlas data, and normal maps are registered together\rwith the Texture Manager as a JSON array atlas.", "kind": "function", "name": "addMultiToCache", "since": "3.60.0", "memberof": "Phaser.Loader.FileTypes.CompressedTextureFile", "longname": "Phaser.Loader.FileTypes.CompressedTextureFile#addMultiToCache", "scope": "instance", "___id": "T000002R024939", "___s": true }, { "comment": "/**\r\n * Adds a Compressed Texture file to the current load queue. This feature is WebGL only.\r\n *\r\n * This method takes a key and a configuration object, which lists the different formats\r\n * and files associated with them.\r\n *\r\n * The texture format object should be ordered in GPU priority order, with IMG as the last entry.\r\n *\r\n * You can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\n *\r\n * ```javascript\r\n * preload ()\r\n * {\r\n * this.load.texture('yourPic', {\r\n * ASTC: { type: 'PVR', textureURL: 'pic-astc-4x4.pvr' },\r\n * PVRTC: { type: 'PVR', textureURL: 'pic-pvrtc-4bpp-rgba.pvr' },\r\n * S3TC: { type: 'PVR', textureURL: 'pic-dxt5.pvr' },\r\n * IMG: { textureURL: 'pic.png' }\r\n * });\r\n * ```\r\n *\r\n * If you wish to load a texture atlas, provide the `atlasURL` property:\r\n *\r\n * ```javascript\r\n * preload ()\r\n * {\r\n * const path = 'assets/compressed';\r\n *\r\n * this.load.texture('yourAtlas', {\r\n * 'ASTC': { type: 'PVR', textureURL: `${path}/textures-astc-4x4.pvr`, atlasURL: `${path}/textures.json` },\r\n * 'PVRTC': { type: 'PVR', textureURL: `${path}/textures-pvrtc-4bpp-rgba.pvr`, atlasURL: `${path}/textures-pvrtc-4bpp-rgba.json` },\r\n * 'S3TC': { type: 'PVR', textureURL: `${path}/textures-dxt5.pvr`, atlasURL: `${path}/textures-dxt5.json` },\r\n * 'IMG': { textureURL: `${path}/textures.png`, atlasURL: `${path}/textures.json` }\r\n * });\r\n * }\r\n * ```\r\n *\r\n * If you wish to load a Multi Atlas, as exported from Texture Packer Pro, use the `multiAtlasURL` property instead:\r\n *\r\n * ```javascript\r\n * preload ()\r\n * {\r\n * const path = 'assets/compressed';\r\n *\r\n * this.load.texture('yourAtlas', {\r\n * 'ASTC': { type: 'PVR', multiAtlasURL: `${path}/textures.json`, multiPath: `${path}` },\r\n * 'PVRTC': { type: 'PVR', multiAtlasURL: `${path}/textures-pvrtc-4bpp-rgba.json`, multiPath: `${path}` },\r\n * 'S3TC': { type: 'PVR', multiAtlasURL: `${path}/textures-dxt5.json`, multiPath: `${path}` },\r\n * 'IMG': { multiAtlasURL: `${path}/textures.json`, multiPath: `${path}` }\r\n * });\r\n * }\r\n * ```\r\n *\r\n * When loading a Multi Atlas you do not need to specify the `textureURL` property as it will be read from the JSON file.\r\n *\r\n * Instead of passing arguments you can pass a configuration object, such as:\r\n *\r\n * ```javascript\r\n * this.load.texture({\r\n * key: 'yourPic',\r\n * url: {\r\n * ASTC: { type: 'PVR', textureURL: 'pic-astc-4x4.pvr' },\r\n * PVRTC: { type: 'PVR', textureURL: 'pic-pvrtc-4bpp-rgba.pvr' },\r\n * S3TC: { type: 'PVR', textureURL: 'pic-dxt5.pvr' },\r\n * IMG: { textureURL: 'pic.png' }\r\n * }\r\n * });\r\n * ```\r\n *\r\n * See the documentation for `Phaser.Types.Loader.FileTypes.CompressedTextureFileConfig` for more details.\r\n *\r\n * The number of formats you provide to this function is up to you, but you should ensure you\r\n * cover the primary platforms where appropriate.\r\n *\r\n * The 'IMG' entry is a fallback to a JPG or PNG, should the browser be unable to load any of the other\r\n * formats presented to this function. You should really always include this, although it is optional.\r\n *\r\n * Phaser supports loading both the PVR and KTX container formats. Within those, it can parse\r\n * the following texture compression formats:\r\n *\r\n * ETC\r\n * ETC1\r\n * ATC\r\n * ASTC\r\n * BPTC\r\n * RGTC\r\n * PVRTC\r\n * S3TC\r\n * S3TCSRGB\r\n *\r\n * For more information about the benefits of compressed textures please see the\r\n * following articles:\r\n *\r\n * Texture Compression in 2020 (https://aras-p.info/blog/2020/12/08/Texture-Compression-in-2020/)\r\n * Compressed GPU Texture Formats (https://themaister.net/blog/2020/08/12/compressed-gpu-texture-formats-a-review-and-compute-shader-decoders-part-1/)\r\n *\r\n * To create compressed texture files use a 3rd party application such as:\r\n *\r\n * Texture Packer (https://www.codeandweb.com/texturepacker/tutorials/how-to-create-sprite-sheets-for-phaser3?utm_source=ad&utm_medium=banner&utm_campaign=phaser-2018-10-16)\r\n * PVRTexTool (https://developer.imaginationtech.com/pvrtextool/) - available for Windows, macOS and Linux.\r\n * ASTC Encoder (https://github.com/ARM-software/astc-encoder)\r\n *\r\n * Compressed textures will appear darker than normal textures. This is because\r\n * the Web uses sRGB colorspace, but compressed textures are sampled as linear\r\n * colorspace. You must adjust your textures to be lighter before compression.\r\n * See https://imagemagick.org/Usage/color_basics/#srgb for more details.\r\n * You can do this with ImageMagick (https://imagemagick.org/index.php) using\r\n * the following command:\r\n *\r\n * `magick input.png -set colorspace RGB -colorspace sRGB output.png`\r\n *\r\n * You must ensure that compressed textures meet the following standards for use\r\n * in WebGL and Phaser:\r\n *\r\n * - PVRTC must have a power-of-two width and height.\r\n * - MIPMaps, if present, must have a power-of-two width and height.\r\n * - S3TC, S3TCSRGB, RGTC, and BPTC must have width and height divisible by 4.\r\n * - ASTC must have a Channel Type of Unsigned Normalized Bytes (UNorm). In fact, all compressed textures should be UNorm, but ASTC presents many other options.\r\n *\r\n * If in doubt, a power-of-two resolution is always a safe bet.\r\n *\r\n * The file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\r\n * or if it's already running, when the next free load slot becomes available. This happens automatically if you\r\n * are calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\r\n * it means you cannot use the file immediately after calling this method, but must wait for the file to complete.\r\n * The typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\r\n * Scene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\r\n * loaded.\r\n *\r\n * The key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\r\n * The key should be unique both in terms of files being loaded and files already present in the Texture Manager.\r\n * Loading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\r\n * then remove it from the Texture Manager first, before loading a new one.\r\n *\r\n * If you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this file's\r\n * key. For example, if the prefix was `LEVEL1.` and the key was `Data` the final key will be `LEVEL1.Data` and\r\n * this is what you would use to retrieve the text from the Texture Manager.\r\n *\r\n * The URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\n *\r\n * Unlike other file loaders in Phaser, the URLs must include the file extension.\r\n *\r\n * Note: The ability to load this type of file will only be available if the Compressed Texture File type has been built into Phaser.\r\n * It is available in the default build but can be excluded from custom builds.\r\n *\r\n * @method Phaser.Loader.LoaderPlugin#texture\r\n * @fires Phaser.Loader.Events#ADD\r\n * @since 3.60.0\r\n *\r\n * @param {(string|Phaser.Types.Loader.FileTypes.CompressedTextureFileConfig|Phaser.Types.Loader.FileTypes.CompressedTextureFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.\r\n * @param {Phaser.Types.Loader.FileTypes.CompressedTextureFileConfig} [url] - The compressed texture configuration object. Not required if passing a config object as the `key` parameter.\r\n * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.\r\n *\r\n * @return {this} The Loader instance.\r\n */", "meta": { "filename": "CompressedTextureFile.js", "lineno": 357, "columnno": 0, "path": "D:\\wamp\\www\\phaser\\src\\loader\\filetypes", "code": {} }, "description": "Adds a Compressed Texture file to the current load queue. This feature is WebGL only.\r\rThis method takes a key and a configuration object, which lists the different formats\rand files associated with them.\r\rThe texture format object should be ordered in GPU priority order, with IMG as the last entry.\r\rYou can call this method from within your Scene's `preload`, along with any other files you wish to load:\r\r```javascript\rpreload ()\r{\r this.load.texture('yourPic', {\r ASTC: { type: 'PVR', textureURL: 'pic-astc-4x4.pvr' },\r PVRTC: { type: 'PVR', textureURL: 'pic-pvrtc-4bpp-rgba.pvr' },\r S3TC: { type: 'PVR', textureURL: 'pic-dxt5.pvr' },\r IMG: { textureURL: 'pic.png' }\r });\r```\r\rIf you wish to load a texture atlas, provide the `atlasURL` property:\r\r```javascript\rpreload ()\r{\r const path = 'assets/compressed';\r\r this.load.texture('yourAtlas', {\r 'ASTC': { type: 'PVR', textureURL: `${path}/textures-astc-4x4.pvr`, atlasURL: `${path}/textures.json` },\r 'PVRTC': { type: 'PVR', textureURL: `${path}/textures-pvrtc-4bpp-rgba.pvr`, atlasURL: `${path}/textures-pvrtc-4bpp-rgba.json` },\r 'S3TC': { type: 'PVR', textureURL: `${path}/textures-dxt5.pvr`, atlasURL: `${path}/textures-dxt5.json` },\r 'IMG': { textureURL: `${path}/textures.png`, atlasURL: `${path}/textures.json` }\r });\r}\r```\r\rIf you wish to load a Multi Atlas, as exported from Texture Packer Pro, use the `multiAtlasURL` property instead:\r\r```javascript\rpreload ()\r{\r const path = 'assets/compressed';\r\r this.load.texture('yourAtlas', {\r 'ASTC': { type: 'PVR', multiAtlasURL: `${path}/textures.json`, multiPath: `${path}` },\r 'PVRTC': { type: 'PVR', multiAtlasURL: `${path}/textures-pvrtc-4bpp-rgba.json`, multiPath: `${path}` },\r 'S3TC': { type: 'PVR', multiAtlasURL: `${path}/textures-dxt5.json`, multiPath: `${path}` },\r 'IMG': { multiAtlasURL: `${path}/textures.json`, multiPath: `${path}` }\r });\r}\r```\r\rWhen loading a Multi Atlas you do not need to specify the `textureURL` property as it will be read from the JSON file.\r\rInstead of passing arguments you can pass a configuration object, such as:\r\r```javascript\rthis.load.texture({\r key: 'yourPic',\r url: {\r ASTC: { type: 'PVR', textureURL: 'pic-astc-4x4.pvr' },\r PVRTC: { type: 'PVR', textureURL: 'pic-pvrtc-4bpp-rgba.pvr' },\r S3TC: { type: 'PVR', textureURL: 'pic-dxt5.pvr' },\r IMG: { textureURL: 'pic.png' }\r }\r});\r```\r\rSee the documentation for `Phaser.Types.Loader.FileTypes.CompressedTextureFileConfig` for more details.\r\rThe number of formats you provide to this function is up to you, but you should ensure you\rcover the primary platforms where appropriate.\r\rThe 'IMG' entry is a fallback to a JPG or PNG, should the browser be unable to load any of the other\rformats presented to this function. You should really always include this, although it is optional.\r\rPhaser supports loading both the PVR and KTX container formats. Within those, it can parse\rthe following texture compression formats:\r\rETC\rETC1\rATC\rASTC\rBPTC\rRGTC\rPVRTC\rS3TC\rS3TCSRGB\r\rFor more information about the benefits of compressed textures please see the\rfollowing articles:\r\rTexture Compression in 2020 (https://aras-p.info/blog/2020/12/08/Texture-Compression-in-2020/)\rCompressed GPU Texture Formats (https://themaister.net/blog/2020/08/12/compressed-gpu-texture-formats-a-review-and-compute-shader-decoders-part-1/)\r\rTo create compressed texture files use a 3rd party application such as:\r\rTexture Packer (https://www.codeandweb.com/texturepacker/tutorials/how-to-create-sprite-sheets-for-phaser3?utm_source=ad&utm_medium=banner&utm_campaign=phaser-2018-10-16)\rPVRTexTool (https://developer.imaginationtech.com/pvrtextool/) - available for Windows, macOS and Linux.\rASTC Encoder (https://github.com/ARM-software/astc-encoder)\r\rCompressed textures will appear darker than normal textures. This is because\rthe Web uses sRGB colorspace, but compressed textures are sampled as linear\rcolorspace. You must adjust your textures to be lighter before compression.\rSee https://imagemagick.org/Usage/color_basics/#srgb for more details.\rYou can do this with ImageMagick (https://imagemagick.org/index.php) using\rthe following command:\r\r`magick input.png -set colorspace RGB -colorspace sRGB output.png`\r\rYou must ensure that compressed textures meet the following standards for use\rin WebGL and Phaser:\r\r- PVRTC must have a power-of-two width and height.\r- MIPMaps, if present, must have a power-of-two width and height.\r- S3TC, S3TCSRGB, RGTC, and BPTC must have width and height divisible by 4.\r- ASTC must have a Channel Type of Unsigned Normalized Bytes (UNorm). In fact, all compressed textures should be UNorm, but ASTC presents many other options.\r\rIf in doubt, a power-of-two resolution is always a safe bet.\r\rThe file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,\ror if it's already running, when the next free load slot becomes available. This happens automatically if you\rare calling this from within the Scene's `preload` method, or a related callback. Because the file is queued\rit means you cannot use the file immediately after calling this method, but must wait for the file to complete.\rThe typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the\rScene's `create` method is called you are guaranteed that all of those assets are ready for use and have been\rloaded.\r\rThe key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.\rThe key should be unique both in terms of files being loaded and files already present in the Texture Manager.\rLoading a file using a key that is already taken will result in a warning. If you wish to replace an existing file\rthen remove it from the Texture Manager first, before loading a new one.\r\rIf you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this file's\rkey. For example, if the prefix was `LEVEL1.` and the key was `Data` the final key will be `LEVEL1.Data` and\rthis is what you would use to retrieve the text from the Texture Manager.\r\rThe URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.\r\rUnlike other file loaders in Phaser, the URLs must include the file extension.\r\rNote: The ability to load this type of file will only be available if the Compressed Texture File type has been built into Phaser.\rIt is available in the default build but can be excluded from custom builds.", "kind": "function", "name": "texture", "fires": [ "Phaser.Loader.Events#event:ADD" ], "since": "3.60.0", "params": [ { "type": { "names": [ "string", "Phaser.Types.Loader.FileTypes.CompressedTextureFileConfig", "Array." ], "parsedType": { "type": "TypeUnion", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileConfig" }, { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileConfig", "type": "NameExpression" } ] } ] } }, "description": "The key to use for this file, or a file configuration object, or array of them.", "name": "key" }, { "type": { "names": [ "Phaser.Types.Loader.FileTypes.CompressedTextureFileConfig" ], "parsedType": { "type": "NameExpression", "name": "Phaser.Types.Loader.FileTypes.CompressedTextureFileConfig" } }, "optional": true, "description": "The compressed texture configuration object. Not required if passing a config object as the `key` parameter.", "name": "url" }, { "type": { "names": [ "Phaser.Types.Loader.XHRSettingsObject" ], "parsedType": { "type": "NameExpression", "name": "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": [ "this" ], "parsedType": { "type": "NameExpression", "name": "this", "reservedWord": true } }, "description": "The Loader instance." } ], "memberof": "Phaser.Loader.LoaderPlugin", "longname": "Phaser.Loader.LoaderPlugin#texture", "scope": "instance", "___id": "T000002R024961", "___s": true }, { "comment": "/**\r\n * @classdesc\r\n * A single CSS File suitable for loading by the Loader. When loaded, the CSS is injected into the\r\n * document by creating a `